Authenticate

Supply username and password to generate Authentication Token.

Rate Limiting Authenticate

Rate limiting is implemented on the authenticate endpoint to ensure fair usage and protect the service from excessive requests. Please take note of the following rate limiting rules:

  1. Invalid Request Limit:
    Up to 5 identical invalid requests are permitted within a 2-minute period. Upon reaching this limit:

    • Subsequent identical requests will receive a 429 HTTP Status (Too Many Requests).
    • After a 2-minute waiting period, the endpoint can be called again. However, if the credentials remain invalid, 401 HTTP Status (Unauthorized) responses will be issued.

  2. Overall Request Threshold:
    There is also a threshold for the total number of authentication requests within a given time-frame:

    • More than 10,000 requests to the authenticate endpoint within a 5-minute period will result in a lockout from the endpoint.
    • Note that the evaluation window for this threshold is 5 minutes. Importantly, 429 HTTP Status responses also count towards the 10,000 request limit.
    • In the event that the threshold is exceeded, you must wait a full 5 minutes before the endpoint will accept new requests again.

Request
Request Body schema: application/json
optional
username
string

Credentials assigned upon sign up

password
string
Responses
200
401
post/authenticate
Request samples
application/json
{
  • "username": "username@domain.com",
  • "password": "^1gHySRA56aj>tf421o"
}
Response samples
application/json
{
  • "token": "eyJhbGciOiJSUzI1NiIsImtpZCI6ImRodTNnNkFtTG5QQXVpOEJSMUFEVnp5ZHBnZyIsInR5cCI6IkpXVCIsIng1dCI6ImRodTNnNkFtTG5QQXVpOEJSMUFEVnp5ZHBnZyJ9.eyJuYmYiOjE1OTU0MTYyMDksImV4cCI6MTU5NTQxOTgwOSwiaXNzIjoiaHR0cHM6Ly9teWxvZ2luLnRlc3QuY3JlZGl0c2FmZS5jb20iLCJhdWQiOlsiaHR0cHM6Ly9teWxvZ2luLnRlc3QuY3JlZGl0c2FmZS5jb20vcmVzb3VyY2VzIiwiY29ubmVjdF9hcGkiLCJ1Ym9fYXBpX2dhdGV3YXkiXSwiY2xpZW50X2lkIjoiY29ubmVjdC5hcGkuY2xpZW50Iiwic3ViIjoiMTAxNTIwMjg1IiwiYXV0aF90aW1lIjoxNTk1NDE2MjA5LCJpZHAiOiJsb2NhbCIsInVzZXJuYW1lIjoiQ29ubmVjdHUxIiwiZW1haWwiOiJDb25uZWN0MUBnbWFpbC5jb20iLCJjdXN0b21lcklkIjoiMTAxNzY0NDA1IiwiY291bnRyeSI6IkMwIiwidXNlclJvbGUiOiJDcm1BZG1pblBsdXMiLCJzYl9jb3VudHJ5IjoiVVMiLCJzY29wZSI6WyJjb25uZWN0X2FwaSIsInVib19hcGlfZ2F0ZXdheSJdLCJhbXIiOlsicHdkIl19.p8kPAlKNB9iWEKiQbfbRXBoLQuBG7NuEDN__A8AQ55CL-gcIwkS1717Af1f9W0uifwIQ6HAZQR_x191LVkvuWD94Zw8zLzzr1ioUIhQny_zYuAS3G6EFNaTHh_mvOQ9XVi1FyuIy6YYcYcNLNZurFuITF2w5LuX4YQBjQy3rhEAdRoKcUKbtCClMFaH2dV35jiX2d7BqyhtJ8GeZyJ6yfMfdzznqxlJ4Osf5aasKUy8RYKEpjU2pkCURojoy5_oviGs8X4U9mJWcuajmPF3i5DHkqbhq1Mp0UZrDyoq_0BDStV5xqRgq6aOY8mc45kX7cwY3O2hPeGE7Ak8YtKFbA"
}
➔ Next to User Administration