Update an admin user.

PATCH

/api/admin/admins/{id}

Code sample: Shell / cURL

curl --request PATCH \
  --url https://auth.example.com/api/admin/admins/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "Admin User", "status": "active", "mfa_enabled": true }'

Update mutable Admin Console user fields such as name, email, status, and MFA flag.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Header Parameters

X-Tenant-Id

string

Tenant selector for multi-tenant admin requests.

Request Body ^required

Media type application/json

object

>= 1 properties

name

string

email

string format: email

status

string

Allowed values: active suspended

mfa_enabled

boolean

key

additional properties

Example

{
  "name": "Admin User",
  "status": "active",
  "mfa_enabled": true
}

Responses

200

Admin Console user response.

Media type application/json

object

id

required

string

tenant_id

required

string

email

required

string format: email

name

string | null

status

required

string

Allowed values: active suspended locked

is_active

required

boolean

mfa_enabled

boolean

last_login_at

integer | null format: int64

created_at

required

integer format: int64

updated_at

required

integer format: int64

key

additional properties

Example

{
  "id": "admin_123",
  "tenant_id": "default",
  "email": "[email protected]",
  "name": "Admin User",
  "status": "active",
  "is_active": true,
  "mfa_enabled": true,
  "last_login_at": 1770000000,
  "created_at": 1770000000,
  "updated_at": 1770000000
}

404

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