Update role

Updates the name, description and/or permissions of a custom role. Only the fields present in the body change; permissions replaces the full list when present. Preset roles cannot be modified. A service account of a parent tenant can update a descendant tenant's role by setting X-Tenant-Id to that tenant's customer ID.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique ID of the role to update.

Body Params

Fields allowed when updating a custom role. At least one field is required.

string

The new name of the role. Must be unique among the customer's roles, including preset roles.

string

The new description of the role.

permissions
array of strings

Permission IDs that replace the role's current permissions, as returned in permissions by GET /iam/v1/roles. Duplicates are ignored.

permissions
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json