Versions Compared

Old Version 1

changes.mady.by.user Technical writer

Saved on

compared with

New Version Current

changes.mady.by.user Technical writer

Saved on

Key

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

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:

Table of Contents
maxLevel2
minLevel2

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

Info

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.

Plantumlcloud
toolbarbottom
filenamePlantUML Diagram 1.svg
originalHeight345
datanZTdTsMwDIWfpuJqKM0Acdt1RVwMVAH3KDTuiJY6JUnHz9PjNAW2AGJirabqxP58bHfLTpjzwvqh0xkrju6g67XwkM2LjLPTe37Pgrz8lOiaz/J8xoPuNgp7YUVHBxJaMWh/YdBfiw5IuQS9Ba8akUTewtMA2MAVOCfWUGi1RpIbQA82ib0xA8rSWKQTzvLT5Lgm56pRvUC/MFaCLY02IfJBi2aT1n0U0jwrXNNzK7SDbzAp42la5sIYshZa++BnfM7Gz6+Rt+otDCHnFJEEuWkAxyvVwkohLMjs2sZWP/lwHq4/U/fa3rVF96OSwUNLph7MS9T6r5GNCbzoe01L8srQFjhpwtHXqioir2TL8yX/KXFFXhQSl7PwzrTGdruAeso/W1ZVeXA+edxl5P+DLPYgPIF8TWZArXADMoqi8Wob3vTYPiviEGbZvJqk8SdQWohB1QvtGoUOtcE6Ex+JjF7518jcR9QJAf4i7FqqJ2L9HViDDZ2HdrdCKzlu0/0SHKu7Q8r/lF5Mlg4C0G3BDxYPHJeEtON9ZVxLdsIAJf1jvQM=
compressedtrue
originalWidth505
revision3

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.

Info

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.

Plantumlcloud
toolbarbottom
filenamePlantUML Diagram 2.svg
originalHeight245
datanVTLTsMwEPyaiFOR4wLqNX0gDgVFPM6VG29aq8462E4pfD3ruPSRUlERR1E0np2d3XWS3DDnhfVNpROWXb1CVWvhIelnCWe3Mz5jAR7vIFr9Xpr2eMDdSmEtrKhoQ0IpGu3vDfonUQEhD6DX4FUhOswXeG8AC3gE58QCMq0WSHAB6MF2uM+mQTkyFmmHs/S2s52Tc1WoWqAfGivBjow2gTnXolh18y6FNB8KF/ReCu3gREzKuNtNc28MWQul/egnvM/a6yzzRX2FJqScGB2S2zbgeqpKmCqEIZld2FjqTh8GYf0ZelT2oS26l0oGDyWZmptNxOp9y9oAntW1piF5ZWgKnDDh6DGdZFFvxMaDMf8tcEpeFJIuZ+HMlMZWhwL5Nv5uPJmMLo4nj4ca6f9EhkcivCOy70yDWuEKZARF4dU6nPRYPstiE3pJfxILar+At1pGDmxo1Ch0SA3WmfhKwuiV/zyVzINifiqYgw22g9e10Eq2o3BnyDG7O0lkwTcWdwR5oT8JXYfHSNuG5IYBSvpDfAM=
compressedtrue
originalWidth435
revision3

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.

Plantumlcloud
toolbarbottom
filenamePlantUML Diagram 3.svg
originalHeight245
datanVRNT8MwDP01FaeiNB2Ia9d1cBioAu4oNO6wliYlScfHr8dZBmwdaIimqqJn+/nZTppMmPPC+qFTCStO7qHrlfCQ5EXC2dkDf2ABnn1BtPI0y1IecLdC3QsrOjJIaMWg/NxofyM6IOQK1Bo8NmLkeQfPA+gGrsE5sYRC4VIT3ID2YEe+t2bQsjRWk4Wz7Gxkrkk5NtgL7afGSrClUSZ4PirRrMZ5n4Q0L6iXtG+FcnBAJmW0jtPMjSFpobRP/oTnbPP86nmH76EJGSePkZPbNuB0gS0sUMOUxC5tLPWLHy7COhq6V/auLHqfUAYNLYl6NK8R679btgngRd8rGpJHQ1PghAlHn0VVRL6SzS5m/KfABWlBTbychTPTGtvtEtTb+PNZVZV/jieNuxzZ/0imeyR8RPLdmUEr1CuQERSNx3U46bF8VsQmpElexYI2N+ASQmp4pTlroUJesM7ELbFqj/5tRFYHrvqQqgYbBAeVa6FQbobgfnG+BW8R1uD+kn07vrxM0x2K6liYhIMe7EOhkmTCQEv6YXwA
compressedtrue
originalWidth488
revision3