Versions Compared

Key

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

...

HTTP codeCommon messagesDescriptionSchema
200

The updated external personal identity.

ExternalPersonalIdentity

400The application with the specified key could not be found
stringString
Invalid 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.

stringString
Input not valid: External personal identity ID must match the external personal identity ID in the REST path.
stringString
Input not valid: First name and last name must always be specified for an external personal identity.
stringString
Input not valid: State must be specified when updating an external personal identity.
stringString
Company ID is not part of identity ID.
stringString

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.stringString

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

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

This error message is returned when

  • firstName > 50 characters
  • lastName > 50 characters
  • emailAddress > 100 characters.
stringString
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.stringString

Security

TypeName
apiKeyKey

...