Admin

Reset User Password

Set a user's password (admin only).

The manage_users permission authorizes this recovery path, so no current password is required. The submitted password is stored only as a hash and is omitted from audit details, logs, and the response.

Returns 422 when the target signs in through an identity provider and has no local password, or 404 when the user does not exist.

Resetting your own password is permitted and ends every session the account holds, including the one making this request, because the reset revokes the account's credentials.

post/admin/users/{user_id}/reset-password/

Request

  • The document declares no server URL.
  • Auth: one of:
    • OAuth 2 (password, token URL /api/auth/login)
    • API key in header X-Api-Key
    • API key in query parameter api_key

Path parameters

user_idstring uuid required

Request body

passwordstring required

Replacement password for the account (policy: min 12 chars, 3+ character classes, at most 72 bytes UTF-8). The user can change this after their next login.

Response

Successful Response

idstring uuid required
usernamestring required
emailstring nullable required
is_activeboolean required
status'active' | 'pending' | 'suspended' | 'deactivated' required

Account status: active, pending, suspended, or deactivated.

last_login_atstring date-time nullable required
created_atstring date-time required
rolesstring[] required

Assigned role names, e.g. ['admin', 'editor']

can_reset_passwordboolean required

Whether an administrator can set a local password for this account. True for local accounts even when an identity provider is also linked.

Changes

No recorded changes to this operation across all 50 revisions of this API.