Docmost Octri Preview
POST/auth/login

Log in with email and password

Authenticates a user by validating their email and password credentials. Supply email and password to sign in; email lookup is case-insensitive. A successful response may contain either login data or an MFA challenge.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 body fields

Login credentials for the user.

emailstringrequired
Account email address. Lookup is case-insensitive.
passwordstringrequired
Account password.

3 status codes
200Returns a response containing the login result or an MFA challenge.
dataunknownoptional
Response payload
statusintegeroptional
successbooleanoptional
400Returned when SSO is enforced or the request fails validation.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional
401Returned when the email address or password is invalid.
errorstringoptional
Reason phrase, for example `Bad Request`.
messagestringoptional
statusCodeintegeroptional

Error handling

email and password are required, and email must use a valid email format. A 400 is returned when SSO is enforced or the request fails validation. A 401 is returned when the email or password is invalid.