Skip to content
Hexel StudioDocs

Update role

PATCH/roles/{role_id}

Update a role's fields. Changing or clearing boundary_id needs the caller to hold every action that becomes effective for the role's sessions (403 with missing_actions); a role session cannot change its own role's boundary.

Path parameters

role_idstring

Role ID

Headers

Authorizationstring

Bearer <token>.

Body parameters

Fields to update; trust policy, scope and type are not updatable here

boundary_idoptional string
descriptionoptional string
display_nameoptional string
is_enabledoptional boolean
max_session_durationoptional integer

Returns

200OKRole

boundary_idoptional string
created_atoptional string
created_by_user_idoptional string
descriptionoptional string
environment_idoptional string
idoptional string
is_enabledoptional boolean
is_systemoptional boolean
max_session_durationoptional integer
namestring
organization_idoptional string
role_typeoptional string

Assumable-role fields (migration 027).

scopestring

One of: "organization", "workspace", "environment", "platform"

trust_policyoptional object
updated_atoptional string
workspace_idoptional string

Errors

  • 400Bad Request
  • 403Forbidden
  • 500Internal Server Error