Skip to content
Authrim

Create admin attribute

POST
/api/admin/admin-attributes
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/admin-attributes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "department", "display_name": "Department", "attribute_type": "enum", "allowed_values": [ "support", "security" ], "is_required": false, "is_multi_valued": false }'

Creates a tenant admin ABAC attribute definition after validating required name and duplicate names.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”

JSON request body.

Media type application/json
object
name
required
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
key
additional properties
Example 
{
  "name": "department",
  "display_name": "Department",
  "attribute_type": "enum",
  "allowed_values": [
    "support",
    "security"
  ],
  "is_required": false,
  "is_multi_valued": false
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

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
}

400

Section titled “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

Section titled “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

Section titled “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"
}

409

Section titled “409 ”

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

500

Section titled “500 ”

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