Skip to main content

​
Overview

To authenticate with Lumos, you will need:
  1. API Token - A key that grants secure access to the Lumos API, enabling authorized applications to interact with Lumos resources and services.
This guide will walk you through creating your API Token within Lumos.

​
Prerequisites:

  • You must have a Lumos account

​
Instructions:

​
Step 1: Creating Your API Token

  1. Go to the API Tokens page in the Lumos settings
  2. Click on Add API Token
  3. Enter a Name and a Description for your API token
  4. Click Create API Token
Store your API token carefully as it will only be shown during creation time.
API Tokens inherit and retain the permissions of the user that created them.

​
Step 2: Enter credentials in the Connect UI

Once you have your API Token:
  1. Open the form where you need to authenticate with Lumos.
  2. Enter your API Token in its respective field.
  3. Submit the form, and you should be successfully authenticated.
You are now connected to Lumos.