Docs
DocumentationQuery ReferenceAPI Reference
Open Console→→
DocumentationQuery ReferenceAPI Reference

Platform overview

What is Axiom?QuickstartArchitectureFeatures
Fundamentals
Datasets
Edge deployments
Limits
Performance
Optimize usage
Requirements
Semantic conventions
Glossary
Tour
SecurityRoadmap

Send data

Reference architecturesMethods

Understand data

Console
Query
Builder
Editor
Query results
Visualize
Traces
Metrics
Correlations
Save queries
Stream
Dashboard
Create
Elements
Create
Configure
Element types
Gauge
Heatmap
Log stream
Monitor list
Note
Pie chart
Scatter plot
Statistic
Table
Time series
Sections
Configure
Filter
Monitor
Overview
View status
Configure
Examples
Monitor types
Anomaly
Match
New values
Threshold
Alerting
Overview
Configure
Notifier types
Amp
ChatGPT Workspace Agent
Claude Code
Cursor
Custom Webhook
Discord
Email
incident.io
Jira Service Management
Microsoft Teams
Opsgenie
PagerDuty
Slack
Annotations
Command Menu
Manage
Datasets
Overview
Views
Virtual fields
Access
RBAC
Tokens
CLI
Organization
Labels
Audit log
Settings
Usage and billing
Profile
Extend
Overview
AWS Lambda
AWS PrivateLink
Cloudflare Workers
Cloudflare Logpush
Convex
Grafana
Hex
Netlify
Supabase
Tailscale
Terraform
Unkey
Vercel
Intelligence
Overview
Spotlight
AI agents
Overview
MCP Server
Overview
Tools
Query cost limits
Agent-created orgs
Skills
Overview
Axiom alerting
Build dashboards
Control costs
SRE
Translate SPL to APL
Splunk
Overview
Splunk app
Install and configure
Commands
Traces
Examples
Portal
How it works
Set up standard mode
Set up transparent mode
Observability Cloud
OCSF data
OCSF as CIM
SPL command support
Examples
Monitor and troubleshoot

Use cases

ObservabilityProduct analytics
OCSF security data
Overview
Send data
Query data
LLM observability
Overview
Use Vercel AI SDK
Manual instrumentation
OpenAI Agents SDK
GenAI attributes
Redaction policies

Miscellaneous

LLMs
Overview
List of docs pages
Full docs
Query reference
FAQs
Legal
Acceptable use policy
Axiom for Startups terms
Committed use terms
Cookies
Data processing
HIPAA
Partner agreement
Partner program guide
Privacy policy
SLA
Terms of service
Terms of use
Understand data/Console

Role-Based Access Control

This section explains how to configure Role-Based Access Control (RBAC).

Role-Based Access Control (RBAC) allows you to manage and restrict access to your data and resources efficiently. You can control access to your data with the following:

  • Groups
  • Roles
  • Users
  • Directory Sync
  • Single Sign-On (SAML SSO)
Info

Role-Based Access Control (RBAC), Directory Sync, and Single Sign-On (SAML SSO) are available as add-ons on the Axiom Cloud plan. For more information, see Manage add-ons.

Groups

Groups connect users with roles, making it easier to manage access control at scale. For example, you can create groups for areas of your business like Security, Infrastructure, or Business Analytics, with specific roles assigned to serve the unique needs of these domains.

A user’s complete set of capabilities is derived from the additive union of their base role, plus any roles assigned through group membership.

Create new group

  1. Click Settings > Groups
  2. Click New group.
  3. Enter the name and description of the group.
  4. Click Add users to add users to the group.
  5. Click Add roles to add roles to the group.

Roles

Roles are sets of capabilities that define which actions a user can perform at the organization, dataset, and view levels.

Default roles

The default roles are the following:

  • Owner: Assigns all capabilities across the entire Axiom platform.
  • Admin: Assigns administrative capabilities except for Billing capabilities, which are reserved for Owners.
  • User: Assigns standard access for regular users.
  • Read-only: Assigns read capabilities for datasets, plus read access on various resources like dashboards, monitors, notifiers, users, queries, saved queries, and virtual fields.
  • None: Assigns zero capabilities, useful for adopting the principle of least privilege when inviting new users. You can build up specific capabilities for these users by assigning their role to a group.

