Versions Compared

Key

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

...

Info

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.

The user agreements can be found in the Lequinox console.

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

for

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