Skip to main content
PUT
Update an existing role

Authorizations

X-BRONTO-API-KEY
string
header
required

Path Parameters

role_id
string
required

Body

application/json
id
string

The ID of the role

role_type
string

The entity which the roles can be applied to. USER | API

display_name
string

The display name of the role

description
string

Description of the role

permissions
string[]

Updated list of permissions.

Example:

Response

Role updated 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[]