Versions Compared

Key

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

Description

...

TypeNameDescriptionQualificationSchema
Body

request

Request body parameters, see schema for details.

Required

ExternalPersonalIdentity

Responses

Message
HTTP CodeDescriptionSchema
200

The created external personal identity.

ExternalPersonalIdentity

400

Common response messages:

"The application with the specified key could not be found"

400

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

400

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

400

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

400

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

400

"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’.)

400

"Unknown error"

(This error message

is

can be returned

when

if

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

string

500

Common response messages:

An unexpected error occurred: Type definition error [...]

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


An unexpected error occurred: JSON parse error [...]

These error messages are

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

string

Security

TypeName
apiKeyKey

...