Represents an account that a user belonging to another organisation can use to act in a corporate role. Create this for your user if your association with them is professional (that is, the user acts for an organisation and not as a private person/in their personal identity), and if the user does not act on behalf of your own, but another organisation.
The Lequinox platform does not archive transactions for external role accounts as they represent another organisation.
| Name | Description | Qualification | Schema |
|---|---|---|---|
| emailAddress | The email address of the user that this external role account represents. | Required | string |
firstName | The first name of the user that this external role account represents. | Required | string |
| id | The ID of the external role account. It must not be specified during creation as it is generated by the server. | Required Read-only | string |
| lastName | The last name of the user that this external role account represents. | Required | string |
| managed | Indicates if this external role account should be managed by the platform or not. If set to true, then this external role account is activated by the platform on behalf of the user. A managed external role account is an external role account operated by the platform. For example, when an application requests the external role account to sign a transaction, the platform signs the transaction on behalf of the user. On the other hand, an external role account that is not managed is an external role account operated by the user directly. For example, when the external role account is to sign a transaction, the user signs the transaction using a PDI client. This cannot be changed after the external role account has been created. | Required Read-only | boolean |
personalIdentityId | The ID of the personal identity that this external role account is linked to. This is set by the server during the role account activation. If the user has a proper personal identity, this ID 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 Read-only | string |
| roleId | The ID of the external role that this external role account belongs to. This cannot be changed after the external role account has been created. | Required Read-only | string |
| state | The state of the external role account. It must not be specified during creation as it is set by the server. The state of the external role account can be changed via the 'Update external role account' API. INVITED: The external role account has been created but not yet activated by the user. It cannot be used until the user has activated it. ACTIVE: The external role account has been activated by the user and can be used. DEACTIVATED: The external role account has been disabled and cannot be used. The state can only be changed from ACTIVE to DEACTIVATED or from DEACTIVATED to ACTIVE. | Required | enum (INVITED, ACTIVE, DEACTIVATED) |