Sign in
admin

Changed on

Staff viewset for managing users.

post/api/v2/admin/users/

Request

  • The document declares no server URL.
  • Auth: one of:
    • API key in header Authorization
    • API key in cookie sessionid

Request body

usernamestring required

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

first_namestring
last_namestring
is_activeboolean

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

Response

idinteger required
usernamestring required

Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.

first_namestring
last_namestring
emailstring email required
user_permissionsstring[] required
is_superuserboolean required

Designates that this user has all permissions without explicitly assigning them.

date_joinedstring date-time required
is_activeboolean

Designates whether this user should be treated as active. Unselect this instead of deleting accounts.

is_staffboolean required

Designates whether the user can log into this admin site.

is_systemboolean required

Changes

  • 0c39b4998d9fRevision changes
    • warning

      removed the request property (media type: application/json)

    • warning

      removed the request property (media type: application/x-www-form-urlencoded)

    • warning

      removed the request property (media type: multipart/form-data)

  • a40a2668c60bRevision changes
    • breaking

      the response property's maxLength was unset from 254 for the response status

    • warning

      removed the request property (media type: application/json)

    • warning

      removed the request property (media type: application/x-www-form-urlencoded)

    • warning

      removed the request property (media type: multipart/form-data)

    • info

      the response optional property became read-only for the status

    • info

      the response property became required for the status