v21

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01144108427.9 KB
Users

Add User

Add a new user to the database.

This endpoint backs two flows that share the same route:

  • Public sign up (unauthenticated). Allowed only when public registration is enabled for the deployment, i.e. AUTO_LOGIN is off (multi-user mode) and ENABLE_SIGNUP is True.
  • Admin "add user" (authenticated active superuser). Always allowed, regardless of the sign up settings, so disabling public sign up does not break superuser-driven user creation.

User activation is controlled by the NEW_USER_IS_ACTIVE setting.

post/api/v1/users/

Request body

optinsobject nullable
passwordstring required
usernamestring required

Response

Successful Response

create_atstring date-time required
idstring uuid
is_activeboolean required
is_superuserboolean required
last_login_atstring date-time nullable required
optinsobject nullable
profile_imagestring nullable required
store_api_keystring nullable required
updated_atstring date-time required
usernamestring required