List admin roles.

GET

/api/admin/admin-roles

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/admin-roles \
  --header 'Authorization: Bearer <token>'

List tenant Admin roles and, unless excluded, merged system roles available to the tenant.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Header Parameters

X-Tenant-Id

string

Tenant selector for multi-tenant admin requests.

Responses

200

Admin role list response.

Media type application/json

object

items

required

Array<object>

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

total

required

integer

key

additional properties

Example

{
  "items": [
    {
      "role_type": "system"
    }
  ]
}