PrincipalResponse

Fields

Field	Type	Required	Description and constraints
kind	PrincipalKind	Yes
id	string	Yes
displayName	string	Yes
role	Role or null	Yes
capabilities	array of Capability	Yes
sessionId	string (uuid) or null	Yes
recentAuthAt	string (date-time) or null	Yes
mustChangePassword	boolean	Yes
mfaEnrollmentRequired	boolean	Yes
organizationId	string (uuid) or null	Yes
organizationAuthorizationRevision	integer or null	Yes
authorizationRevision	integer or null	Yes
actorRole	Role or null	Yes
workspaceRevision	integer	Yes	minimum 0.0
workspaceAvailable	boolean	Yes

Additional properties are rejected by this schema.

JSON schema

{
  "properties": {
    "kind": {
      "$ref": "#/components/schemas/PrincipalKind"
    },
    "id": {
      "type": "string",
      "title": "Id"
    },
    "displayName": {
      "type": "string",
      "title": "Displayname"
    },
    "role": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/Role"
        },
        {
          "type": "null"
        }
      ]
    },
    "capabilities": {
      "items": {
        "$ref": "#/components/schemas/Capability"
      },
      "type": "array",
      "title": "Capabilities"
    },
    "sessionId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ],
      "title": "Sessionid"
    },
    "recentAuthAt": {
      "anyOf": [
        {
          "type": "string",
          "format": "date-time"
        },
        {
          "type": "null"
        }
      ],
      "title": "Recentauthat"
    },
    "mustChangePassword": {
      "type": "boolean",
      "title": "Mustchangepassword"
    },
    "mfaEnrollmentRequired": {
      "type": "boolean",
      "title": "Mfaenrollmentrequired"
    },
    "organizationId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid"
        },
        {
          "type": "null"
        }
      ],
      "title": "Organizationid"
    },
    "organizationAuthorizationRevision": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Organizationauthorizationrevision"
    },
    "authorizationRevision": {
      "anyOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "title": "Authorizationrevision"
    },
    "actorRole": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/Role"
        },
        {
          "type": "null"
        }
      ]
    },
    "workspaceRevision": {
      "type": "integer",
      "minimum": 0.0,
      "title": "Workspacerevision"
    },
    "workspaceAvailable": {
      "type": "boolean",
      "title": "Workspaceavailable"
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "kind",
    "id",
    "displayName",
    "role",
    "capabilities",
    "sessionId",
    "recentAuthAt",
    "mustChangePassword",
    "mfaEnrollmentRequired",
    "organizationId",
    "organizationAuthorizationRevision",
    "authorizationRevision",
    "actorRole",
    "workspaceRevision",
    "workspaceAvailable"
  ],
  "title": "PrincipalResponse"
}

Related models

• Capability
• PrincipalKind
• Role