コンテンツにスキップ

Activate a suspended or locked end user.

POST
/api/admin/users/{id}/activate
Code sample: Shell / cURL
curl --request POST \
--url https://auth.example.com/api/admin/users/example/activate \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "reason_code": "investigation_cleared", "reason_detail": "Account review completed.", "notify_user": true }'

Restore a suspended or locked user account to the active state.

id
required
string
X-Tenant-Id
string

Tenant selector for multi-tenant admin requests.

Idempotency-Key
string

Idempotency key for state-changing operations that support replay protection.

Media type application/json
object
reason_code
required
string
Allowed values: investigation_cleared suspension_expired appeal_approved admin_action false_positive compliance_cleared other
reason_detail
string
notify_user
boolean
key
additional properties
Example
{
"reason_code": "investigation_cleared",
"reason_detail": "Account review completed.",
"notify_user": true
}

User status change response.

Media type application/json
object
user_id
required
string
status
required
string
Allowed values: suspended locked active
previous_status
required
string
effective_at
required
string format: date-time
expires_at

Present on temporary suspension responses.

string format: date-time
unlock_at

Present on lock responses when an unlock time was supplied.

string format: date-time
reason_code
required
string
revoked

Present on suspend and lock responses.

object
tokens
required

-1 means implicitly revoked through user status checks.

integer
sessions
required

-1 means implicitly revoked through user status checks.

integer
key
additional properties
key
additional properties
Example
{
"user_id": "user_123",
"status": "suspended",
"previous_status": "active",
"effective_at": "2026-06-19T00:00:00.000Z",
"expires_at": "2026-06-20T00:00:00.000Z",
"reason_code": "security_incident",
"revoked": {
"tokens": -1,
"sessions": -1
}
}

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