admin

Set a user's status (admin)

Changed on

Change a user's status without requiring them to log in.

patch/admin/users/{id}/status

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/admin/users/{id}/status
  • Auth
    API key in header Authorization

Path parameters

idinteger required

User ID

Request body

status0 | 1 | 2 | 3

Response

OK

auth_providerstring
bot_owner_idinteger

BotOwnerID is the ID of the owning (human) user if this user is a bot. A non-zero value means this user is a bot and cannot authenticate via password.

createdstring

A timestamp when this task was created. You cannot change this value.

emailstring

The user's email address.

idinteger

The unique, numeric id of this user.

is_adminboolean
issuerstring
namestring

The full name of the user.

status0 | 1 | 2 | 3
subjectstring
updatedstring

A timestamp when this task was last updated. You cannot change this value.

usernamestring

The username of the user. Is always unique.

Changes