Create an admin role.

POST

/api/admin/admin-roles

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/admin-roles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "security_reviewer", "display_name": "Security Reviewer", "description": "Can review security settings.", "permissions": [ "admin:admin_roles:read", "admin:admin_audit:read" ], "hierarchy_level": 10 }'

Create a custom Admin role in DB_ADMIN after validating hierarchy and delegated permissions.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Header Parameters

X-Tenant-Id

string

Tenant selector for multi-tenant admin requests.

Request Body ^required

Media type application/json

object

name

required

string

display_name

string

description

string

permissions

required

Array<string>

hierarchy_level

integer

inherits_from

string | null

key

additional properties

Example

{
  "name": "security_reviewer",
  "display_name": "Security Reviewer",
  "description": "Can review security settings.",
  "permissions": [
    "admin:admin_roles:read",
    "admin:admin_audit:read"
  ],
  "hierarchy_level": 10
}

Responses

201

Admin role response.

Media type application/json

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

Example

{
  "role_type": "system"
}

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