Update an admin role.

PATCH

/api/admin/admin-roles/{id}

Code sample: Shell / cURL

curl --request PATCH \
  --url https://auth.example.com/api/admin/admin-roles/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "display_name": "Security Reviewer", "permissions": [ "admin:admin_roles:read", "admin:admin_audit:read" ] }'

Updates mutable fields on a custom tenant Admin role. System roles and roles outside the tenant are rejected; callers can only grant permissions and hierarchy levels allowed by their own role.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Admin role id.

Request Body ^required

Media type application/json

object

>= 1 properties

display_name

string

description

string

permissions

Array<string>

hierarchy_level

integer

inherits_from

string | null

key

additional properties

Example

{
  "display_name": "Security Reviewer",
  "permissions": [
    "admin:admin_roles:read",
    "admin:admin_audit:read"
  ]
}

Responses

200

Admin role response.

Media type application/json

object

id

required

string

tenant_id

required

string

name

required

string

display_name

string | null

description

string | null

permissions

required

Array<string>

hierarchy_level

required

integer

is_system

required

boolean

role_type

required

string

Allowed values: system builtin custom

inherits_from

string | null

created_at

required

integer format: int64

updated_at

required

integer format: int64

key

additional properties

Example

{
  "role_type": "system"
}

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

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

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

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"
}