コンテンツにスキップ

Update admin attribute

PATCH
/api/admin/admin-attributes/{id}
Code sample: Shell / cURL
curl --request PATCH \
--url https://auth.example.com/api/admin/admin-attributes/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "display_name": "Department", "allowed_values": [ "support", "security", "operations" ] }'

Updates mutable fields of a tenant admin ABAC attribute definition using explicit field mapping to avoid mass assignment.

id
required
string

JSON request body.

Media type application/json
object
>= 1 properties
display_name
string
description
string
allowed_values
Array<string>
min_value
number
max_value
number
regex_pattern
string
is_required
boolean
is_multi_valued
boolean
key
additional properties
Example
{
"display_name": "Department",
"allowed_values": [
"support",
"security",
"operations"
]
}

Admin attribute response.

Media type application/json
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
Example
{
"id": "attr_123",
"tenant_id": "tenant_123",
"name": "department",
"display_name": "Department",
"description": "Admin department.",
"attribute_type": "enum",
"allowed_values": [
"engineering",
"support"
],
"is_required": false,
"is_multi_valued": false,
"is_system": false,
"created_at": 1770000000000,
"updated_at": 1770000000000
}

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

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