Skip to main content
GET
Retrieve a specific role

Authorizations

X-BRONTO-API-KEY
string
header
required

Path Parameters

role_id
string
required

The unique identifier of the role to retrieve

Response

Role details retrieved successfully

role_id
string

The ID of the role

role_type
enum<string>

The entity which the roles can be applied to

Available options:
USER,
API
display_name
string

The display name of the role

description
string

Description of the role

is_system_role
boolean

Whether this is a built-in system role or a custom user-created role

metadata
object

Common metadata attached to all persisted resources.

permissions
object[]