Versions Compared

Key

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

...

NameDescriptionQualificationSchema
emailAddress

The email address of the user that this internal role account represents.

Required
Read-only
string

firstName

The first name of the user that this internal role account represents.

Required
Read-only

string

 id

The ID of the internal role account.

Required
Read-only
string
lastName

The last name of the user that this internal role account represents.

Required
Read-only
string
managedIndicates if this internal role account should be managed by the platform or not. If

This must be set to true

,

for the internal role account

is activated by the platform on behalf of the user. A managed internal role account is an 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

. On the other hand, an internal role account that is not managed is an internal role account that is operated by the user directly. For example, when the internal role account is to sign a transaction, the user signs the transaction using a PDI client

Info
Internal role accounts are created via the Lequinox console and cannot be created via the platform API.


Required
Read-only
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
Read-only
string
roleId

The ID of the internal role that this internal role account belongs to.

Required
Read-only
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
Read-only

enum (INVITED, ACTIVE, DEACTIVATED)

...