Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Description

Makes changes to an existing external personal identity.

HTTP MethodURI Scheme
PUT/server/external-personal-identity/{personalIdentityId}

Parameters

TypeNameDescriptionQualificationSchema
Path

personalIdentityId

The ID of the external personal identity to update.

Required

string

Bodyrequest

Request body parameters, see schema for details.

RequiredExternalPersonalIdentity

Responses

HTTP CodeMessageDescriptionSchema
200

The updated external personal identity.

ExternalPersonalIdentity

400The application with the specified key could not be found

400Invalid role ID format

This error message is be returned when

  • a global ID on the path section of the URL is not in the correct format.
  • the "id" field in the ExternalPersonalIdentity object is missing or not in the correct format.

Note: It is not necessarily related to a role and its ID.


400Input not valid: External personal identity ID must match the external personal identity ID in the REST path.

400Input not valid: First name and last name must always be specified for an external personal identity.

400Input not valid: State must be specified when updating an external personal identity.

400Company ID is not part of identity ID.

400

Input not valid: Changing state of an external personal identity from 'INVITED' to '%' is not allowed.

Note: % can be replaced by either ACTIVE or DEACTIVATED.
400

Input not valid: Changing state of an external personal identity from '%' to 'INVITED' is not allowed.

% can be replaced by either ACTIVE or DEACTIVATED.
400Unknown error

This error message is returned when

  • firstName > 50 characters
  • lastName > 50 characters
  • emailAddress > 100 characters.

500
  • An unexpected error occurred: Type definition error[...]
  • An unexpected error occurred: JSON parse error[...]
These error messages are returned if one or more parameters are of the wrong type. See ExternalPersonalIdentity for details.

Security

TypeName
apiKeyKey
  • No labels