v1

latestOpenAPI 3.0.42026-08-064075233.0 KB

Authentication

Login User

Logs in user and return JWT(JSON Web Token) which can be used to make API calls. The value of the token attribute in the response body is the JWT. Note that if a user logs in again the current JWT will no longer be valid and using it for API calls will return 401(Unauthorized). In that case the user must log in again. Also note that this means a user can not be logged in from two different browsers at the same time.

If two factor authentication is used it is no longer enough to just log in a user once to get a JWT. Instead, after the first login with email and password an email is sent to the user about to login with a two factor token that needs to be included in another login request together with the email and password.

post/api/authentication/login

Request body

emailstring nullable required

Email address of user who is logging in.

twoFactorTokenstring nullable

Two factor validation code received by email after first login step, if using two factor authentication.

passwordstring nullable required

Password for user who is logging in.

Example request

{
  "email": "john.doe@example.com",
  "twoFactorToken": "391823",
  "password": "Super_Secret1234"
}

Response

nextStepstring nullable

Next step to take depending on if password has been entered, a two factor token is required etc. Possible values are: Complete, Email, External and Password.

tokenstring nullable

JWT to use for the user to make API calls.

releaseNoteToDisplaystring nullable

The current release not to display for the user that logged in.

Example response

{
  "nextStep": "Complete",
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJiNWVkNWYwYy0yNjRmLTRiYjktOWMxOS1kNzg2YmY4NWQyMTgiLCJqdGkiOiJhNTNhNWRkMy03ZjU2LTQwNGQtOGFkNS02ODIwZTJjMGFkYzkiLCJmdWxsTmFtZSI6Ik15IFVzZXIiLCJvaWQiOiIyZjM2OWNkZC0yNWU5LTRlNjktODJjNS02MGYwM2IwMzRjNTgiLCJvcmdhbml6YXRpb24iOiJNeSBPcmdhbml6YXRpb24iLCJnbG9iYWxSb2xlIjoiTm9uZSIsInN1YnNjcmlwdGlvblR5cGUiOiJDb21tZXJjaWFsIiwicm9sZXMiOlsiVXNlciIsIlN1cGVyIFVzZXIiXSwibmJmIjoxNzI3MjU0NTc3LCJleHAiOjE3MjgxMTg1NzcsImlzcyI6IkVkZ2VEaXJlY3RvciIsImF1ZCI6IkVkZ2VEaXJlY3RvciJ9.dwCoVuaCSaTulh1FwASaNwaLx2N5L9yXhIq7aPnimpg",
  "releaseNoteToDisplay": "44"
}