Represents a role that a user belonging to your own organisation can act in. This is a way to group internal role accounts and, for example, set which user agreement a user should sign when activating their role account.
Currently, it is not possible for an application to create internal roles through this API. Instead, an administrator has to log in to the Lequinox console and create a role there.
| Name | Description | Qualification | Schema |
|---|---|---|---|
agreementTemplateId | The ID of the user agreement that is set for this internal role. This is the user agreement that a user is required to agree to and sign when activating an internal role account. | Required Read-only | string |
| enabled | Indicates if this internal role is enabled or not. If an internal role is disabled, the internal role accounts that belong to that internal role cannot be used. | Required Read-only | boolean |
| id | The ID of the internal role. It must not be specified during creation as it is generated by the server. | Required Read-only | string |
| name | The name of the internal role. | Required Read-only | string |