Skip to content
Authrim

Update role

PATCH
/api/admin/roles/{id}
Code sample: Shell / cURL 
curl --request PATCH \
  --url https://auth.example.com/api/admin/roles/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "description": "Updated role.", "permissions": [ "users:read", "users:update" ] }'

Updates mutable fields of a custom tenant role. System roles and hierarchy-protected roles cannot be modified by insufficiently privileged admins.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Request Body required

Section titled “Request Body required ”
Media type application/json
object
>= 1 properties
description
string | null
permissions
Array<string>
hierarchy_level
integer
parent_role_id
string | null
inherits_from
string | null
key
additional properties
Example 
{
  "description": "Updated role.",
  "permissions": [
    "users:read",
    "users:update"
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Role update response.

Media type application/json
object
role_id
required
string
name
required
string
description
required
string | null
permissions
required
Array<string>
parent_role_id
required
string | null
hierarchy_level
required
integer
is_system
required
boolean
updated_at
required
string format: date-time
key
additional properties
Example 
{
  "role_id": "role_custom_viewer",
  "name": "custom_viewer",
  "description": "Updated role.",
  "permissions": [
    "users:read",
    "users:update"
  ],
  "parent_role_id": null,
  "hierarchy_level": 0,
  "is_system": false,
  "updated_at": "2026-06-20T00:00:00.000Z"
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Section titled “404 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}