Versions Compared

Key

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

...

Makes changes to an existing external role.

HTTP method

URI scheme

PUT

/server/external-role/{roleId}

Parameters

Type

Name

Description

Qualification

Schema

Path

roleId

The ID of the external role to update.

Required

string

Body

request

Request body parameters, see schema for details.

Required

ExternalRole

Responses

HTTP code

Common messages

Description

Schema

200

The updated external role.

ExternalRole

400

The application with the specified key could not be found

String

400

External role ID must match the external role ID in the REST path.

String

400

Role not found!

String

400

Invalid role ID format

String

400

Name and enabled must always be specified for an external role.

String

400

User agreement not found!

String

500

An unexpected error occurred: JSON parse error

[...]These error messages are

<%1>

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

 for

 for details.

String

Security

Type

Name

apiKey

Key