Skip to content

List admin attributes

GET
/api/admin/admin-attributes
Code sample: Shell / cURL
curl --request GET \
--url https://auth.example.com/api/admin/admin-attributes \
--header 'Authorization: Bearer <token>'

Lists tenant admin ABAC attribute definitions, optionally including system attributes, with limit/offset metadata.

include_system
boolean

Include system attribute definitions.

limit
integer
>= 1

Maximum number of records to return.

offset
integer

Zero-based offset.

Successful JSON response.

Media type application/json
object
items
required
Array<object>
object
id
string
tenant_id
string
name
string
display_name
string
description
string
attribute_type
string
Allowed values: string enum number boolean date array
allowed_values
Array<string>
min_value
number
max_value
number
regex_pattern
string
is_required
boolean
is_multi_valued
boolean
is_system
boolean
created_at
integer
updated_at
integer
key
additional properties
total
required
integer
limit
required
integer
offset
required
integer
key
additional properties
Example
{
"items": [
{
"id": "attr_123",
"tenant_id": "tenant_123",
"name": "department",
"display_name": "Department",
"description": "Admin department.",
"attribute_type": "enum",
"allowed_values": [
"engineering",
"support"
],
"is_required": {
"not": {}
},
"is_multi_valued": {
"not": {}
},
"is_system": {
"not": {}
},
"created_at": 1770000000000,
"updated_at": 1770000000000
}
],
"total": 1,
"limit": 100,
"offset": 0
}

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