Represents a role that a user belonging to another organisation can act in. This is a way to group external role accounts and, for example, set which user agreement a user belonging to another organisation should sign when activating their role account.
| Name | Description | Qualification | Schema |
|---|---|---|---|
agreementTemplateId | The ID of the user agreement that is set for this external role. This is the user agreement that a user is required to agree to and sign when activating an external role account. Must not be specified since the platform applies a default user agreement. | Always present for Get external role Must not be set for | string |
| enabled | Indicates if this external role is enabled or not. If an external role is disabled, the external role accounts that belong to that external role cannot be used. | Required | boolean |
| id | The ID of the external role. It must not be specified during creation as it is generated by the server. | Required Read-only | string |
| name | The name of the external role. | Required | string |