Versions Compared

Key

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

Description

Returns the external role matching the ID specified.

HTTP method

URI scheme

GET

/server/external-role/{roleId}

Parameters

Type

Name

Description

Qualification

Schema

Path

roleId

The ID of the external role to get.

Required

string

Responses

HTTP code

Common messages

Description

Schema

200

The external role.

ExternalRole

400

The application with the specified key could not be found

String

Invalid role ID format

String

Role not found!

String

The role ID '<%1>' does not match the company ID '<%2>'.

<%1> is the role ID specified via the URL.
<%2> is the company ID associated with the submitted application key.

String

Security

Type

Name

apiKey

Key