API Reference
  1. DoiT Cloud Intelligence
  2. Identity and access management
  3. Roles

Update role

patch
https://api.doit.com/iam/v1/roles/

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
length ≥ 1

The new name of the role. Must be nonblank, contain no leading or trailing whitespace, and be unique among the customer's roles, including preset roles. Omission leaves the name unchanged.

string

The new description of the role. An empty string clears it; omission leaves it unchanged.

permissions
array of strings, unique

Permission IDs that replace the role's current permissions, as returned in permissions by GET /iam/v1/roles. Duplicate IDs are rejected. Input order is preserved. An empty array clears all permissions; omission leaves them unchanged.

permissions
Responses

Updated 20 days ago

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

Updated 20 days ago

Did this page help you?