Skip to navigation
API ReferenceAuthentication

Login a user session

This endpoint creates a new session for the user using the given credentials.

Request

This endpoint expects an object.
usernamestringRequired
Username of the user.
passwordstringRequired
Password of the user.
challengestringOptional
TOTP code if enabled for the user.
recaptchaTokenstringOptional
deviceIdstringOptional
An optional device identifier to override a previous session for the device.

Response

A successful response.
resultobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error