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.

HTTP method

URI scheme

POST

/server/external-role-account

Parameters

Type

Name

Description

Qualification

Schema

Body

request

Request body parameters, see schema for details.

Required

ExternalRoleAccount

Responses

HTTP code

Common messages

Description

Schema

200

The created external role account.

ExternalRoleAccount

400

The application with the specified key could not be found

String

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

String

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

String

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

String

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

String

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

String

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

String

Input 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’.

String

The role account ID '

<%1>

<%1>' is invalid.

<%1> is replaced with the

wrong external

wrong external role account

ID mentioned in 

ID mentioned in ExternalRoleAccount.

String

500

An unexpected error occurred: Type definition error:

 <%1>

 <%1>

This error message can be

returned if

returned if one or more parameters are of the wrong type or if the

entire 

entire ExternalRoleAccount is not sent. See ExternalRoleAccount

 for

 for details.

String

An unexpected error occurred: Required request body is missing.

 <%1>

 <%1>

This error message can be

returned if

returned if one or more parameters are of the wrong type or if the

entire 

entire ExternalRoleAccount is not sent. See ExternalRoleAccount

 for

 for details.

String

Security

Type

Name

apiKey

Key