Principal

Principal
Principal

A representation of a user or group.

JSON Example
[
    {
        "email": "[email protected]",
        "type": "user"
    }
]
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'.

    Property Of