Versions Compared

Key

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

...

Makes changes to an existing external role account.

HTTP

Method

method

URI

Scheme

scheme

PUT

/server/external-role-account/{roleAccountId}

Parameters

Type

Name

Description

Qualification

Schema

Path

roleAccountId

The ID of the external role account to update.

Required

string

Body

request

Request body parameters, see schema for details.

Required

ExternalRoleAccount

Responses

HTTP

Code

code

Common messages

Description

Schema

200

The updated external role account.

ExternalRoleAccount

400

The application with the specified key could not be found

String

Invalid role ID format

This error message is returned when

  • a global ID on the path section of the URL is not in the correct format. 

  • the "id" field in the ExternalRoleAccount object is missing or not in the correct format.

Note: It is not necessarily related to a role and its ID.

String

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

String

Input not valid: External role account ID must match the external role account ID in the REST path.

String

Input not valid: State must be specified when updating an external role account.

String

Input not valid: Changing state of an external role account from <%1> to <%2> is not allowed.

<%1> and <%2> represent one of the state field value as specified in ExternalRoleAccount.

String

500

An unexpected error occurred: <%1>

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

See ExternalRoleAccount for details.

String

Security

Type

Name

apiKey

Key