...
| Info |
|---|
Currently, it is not possible for an application to create internal role accounts through this API. Instead, an administrator has to log in to the Lequinox console and create a role account there. |
Name | Description | Qualification | Schema | ||
|---|---|---|---|---|---|
emailAddress | The email address of the user that this internal role account represents. | Required | string | ||
firstName | The first name of the user that this internal role account represents. | Required | string | ||
id | The ID of the internal role account. | Required | string | ||
lastName | The last name of the user that this internal role account represents. | Required | string | ||
managed | This must be set to true for the internal role account to work as intended, and indicates that the account is activated and operated by the platform. For example, when an application requests the internal role account to sign a transaction, the platform signs the transaction on behalf of the user
| Required | boolean | ||
personalIdentityId |
The ID of the personal identity that this internal role account is linked to. This is set by the server during the role account activation. If the user has a proper personal identity, it is set to |
the ID of that personal identity. Otherwise, an external personal identity is created for the user, and |
the ID is set to that. | Optional | string |
roleId |
The ID of the internal role that this internal role account belongs to. | Required | string | |
state | The state of the internal role account. INVITED: The internal role account has been created but not yet activated by the user. It cannot be used until the user has activated it. ACTIVE: The internal role account has been activated by the user and can be used. DEACTIVATED: The internal role account has been disabled and cannot be used. | Required | enum (INVITED, ACTIVE, DEACTIVATED) |