Manage external personal accounts

Owned by Technical writer
Last updated: 2023-12-06
1 min read

External personal accounts are currently labelled external personal identities in the REST API. Hence this is the term reflected in the requests below.

‘External personal account’ is the term used in the Lequinox console user interface and the user guide.

Functions available for external personal accounts:

Create external personal account

Steps

  1. Create External personal identity.

  2. Submit a request to Create external personal identity.

  3. The platform validates the request and the ExternalPersonalIdentity object by verifying, among other things:

    1. that first name and last name are specified 

    2. that ‘managed’ is specified

Take special care to set up the personal identity as platform-managed. See description of ‘managed’ in ExternalPersonalIdentity.

c. that ID is not specified

d. that State is not specified.

  1. The platform creates the external personal identity.

  2. The platform activates the external personal identity.

  3. The platform returns the created ExternalPersonalIdentity.

 

Update external personal account

Steps

  1. Send a request to Update external personal identity.

  2. The platform validates the request and the ExternalPersonalIdentity object by verifying, among other things:

    1. that first name and last name are specified.

    2. that State is specified.

    3. that the external personal identity ID in the URL is the same as in ExternalPersonalIdentity.

    4. that the changes to the external personal identity are permitted.

    5. that the external personal identity state can be changed.

Refer to the state attribute description in ExternalPersonalIdentity for information on permitted state changes.

  1. The platform updates the external personal identity.

  2. The platform returns the updated ExternalPersonalIdentity.

 

Get external personal account

Steps

  1. Send a request to Get external personal identity.

  2. The platform validates the request.

  3. The platform retrieves the external personal identity.

  4. The platform returns the ExternalPersonalIdentity.

 

Copyright © 2021–2024 Lequa Net AB – a subsidiary of Extracticon AB (publ). All rights reserved.