Authentication & Security

Our API uses token-based authentication to ensure secure access. Every API request must be authenticated by including your API key in the HTTP request headers. Below is a detailed guide on how authentication works:

• Token Inclusion:

  All API requests should include your Personal Access Token in the Authorization HTTPS header. The format should be as follows:

  Authorization: Bearer <YOUR_PERSONAL_ACCESS_TOKEN>

  Replace <YOUR_PERSONAL_ACCESS_TOKEN> with your actual token obtained from the Aurora platform..

• Obtaining Your API Key:

  1. User Registration & Login: 
     • Start by signing up or logging into the Aurora platform.
  2. Navigate to Token Settings
     • Go to Settings → Personal Access Tokens and select the organization you want to create a token for
  3. Create a Token:
     • Enter a descriptive token name, select roles to define the token's scope, choose the project access (all accessible projects or specific projects), and set an expiration date.

• Error Handling for Authentication:

  • 401 Unauthorized: If your token format is invalid or unrecognized, the API will return a 401 error.
  • 403 Forbidden: If your token is missing, expired, revoked, or does not have the necessary permissions, the API will return a 403 error.
  • Tips:  Ensure that the token is correctly formatted in the header with the Bearer prefix, that it has not expired or been revoked, and that the requested action is within the token's configured scope