users

Update a user. Only the authenticated user themselves and server admins have access to this endpoint. Some fields can only be updated by an admin. Changing the email, admin, or locked field requires a user session, even for an admin: neither a user API key nor a deprecated user API token can change them. A user's new email for themselves takes effect only once it is confirmed from a link sent to that email, so until then the response shows the current email. Any later update to the user ends that link. A server admin's change to another user's email takes effect at once. To manage users within your organization, use the organization members endpoints.

patch/v0/users/{user}

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

userstring required

The slug or UUID for a user.

Request body

adminboolean nullable

Update whether the user is an admin. Must be an admin to update this field.

emailstring
lockedboolean nullable

Update whether the user is locked. Must be an admin to update this field.

namestring
slugstring

Response

successful operation

adminboolean required
createdstring date-time
emailstring required
lockedboolean required
namestring required
slugstring required
uuidstring uuid required

Changes

    • info

      added the optional property to the response with the status

    • breaking

      added to the request property allOf list

    • breaking

      the response's property type changed from string to no type for status

    • warning

      removed from the request property allOf list