Skip to main content
GET
/
v3
/
roles
/
{role_id}
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/roles/{role_id} \
  --header 'X-Session-Token: <api-key>'
{
  "data": {
    "id": "<string>",
    "type": "<string>",
    "attributes": {
      "domain": "<string>",
      "role": "<string>",
      "name": "<string>",
      "description": "<string>",
      "available_scopes": {
        "attributes": [
          {
            "name": "<string>",
            "type": "uuid",
            "operations": [
              "="
            ],
            "resource_type": [
              "folders",
              "users"
            ]
          }
        ],
        "patterns": [
          {
            "type": "contains",
            "field": "<string>",
            "operations": [
              "="
            ]
          }
        ]
      }
    },
    "relationships": {
      "permissions": {
        "data": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "type": "<string>"
          }
        ]
      }
    }
  },
  "jsonapi": {
    "version": "<string>"
  }
}

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

role_id
string
required

A unique identifier for a Role.

Response

An individual role.

JSON API response object

data
object
required

A role

jsonapi
object
required