Skip to content

List admin role assignments.

GET
/api/admin/admin-roles/{id}/assignments
Code sample: Shell / cURL
curl --request GET \
--url 'https://auth.example.com/api/admin/admin-roles/example/assignments?include_expired=false' \
--header 'Authorization: Bearer <token>'

Lists assignments for a role, including scope bindings and optionally expired assignments.

id
required
string

Admin role id.

include_expired
boolean

Include expired role assignments.

Admin role assignment list response.

Media type application/json
object
items
required
Array<object>
object
id
required
string
tenant_id
required
string
admin_user_id
required
string
admin_role_id
required
string
scope_type
required
string
Allowed values: global tenant org
scope_id
required
string | null
expires_at
integer | null format: int64
assigned_by
string | null
created_at
required
integer format: int64
key
additional properties
total
required
integer
key
additional properties
Example
{
"items": [
{
"scope_type": "global"
}
]
}

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

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

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

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