Authentication

This page details how to use the Authentication Controller's login endpoint to authenticate users and obtain Auth0 tokens for session management.

To authenticate, the user must provide a base token and credentials from Auth0. We assign the necessary permissions to ensure secure access to our APIs.

Bearer token to authenticate the user:

eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InhJYTdTZDFKZThxU01ZaHY4WVhaYSJ9.eyJpc3MiOiJodHRwczovL2ZyZWVuYW1lLmV1LmF1dGgwLmNvbS8iLCJzdWIiOiJsS1hYa1FpS3hmRFdyTmUzYWtnSEFOQWxZS0tiTWNVMkBjbGllbnRzIiwiYXVkIjoiaHR0cHM6Ly9hdXRoMC8iLCJpYXQiOjE3MzM5MjY2MTYsImV4cCI6MTczNjUxODYxNiwic2NvcGUiOiJyZWFkIEFkbWluIiwiZ3R5IjoiY2xpZW50LWNyZWRlbnRpYWxzIiwiYXpwIjoibEtYWGtRaUt4ZkRXck5lM2FrZ0hBTkFsWUtLYk1jVTIiLCJwZXJtaXNzaW9ucyI6WyJyZWFkIiwiQWRtaW4iXX0.QE_H_-O_gorT3ebjaeGmmg6dsAIpXuUKpvsNCchgizyNbumKjmj4_Hjdmcz4SvpJCrLiUSANmktbdzMmw4CWPFaMNcprTdTOUJ2MYrZl_00q86Uks2bJnEN86qfgPJq--4MiOqsnzkKsW_k6gSZQVxNQi5Y3s8z5lmV5Q-QxtIlvsL9-SlTZpwNfJGLumH0gzx4UmiYo0h1FAx2IKQpNxhe_CGiQ-0Dx0XabHE8oZtxC7g9LIUbv4zqkpQJLL3fGzXog1LjBzE7QlGEgLNUGfwIvlSzp06y9v4JhDvcm8lHg6V49LLkJN4MFNMm_RQ8GbIpQDddyMhAdCP1KYUWr1w

1. Log in with a given username and password.

To log in, users must first request an authorization token, which we provide upon initial request. With this authorization token, users can then request an access token. Upon successful authentication, an access token, refresh token, and ID token will be provided in the response. The access token is used for accessing other APIs, while the refresh token allows users to obtain a new access token without further interaction.

• POST /api/v1/auth/login

Request Headers

Name	Description
Bearer Token	[Required] The first authorization token we provide for the log in.

Request

{
    "username": "your_username",
    "password": "password"
}

Response

200 OK

{
    "access_token": "eyJhbGciOi...W5Aq_PT-aHS4zfDWKVdhTuIC081TfyW8A",
    "refresh_token": "iCBG8_QvW...17aUv5",
    "id_token": "eyJhbGciOiJSUzI1NiI...3BruaGMzqgc6N0OgnrLFpmsx4i8g",
    "scope": "openid profile email address phone offline_access",
    "expires_in": 2592000,
    "token_type": "Bearer"
}

1. Request a new access given the refresh token obtained during the log in.

To request a new access token using the refresh token obtained during login, send a request with the refresh token. Upon successful verification, a new access token and ID token will be provided in the response.

Name	Description
Bearer Token	[Required] The access token can be used to renew and utilize the refresh token.

Request

{
    "refreshToken": "iCBG8_QvWq1...mD917aUv5"
}

Response

{
    "access_token": "eyJhbGciOiJSUzI1NiIsIn...opG2Of3PMT0wtmvad5JpFseBB_7ZmA",
    "id_token": "eyJhbGciOiJSUzI1NiIsInR...yJ4Wko-QM0Dkw",
    "scope": "openid profile email address phone offline_access",
    "expires_in": 2592000,
    "token_type": "Bearer"
}