Create custom role

  1. Ensure you have create permission for the access control capability. By default, this capability is assigned to the Owner and Admin roles.
  2. Click Settings > Roles.
  3. Click New role.
  4. Enter the name and description of the role.
  5. Assign permissions (create, read, update, and delete) across capabilities (access control, API tokens, dashboards, datasets, etc.).

Assign capabilities to roles

You can assign organization-level, dataset-level, and view-level capabilities to roles. You can assign create, read, update, or delete (CRUD) permissions to most capabilities.

Organization-level capabilities define access for various parts of your Axiom organization:

  • Access control: Full CRUD.
  • Annotations: Full CRUD.
  • API tokens: Full CRUD.
  • Apps: Full CRUD.
  • Audit log: Read only.
  • Billing: Read and update only.
  • Dashboards: Full CRUD.
  • Datasets: Full CRUD.
  • Endpoints: Full CRUD.
  • Labels: Full CRUD.
  • Monitors: Full CRUD.
  • Notifiers: Full CRUD.
  • Shared access keys: Read and update only.
  • Users: Full CRUD.
  • Views: Full CRUD.

The table below describes these organization-level capabilities:

CapabilityCreateReadUpdateDelete
Access controlUser can create custom roles and groups.User can view the list of existing roles and groups.User can update the and description of roles and groups, and modify permissions.User can delete custom roles or groups.
AnnotationsUser can create annotations.User can view the list of existing annotations in an organization.User can modify annotations.User can delete annotations.
API tokensUser can create an API token with access to the datasets their user has access to.User can access the list of tokens that have been in their organization.User can regenerate a token from the list of tokens in an organization.User can delete API tokens created in their organization.
AppsUser can create a new app.Users can access the list of installed apps in their organization.Users can modify the existing apps in their organization.User can disconnect apps installed in their organization.
Audit log—Users can access the audit log in an organization.——
Billing—User can access billing settings.User can change the organization plan.—
DashboardsUser can create new dashboards.User can access their own dashboards and those created by other users in their organization.User can modify dashboard titles and descriptions. User can add, resize, and delete charts from dashboards.User can delete a dashboard from their organization.
DatasetsUser can create a new dataset.Users can access the list of datasets in an organization, and their associated fields.User can trim a dataset, and modify dataset fields.User can delete a dataset from their organization.
EndpointsUser can create endpoints.User can view the list of endpoints in an organization.User can modify existing endpoints in an organization.User can delete endpoints from their organization.
LabelsUser can create organization-wide resource labels.User can view the labels in an organization.User can change a label's name, description, and color.User can delete a label and remove it from all assigned resources.
MonitorsUser can create a monitor.User can access the list of monitors in their organization. User can also review the monitor status.Users can modify a monitor configuration in their organization.Users can delete monitors that have been created in their organization.
NotifiersUser can create a new notifier in their organization.User can access the list of notifiers in their organization.User can update existing notifiers in their organization. User can snooze a notifier.User can delete notifiers that have been created in their organization.
Shared access keys—User can access shared access keys in their organization.User can update shared access keys in their organization.—
UsersUsers can invite new users to an organization.User can access the list of users that are part of their organization.User can update user roles and information within the organization.Users can remove other users from their organization and delete their own account.
ViewsUser can create new views.User can access the list of views in an organization in their organization.User can modify views.User can delete views from their organization.

Dataset-level capabilities provide fine-grained control over access to datasets. You can assign the following capabilities for all datasets or individual datasets:

  • Ingest: Create only.
  • Query: Read only.
  • Starred queries: Full CRUD.
  • Virtual fields: Full CRUD.
  • Vacuum fields: Update only.
  • Trim data: Update only.
  • Share: Create, read, and delete only.

The table below describes these dataset-level capabilities:

DatasetsCreateReadUpdateDelete
IngestUser can ingest events to datasets.———
Query—User can query events from datasets.——
Starred queriesUser can create a starred query for datasets.User can access the list of starred queries in their organization.User can modify an existing starred query in their organization.User can delete a starred query from a dataset.
Virtual fieldsUser can create a new virtual field.User can see the list of virtual fields.User can modify the definition of a virtual field.User can delete a virtual field.
Vacuum fields——User can vacuum datasets and delete fields from datasets.—
Trim data——User can trim datasets and delete data from datasets.—
ShareUser can share datasets.User can access the list of shared datasets in their organization.—User can delete dataset sharing links and remove shared dataset access.

