GET
/
v1
/
permissions.getRole
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"
}

To use this endpoint, your root key must have the rbac.*.read_role permission.

​
Changelog

DateChanges
Jul 08 2024Introduced endpoint

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
roleId
string
required

The id of the role to fetch

Minimum length: 1
Example:

"role_123"

Response

200
application/json
The Role
​
id
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"

Was this page helpful?

Suggest editsRaise issue
Create A RoleList Roles