PrincipalRole

PrincipalRole
PrincipalRole

A representation of a user or group.

JSON Example
{
    "id": "c493a95e-c4d1-4496-8595-e73902701c95:fe69d7ca-40a6-4de5-8f33-d462f4656938",
    "email": "[email protected]",
    "type": "user",
    "role": "member"
}
string
id
Optional

ID of the user or id of the group in CSP

string
email
Required

The username of the user or display name of the group. When assigning a group, the email is expected to have the format displayName@domain. In the case where the display name in Identity provider is in the format:

  • name@domain - email should be written as name@domain@domain
  • name (and group has domain) - email should be written as name@domain
  • name (and group doesn't have domain) - email should be written as name@

    to ensure proper functioning.

    • string
    type
    Optional

    Type of the principal. Currently supported 'user' (default) and 'group'.

    string
    role
    Optional

    Role of this member. Currently supported 'member', 'viewer', 'administrator', 'supervisor'.

    Property Of