View capabilities

View-level capabilities provide fine-grained control over access to individual views. You can assign the following capabilities per view:

  • Query: Read only. User can query the view.
  • Share: Create, read, and delete only. User can share the view, view sharing settings, and revoke shared access.

Access to datasets

The datasets that individual users have access to determine the following:

  • The data they see in dashboards. If a user has access to a dashboard but only to some of the datasets referenced in the dashboard’s elements, the user only sees data from the datasets they have access to.
  • The monitors they see. A user only sees the monitors that reference the datasets that the user has access to. If a user has access to the monitors of an organization but only to some of the datasets referenced in the monitors, the user only sees the monitors that reference the datasets they have access to. If a monitor joins several datasets, a user can only see the monitor if the user has access to all of the datasets.

Users

Users in Axiom are the individual accounts that have access to an Axiom organization. You assign a base role to users when you invite them to join your organization. For organizations with the role-based access control (RBAC) add-on, additional roles can be added through group membership.

In Settings > Users, you can:

  • Invite users to your organization by clicking New user.
  • Export the user list by clicking Export CSV.
  • Review each user’s query cost in the user list.

Assign roles to users

  1. Click Settings > Users.
  2. Find the user in the list, and then assign a role to them on the right.

Access for a user is the additive union of capabilities assigned through their default role, plus any capabilities included in roles assigned through group membership.

Delete users

Warning

This is a destructive action. After you delete a user, you can’t recover their account.

  1. Click Settings > Users.
  2. Find the user in the list, and then click Delete user on the right.

Directory Sync

Directory Sync (SCIM) automatically provisions, updates, and deprovisions users and groups from your identity provider.

To configure Directory Sync, go to Settings > Access and identity. In Enable Directory Sync (SCIM), click Configure to open the WorkOS portal and connect your directory. Once connected, Settings > Access and identity displays the connection status and synced counts, and provides Manage to update your configuration in WorkOS.

For more information, see Directory Sync and Supported vendors in the WorkOS documentation.

Single Sign-On (SAML SSO)

Security Assertion Markup Language-based Single Sign-On (SAML SSO) centralizes user authentication through your identity provider (for example, Okta, Azure AD, Google Workspace, OneLogin, or JumpCloud). Axiom supports both IdP-initiated and SP-initiated flows.

Info

Two-factor authentication (2FA) requires users to provide two forms of identification before accessing their accounts. Turn on and enforce 2FA for SSO users through your identity provider. Axiom doesn’t offer 2FA natively.

Configure SAML SSO

Configure SSO directly in Settings > Access and identity using the WorkOS portal. Before opening the portal for any step, Axiom lets you optionally add IT contact emails to receive WorkOS notifications, including SAML certificate expiry alerts.

  1. Click Settings > Access and identity.
  2. In Verify your domain, click Verify domain and complete domain ownership verification in WorkOS.
  3. In Connect SAML Single Sign-On, click Configure and follow the WorkOS setup steps for your identity provider.
  4. Optional: In Enable Directory Sync (SCIM), click Configure to sync users and groups from your directory.
  5. Optional: In Provisioning, select a Default role for new users. Axiom assigns this role to people who join through SSO or Directory Sync when your identity provider doesn’t assign a role. Existing members keep their role, and Owner isn’t available as a default role.

Once connected, Settings > Access and identity displays your verified domain, SSO slug, and SSO login URL, and provides Manage to update settings in WorkOS.

SAML certificates

Axiom manages its own SAML signing certificates automatically. For your identity provider’s SAML certificate, Settings > Access and identity tracks expiry status and displays Rotate certificate when renewal is recommended or the certificate has expired.

For more information, see Enterprise Single Sign-On and Supported vendors in the WorkOS documentation.

Was this page helpful?
Suggest edits on GitHub
PreviousVirtual fieldsNextAuthenticate API requests with tokens
On this page
GroupsCreate new groupRolesDefault rolesCreate custom roleAssign capabilities to rolesView capabilitiesUsersAssign roles to usersDelete usersDirectory SyncSingle Sign-On (SAML SSO)Configure SAML SSOSAML certificates