GET /api-web/api/idm/roles

Owned by Technische Redaktion
Last updated: Mar 06, 2023
As of Version

product version 2023 Spring

Request MethodGET
Response FormatJSON
Description

This Request retrieves all roles matching the search string. (Technical roles are filtered out)

>> Specify technical roles.

The conditions are specified via the following optional query parameters:

ParameterTypeDescription
searchstringA String contained in role name or description

Response HTTP status codes:

HTTP Status CodeMeaning
200 OKSuccessful.
401 UnauthorizedNot successful.
Request Example

https://<host>/api-web/api/idm/roles?search=test

no request body

Response Example

200 OK

[
  {
    "name": "TEST_ROLE",
    "description": "Example role"
  },
  {
    "name": "EXAMPLE_ROLE",
    "description": "Role containing word test in its description"
  }
]