Skip to main content
PUT
Error

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme.

Path Parameters

roleId
integer<int32>
required

Role ID

Query Parameters

responseFields
string

limits which fields are returned in the response body

Body

application/json

Role payload containing name, behaviors, and accountIds

accountIds
integer<int32>[] | null

List of Account IDs associated with this role. Required for CreateRole and UpdateRole operations.

auditInfo
object
behaviors
integer<int32>[] | null

List of Role Behaviors

id
integer<int32>

Unique Identifier for the Role

isSystemRole
boolean

Indicate if the Role is a System Role or Custom Role

name
string | null

Name for the Role

Response

OK

accountIds
integer<int32>[] | null

List of Account IDs associated with this role. Required for CreateRole and UpdateRole operations.

auditInfo
object
behaviors
integer<int32>[] | null

List of Role Behaviors

id
integer<int32>

Unique Identifier for the Role

isSystemRole
boolean

Indicate if the Role is a System Role or Custom Role

name
string | null

Name for the Role