Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

NameDescriptionQualificationSchema

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 for Create external role since the platform applies a default user agreement. Must be specified and not changed for Update external role.

Always present for Get external role and Get external roles.

Optional*

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.

Requiredboolean
 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
nameThe name of the external role.Requiredstring

...