GET
/
v1
/
permissions.getRole

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

​
Changelog

DateChanges
Jul 08 2024Introduced endpoint

Authorizations

Authorization
string
headerrequired

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

Response

200 - application/json
id
string
required

The id of the role

name
string
required

The name of the role.

description
string

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

Was this page helpful?

Create A RoleList Roles