Update a Role

Changes a role’s label and description. Anything you omit is left alone.

The role’s name — the identifier in {id} — CANNOT be changed here or anywhere else; it is what grants point at. The permissions inside the role are not edited here either: use POST /v1/roles/{id}/permissions and its remove counterpart. So this endpoint cannot widen or narrow anybody’s access, which is why it is the least dangerous call in the family.

Failures:

• 400 — a supplied member is malformed.
• 404 — no such role in your organization.
• 422 IDE-1062 — the change would set, alter or remove a description starting with ri-declared:, which belongs to the service that declared the role. Resending the current description unchanged is accepted.
• 503 IDE-0066 — the identity provider is unavailable (unreachable, too slow to answer, or failing). Nothing about the request was wrong; retry it later.

PATCH /v1/roles/{id}

Update a Role

cURL

curl --request PATCH \
  --url https://identity.sandbox.lerian.net/v1/roles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "An updated description",
  "displayName": "Updated Editor",
  "isEnabled": true
}
'

200

{
  "createdAt": "2026-06-24T10:00:00Z",
  "description": "A custom editor role",
  "groups": [
    "<string>"
  ],
  "id": "custom-editor",
  "isEnabled": true,
  "isSystem": false,
  "name": "Custom Editor",
  "roles": [
    "<string>"
  ],
  "users": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

JWT bearer token issued by the identity provider.

Path Parameters

id · string · required

Role ID.

Example:

"midaz-editor"

Body

application/json

The role members to update.

description · string

Example:

"An updated description"

displayName · string

Example:

"Updated Editor"

isEnabled · boolean

Example:

true

Response

200

application/json

OK

createdAt · string

Example:

"2026-06-24T10:00:00Z"

description · string

Example:

"A custom editor role"

groups · string[]

id · string

Example:

"custom-editor"

isEnabled · boolean

Example:

true

isSystem · boolean

Example:

false

name · string

Example:

"Custom Editor"

roles · string[]

users · string[]