Authentication

Authenticate with password

Changed on

Authenticates a user with email and password. Depending on the user, the response is one of: tokens (AuthResponse), an MFA token when TOTP is on and the device is not remembered (MfaRequiredResponse), or an account picker (AccountSelectResponse) when no account was given and the user belongs to several accounts. Send device_token from an earlier MFA sign-in to skip TOTP.

post/accounts/auth-with-password

Request

Request body

accountstring

Account name or sign-in slug (optional). If it is omitted and the user belongs to several accounts, the response asks the caller to pick one (select_account).

emailstring email required

User's email address

passwordstring password required

User's password

device_tokenstring

Remembered-device token from an earlier MFA sign-in (valid for 30 days). A valid token skips the TOTP step.

Example request

{
  "account": "acme",
  "email": "user@example.com",
  "password": "SecurePassword123"
}

Response

Authentication successful or MFA required

Changes

    • breaking

      added to the response property oneOf list for the response status

    • info

      added the new optional request property

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • breaking

      the response's body type changed from no type to object for status

    • info

      removed from the response body oneOf list for the response status

    • info

      added the required property to the response with the status