Get a role

GET

/api/v1/roles/{id}

Returns a single role by id, scoped to the active Application and current Environment. Returns 404 when no role with that id exists in the Environment. Requires the rbac.view_roles permission.

Authentication

Bearer TokenAuthorization Option A

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Path Parameters

idstring Required

Responses

application/json

dataRoleResponseDto*

application/json

errorApiErrorBodyDto*

application/json

errorApiErrorBodyDto*

application/json

errorApiErrorBodyDto*

Returned object

RoleResponseDtoView all properties on this resource

Request

curl -X GET "https://auth.canopy-io.com/api/v1/roles/value" \
  -H "X-API-Key: $CANOPY_API_KEY"

Response

{
  "data": {
    "id": "string",
    "application_id": "string",
    "name": "string",
    "description": "string",
    "is_system_role": false,
    "system_key": "string",
    "is_active": false,
    "created_at": "2026-04-20T12:00:00.000Z",
    "updated_at": "2026-04-20T12:00:00.000Z",
    "version": 0,
    "permission_count": 0,
    "member_count": 0
  }
}

GETList roles
POSTCreate a custom role
PATCHUpdate a role
DELETEDelete a role
GETGet permissions for a role
PUTReplace permissions on a role

Was this page helpful?

Tell us how we can improve this guide.