Authentication

User login

Authenticate user with email and password. Sets authentication cookies on successful login.

post/auth/login

Request

  • The document declares no server URL.
  • Auth: none declared

Request body

emailstring required

Email address for authentication

passwordstring required

Password for authentication

Example request

{
  "email": "user@example.com",
  "password": "password123"
}

Response

Credentials accepted. Session cookies are set unless mfaRequired is true, in which case a short-lived MFA pending cookie is set instead.

successboolean required

Whether the credentials were accepted

mfaRequiredboolean required

True when a second factor is required before a session is issued. Complete the login via /auth/mfa/verify (or /auth/mfa/setup when enrollmentRequired is true).

enrollmentRequiredboolean required

True when the org requires two-factor auth and the user must enroll before receiving a session.

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 51 revisions of this API.