admin

Create a user (admin)

Changed on

Create a new local user account. Respects the admin-only fields is_admin and skip_email_confirm. The public registration toggle is bypassed.

post/admin/users

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
  • Auth
    API key in header Authorization

Request body

emailstring

The user's email address

is_adminboolean

Mark the new user as an instance admin.

languagestring

The language of the new user. Must be a valid IETF BCP 47 language code and exist in Vikunja.

namestring

The full name of the new user. Optional.

passwordstring

The user's password in clear text. Only used when registering the user. The maximum limi is 72 bytes, which may be less than 72 characters. This is due to the limit in the bcrypt hashing algorithm used to store passwords in Vikunja.

skip_email_confirmboolean

Activate the new user immediately without email confirmation.

usernamestring

The user's username. Cannot contain anything that looks like an url or whitespaces.

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