Versions Compared

Key

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

...

NameDescriptionQualificationSchema
emailAddress

The email address of the user that this personal identity represents.

Requiredstring
firstName

The first name of the user that this personal identity represents.

Requiredstring
id

The ID of the external personal identity. It must not be specified during creation as it is generated by the server.

Required
Read-only
string
lastNameThe last name of the user that this personal identity represents.Requiredstring
managed

Indicates if this external personal identity should be managed by the platform or not. If This must be set to true , for the external personal identity is activated by the platform on behalf of the user. A managed external personal identity is an external personal identity to work as intended, and indicates that the identity is activated and operated by the platform. For example, when an application requests the external personal identity to sign a transaction, the platform signs the transaction on behalf of the user. On the other hand, an external personal identity that is not managed is an external personal identity operated by the user directly. For example, when an application requests the external personal identity to sign a transaction, the user signs the transaction using a PDI client.

Info

This cannot be changed after the external personal identity has been created.


Requiredboolean
state

The state of the external personal identity. It must not be specified during creation as it is set by the server. The state of an external personal identity can be changed via the 'Update external personal identity' API. 

INVITED : The external personal identity has been created but not yet activated by the user. It cannot be used until the user has activated it.

ACTIVE : The external personal identity has been activated by the user and can be used.

DEACTIVATED : The external personal identity has been disabled and cannot be used.

Info

The state can only be changed from ACTIVE to DEACTIVATED or from DEACTIVATED to ACTIVE.


Required

enum (INVITED, ACTIVE, DEACTIVATED)

...