Users

Patch User

Update user flags (admin only).

patch/api/v1/users/{user_id}

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

user_idstring required

Unique identifier of the user to update.

Request body

is_activeboolean nullable

Set to true to enable the account or false to disable it.

is_superuserboolean nullable

Set to true to grant or false to revoke superuser privileges.

is_verifiedboolean nullable

Set to true to mark the email as verified or false to unverify.

passwordstring nullable

New plain-text password (8–128 characters); stored hashed.

Response

The updated user.

idstring required

Unique identifier of the user.

emailstring required

Email address of the user.

is_activeboolean required

Whether the user account is active and can log in.

is_superuserboolean required

Whether the user has superuser (admin) privileges.

is_verifiedboolean required

Whether the user's email address has been verified.

created_atstring date-time required

Timestamp when the user account was created.

updated_atstring date-time nullable

Timestamp of the last update to the user account.

Changes

No recorded changes to this operation across all 1 revision of this API.