Roles

GET/v1/roles

Authorization

bearer

Query parameters

Response

200

Body

application/json

paging*PagingInfo (object)

dataarray of RoleDto (object)

Request

JavaScriptCurlPython

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

Response

200

{
  "paging": {
    "next": {
      "after": "text"
    }
  },
  "data": [
    {
      "id": "text",
      "name": "text",
      "is_system": false
    }
  ]
}

GET/v1/roles/{roleId}

Authorization

bearer

Path parameters

roleId*string

Response

200

Body

application/json

id*string

Unique ID

name*string

Name of Role

is_system*boolean

If true, this a Role defined and managed by the system.

Request

JavaScriptCurlPython

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

Response

200

{
  "id": "text",
  "name": "text",
  "is_system": false
}