Aurora uses Personal Access Tokens (PATs) to authenticate API requests.
PATs provide secure, user-specific access to Aurora APIs based on your Aurora permissions.
Important: New Service Accounts can no longer be created in Aurora. Existing Service Accounts are being deprecated. If you currently use a Service Account, migrate your integration to a Personal Access Token (PAT).
Before You Begin
To create a PAT, you need:
- An active Aurora account
- Access to an Aurora organization/workspace
- The appropriate permissions for the resources you want to access through the API
Your PAT cannot provide more permissions than your Aurora account already has.
Step 1: Open Personal Access Tokens
Log in to Aurora.
Open your profile/account menu and navigate to Personal Access Tokens.
Here you can view and manage the PATs you have created.
Step 2: Create a Personal Access Token
Select Create Personal Access Token.
Enter a name for your token. We recommend using a descriptive name that identifies the application, integration, or environment where the token will be used.
Examples:
DevelopmentProduction IntegrationAnalytics Script
Step 3: Configure Your Token
Select the appropriate scope for the token.
The scopes available to you depend on your Aurora role and existing permissions.
A PAT cannot grant permissions beyond those already assigned to your Aurora account.
Where applicable, select whether the token should apply to all accessible projects or specific projects.
Tip: Use the minimum permissions required for your integration.
Step 4: Configure Token Expiration
Select an expiration period for your PAT, where available.
We recommend setting an expiration appropriate for the application or integration using the token.
Using an expiration date limits the lifetime of the credential and makes credential management easier.
Step 5: Create and Copy Your PAT
Select Create to generate the token.
Aurora will display the token value.
Copy the token immediately and store it securely.
โ ๏ธ Important: The token value is displayed only once. You cannot view the token again after leaving this screen. If you lose the token, you must revoke it and create a new one.
Step 6: Store Your PAT Securely
Do not:
- Share your PAT with other users.
- Commit it to GitHub or another source-control repository.
- Include it directly in publicly accessible code.
- Send it through unsecured communication channels.
For applications and scripts, store your PAT using an environment variable or secrets manager.
For example:
export AURORA_API_TOKEN="YOUR_PERSONAL_ACCESS_TOKEN"
Step 7: Authenticate an API Request
Use your PAT to authenticate requests to the Aurora API.
Include the PAT in the Authorization header as a Bearer token:
curl -X GET "https://api.pixxel.space/v0/bandsets" \ -H "Authorization: Bearer YOUR_PERSONAL_ACCESS_TOKEN"
Replace YOUR_PERSONAL_ACCESS_TOKEN with the PAT you generated in Aurora.
Step 8: Test Your PAT
You can use the Bandsets endpoint to verify that your authentication is working:
curl -X GET "https://api.pixxel.space/v0/bandsets" \ -H "Authorization: Bearer YOUR_PERSONAL_ACCESS_TOKEN"
If your PAT is valid and has the required permissions, the API should return a successful response.
A successful 200 OK response confirms that your PAT is valid for the requested endpoint.
Troubleshooting
I receive a 401 or 403 response
Check the following:
- Your PAT was copied correctly.
- The
Authorizationheader is correctly configured. - Your PAT has not expired.
- Your PAT has not been revoked.
- Your Aurora account has permission to access the requested resource.
- The PAT scope is appropriate for the endpoint you're testing.
I lost my PAT
PATs are displayed only once when they are created.
If you no longer have the token value:
- Go to Personal Access Tokens.
- Revoke the lost token.
- Create a new PAT.
- Update your application or integration with the new token.
I need access to another project
A PAT cannot increase your Aurora permissions.
If you need access to another project, ask your Aurora organization administrator to grant your user account the required access.
Once your permissions have been updated, you can create a PAT with the applicable scope.
Managing Your Personal Access Tokens
From the Personal Access Tokens page, you can:
- Create additional PATs.
- View token metadata, including creation and expiration dates.
- Revoke tokens that are no longer required.
- Replace tokens when credentials need to be rotated.
Revoked and expired tokens can no longer be used to authenticate API requests.
Security Best Practices
For secure API access:
- Use separate PATs for different applications or environments.
- Use expiration dates where appropriate.
- Store PATs in environment variables or a secrets manager.
- Never commit PATs to source control.
- Revoke a PAT immediately if you believe it has been exposed.
- Rotate credentials periodically.
0 comments
Please sign in to leave a comment.