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/v1/roles

Query parameters

Response

200default

Success

Body

application/json

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

rolesarray of Role (object)

roles is the list of roles.

totalRolesCountinteger (int32)

total_roles_count is the total number of roles.

Request

JavaScriptCurl

const response = await fetch('/v1/roles', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "roles": [
    {
      "id": "text",
      "name": "text",
      "description": "text"
    }
  ]
}

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
}