Versions Compared

Key

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

Description

Creates an external personal identity for a user. If a user has no proper personal identity, you can create an external personal identity to have it represent a personal identity within the company, even if this user is currently not closely associated with the company.

HTTP method

URI scheme

POST

/server/external-personal-identity

Parameters

Type

Name

Description

Qualification

Schema

Body

request

Request body parameters, see schema for details.

Required

ExternalPersonalIdentity

Responses

HTTP code

Common messages

Description

Schema

200

The created external personal identity.

ExternalPersonalIdentity

400

The application with the specified key could not be found

string

String

Input not valid: ID can't be specified when creating an external personal identity.

string

String

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

string

String

Input not valid: Managed must be specified when creating an external personal identity.

string

String

Input not valid: State can't be specified when creating an external personal identity.

string

String

Input not valid: Your platform does not have support for creating user-managed external personal identities.

(This message is returned if the external personal identity attribute ‘managed’ is set to ‘false’.)

string

String

Unknown error

This error message can be returned if

  • firstName > 50 characters

  • lastName > 50 characters

  • emailAddress > 100 characters.

string

String

500

An unexpected error occurred: Type definition

error [...]

error <%1>

This error message can be returned if one or more parameters are of the wrong type. See ExternalPersonalIdentity for details.

string

String

An unexpected error occurred: JSON parse

error [...]

error <%1>

This error message can be returned if one or more parameters are of the wrong type. See ExternalPersonalIdentity for details.

string

String

Security

Type

Name

apiKey

Key