Versions Compared

Key

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

Description

Creates an external role account for a user belonging to another organisation.

...

TypeNameDescriptionQualificationSchema
Body

request

Request body parameters, see schema for details.

Required

ExternalRoleAccount

Responses

HTTP CodeMessageDescriptionSchema
200

The created external role account.

ExternalRoleAccount

400The application with the specified key could not be found

400The mail server is unable to recognize the email address. Enter an existing email address before proceeding.

400Input not valid: External role ID and managed must be specified when creating an external role account.

400Input not valid: Personal identity ID can't be specified when creating an external role account.

400Input not valid: ID can't be specified when creating an external role account.

400Input not valid: State can't be specified when creating an external role account.

400Input not valid: First name, last name and email address must always be specified for an external role account.

400Input not valid: Your platform does not have support for creating user-managed external role accounts.This message is returned if the role account  attribute ‘managed’ is set to ‘false’.
400The role account ID '%' is invalid.% is replaced with the wrong external role account ID mentioned in ExternalRoleAccount.
500
  • An unexpected error occurred: Type definition error: [ ... ]
  • An unexpected error occurred: Required request body is missing. [ .... ]
These error messages are returned if one or more parameters are of the wrong type or if the entire ExternalRoleAccount is not sent. See ExternalRoleAccount for details.

Security

TypeName
apiKeyKey

...