Sign in
Session

Create a new session (login)

If no users are defined, this will create an initial user with the given credentials.

post/api/session

Request body

OR

Response

On successful login the server will set the authentication cookies.

usernamestring

Username of the user.

scope'admin' | 'install' | 'update' | 'read'
totp_enabledboolean

Whether two-factor authentication is enabled/required using TOTP. Not available if Passkey is used.

passkeyboolean

Whether this user authenticates using a Passkey.

limitedboolean

In case the user was authenticated with a passwordless link, the scope of the API token used for generating that link is inherited to the user session. This flag is true if the user would have more permissions than currently given by the passwordless link.

Changes