Get role

GET

permissions.getRole

Get role

curl --request GET \
  --url https://api.unkey.dev/v1/permissions.getRole \
  --header 'Authorization: Bearer <token>'

{
  "id": "role_1234",
  "name": "domain.record.manager",
  "description": "Can manage dns records"
}

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

roleId

string

required

The id of the role to fetch

Minimum length: 1

Example:

"role_123"

The Role

string

required

The id of the role

Example:

"role_1234"

name

string

required

The name of the role.

Example:

"domain.record.manager"

description

string

The description of what this role does. This is just for your team, your users will not see this.

Example:

"Can manage dns records"

⌘I

Get role

curl --request GET \
  --url https://api.unkey.dev/v1/permissions.getRole \
  --header 'Authorization: Bearer <token>'

{
  "id": "role_1234",
  "name": "domain.record.manager",
  "description": "Can manage dns records"
}