The authentication protocol uses the authorization token which allows third party services obtain limited access to your Axiom instances. It lets you configure a OAuth2 authentication when your provide your
Client ID and
Client Secret from your provider for multiple use case support.
To add OAuth2 Provider visit Settings > Authentication
Obtain a token in the Axiom UI
You can generate an API token and personal token manually in your Axiom user settings.
The API token is to used to send, and query data to one or more datasets. API tokens do not allow control of your organization, they are only used to ingest and query events, while the Personal token is used to access the Axiom API programmatically for custom integrations or for tools such as the Axiom CLI.
To generate an API Token
- Under settings, select API Tokens
- Select Add API Token
- Enter a Name and Description
- Select what permissions you want to grant your API Token.
- You can choose Ingest, Query, or Ingest and Query
- Select your dataset access. You can Allow access to any dataset or You can allow access to specific datasets only
- Copy the generated token to your clipboard. Once you navigate from the page, token can be seen again by selecting API Tokens.
API token is to used to send, and query data to one or more datasets. API tokens do not control of your organization.
For security reasons it is advised to use an API Token with minimal privileges only.
To generate a Personal Token
- Under settings, select profile
- Select Add personal Token
- Enter a Name and Description and select ADD
- Copy the generated token to your clipboard. Once you navigate from the page, token can be seen again by selecting Personal token
- Personal token grants access to all resources available to the user also use the personal token to access Axiom API programmatically for custom integrations or for tools such as the Axiom CLI.
- You need the
AXIOM_ORG_IDwhen using a personal token for Axiom Cloud.
The best way to get started with our API is to use Go-Axiom to send events directly to Axiom.
Manage datasets for your organization, including creating new datasets or deleting existing datasets.
Datasets are a collection of similar events. When data is sent to Axiom it is stored in a dataset.
Dataset names must be between 1-128 characters, and may only contain ASCII alphanumeric characters and the '-' character.
To create a dataset, enter the name and description of your dataset.
You can see the license and instance configuration for your organization by selecting Status this lets you know:
- How much data you can ingest.
- How long can you use your Instance.
- Maximum Datasets you can have.
- Maximum number of Users.
- Maximum number of Teams.
- Maximum Query Window.
You can view, create, and manage teams. Team members added can also manage access to datasets.
If you’re a team Owner, you can add new team members to the team by selecting the Add button at the upper right corner omn the Axiom UI.
Enter the name of the user you want to add as a member.
Search for the team member you want to add to your Team.
Only users with the roles User or Read Only can be added as team members. Once a user is added to one or more teams, they can only see the datasets that are visible to those teams.
After signing up, you can control the access to your Axiom deployments by managing the user's list. Settings > Users.
Team owners can add a user's name, email, and also assign a specific role.
Settings > Users > Add user > Assign roles.