Login

Login to Account with Username and Password

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
username
string [ 1 .. 1024 ] characters

Username of the account that needs to login

password
string [ 1 .. 1024 ] characters

Password of the account that needs to login.

api_key
string [ 1 .. 1024 ] characters

API key (without 'apk ' prefix) of the account that needs to login. When api_key is set then username/password would be ignored if provided.

Responses
200

Account Login Successful

401

Unauthorized

post/login
Request samples
application/json
{
  • "username": "string",
  • "password": "string",
  • "api_key": "string"
}
Response samples
application/json
{
  • "access_token": "string",
  • "token_type": "string",
  • "expires_in": 0
}

Invalidates username/password and SSO login session.

SecurityApiKeyAuth
Request
header Parameters
Authorization
required
string

Access token

Responses
200

Logged out

post/logout

Get Token Information

SecurityApiKeyAuth
Request
Request Body schema: application/json
token
required
string [ 1 .. 2048 ] characters

API Key or JWT token for fetching information

Responses
200

OK

401

Unauthorized

post/token-info
Request samples
application/json
{
  • "token": "Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIyIiwiaXNzIjoiYXBpZ3ctc2VydmljZXMtYXBwIiwiaWF0IjoxNjYwMDI1MTczLCJlbWFpbCI6ImppdGVuZHJhLm1hdGh1ckBkZWxwaGl4LmNvbSIsInVzZXJuYW1lIjoidXNlci00MjciLCJleHAiOjE2NjAxMTE1NzN9._9LgnIlkKUr2KVqjeFYqru3GxJr2-ztSmP0XO3vBkRo"
}
Response samples
application/json
{
  • "active": true,
  • "token_type": "Bearer",
  • "account_id": 1,
  • "first_name": "first-name",
  • "last_name": "last-name",
  • "email": "abc@example.com",
  • "username": "user-name",
  • "exp": 400
}
➔ Next to SamlLogin