Roles

Roles: Retrieving Defined User Roles

The 'Roles' section of the Babel Licensing Service API is specifically designed to handle the retrieval of defined user roles within the system.

Get

This endpoint allows authorized users to fetch a comprehensive list of all the user roles defined in the system. The retrieved information typically includes the system defined role names.

Retrieves the list of defined roles.

get

Authorizations

Query parameters

selectstringoptional

filterstringoptional

sortstringoptional

takeinteger · int32optional

skipinteger · int32optional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/roles' \
  --header 'x-api-key: YOUR_API_KEY'

200

default

200

{
  "success": true,
  "code": 1,
  "message": "text",
  "roles": [
    {
      "id": "text",
      "name": "text",
      "description": "text"
    }
  ],
  "totalRolesCount": 1
}

Success

Examples

Shell

curl -X 'GET' \
  'https://localhost:5455/v1/roles' \
  -H 'accept: application/json' \
  -H 'x-api-key: 00'

Response

{
  "success": true,
  "roles": [
    {
      "id": "1734e428-eaa4-47e2-b66e-281443fe3e1d",
      "name": "Administrator"
    },
    {
      "id": "825d86a9-f620-417c-93a9-edf4fdbdeebe",
      "name": "Customer"
    },
    {
      "id": "8659d2c3-13b1-46e7-9600-9cb3abf38843",
      "name": "LicenseManager"
    },
    {
      "id": "efc6b584-2c4a-4c2b-8f3a-51e5cf0e54cf",
      "name": "Sales"
    }
  ],
  "totalRolesCount": 4
}