Skip to main content
GET
/
v3
/
iam
/
roles
/
{roleId}
cURL
curl --request GET \
  --url https://api.ctrl-hub.com/v3/iam/roles/{roleId}
{
  "data": {
    "type": "roles",
    "id": "scheme.owner",
    "attributes": {
      "name": "Scheme Owner",
      "description": "Ability to manage all aspects of schemes",
      "custom": false,
      "launch_stage": "beta",
      "permissions": [
        "schemes.create",
        "schemes.read",
        "schemes.update",
        "schemes.delete"
      ]
    }
  }
}
Because this endpoint only returns system roles (i.e. uneditable ones that Ctrl Hub offer), this endpoint is unauthenticated.This allows other systems that are not authorized to check role information.

Query Parameters

​
limit
integer
default:10

Limit the number of resources returned by the API

​
offset
integer
default:0

Offset for resources returned by the API

​
sort
string
default:created_at

A field in the resource to sort results with. Not all attributes are supported, please see the Object Model for sortable fields.

Response

​
data
object