Retrieve and manage user API access tokens using Splunk Observability Cloud

How to view and manage user API access (session) tokens. List of API requests that require a user API access token that was created by an admin.

Learn how to retrieve user API access tokens to authenticate all API requests, including those that send data.

Keep in mind you might also need the following access tokens:

Retrieve your user API access token (session token)

Splunk Observability Cloud automatically generates a user API access token every time you log in.

To retrieve it:

  1. On the left nav menu, select Settings.

  2. Select your profile name.

  3. Select Show User API Access Token.

  4. If you need it, copy the token to your clipboard.

  5. If you keep your Account Settings screen open, select Hide to prevent others from seeing your token.

You don’t need to delete your user API access tokens. Instead, you can let them expire.

User API access token expiration

A user API access token you create on the Account Settings page expires when you log out of Splunk Observability Cloud, or after 30 days, whichever comes first. As a result, they aren’t the best choice for continual data transmission.

To create a user API access token that doesn’t expire when you log out of Splunk Observability Cloud but still expires after 30 days, use the v2/session endpoint. For more information, see Sessions Tokens.

API requests that require a user API access token created by an administrator

These API requests require a user API access token created by an administrator.

API

Task

Integration

Create, update, delete, or validate an integration

Org token

Create, update, or delete an org (access) token, or rotate an org token secret

Dashboards and dashboard groups

Change or remove write permissions for a user other than yourself

Detectors

Change or remove write permissions for a user other than yourself

Organizations

The following API requests require a User API access token associated with an administrator:

  • Retrieve information for your organization

  • Retrieve information for one or more organization users

  • Create, update, or delete a custom metric category

  • Invite a user to your organization

  • Invite a group of users to your organization

  • Grant administrative access to a user

  • Delete a user from your organization

Teams

Create, update, or delete a team, or remove a team member other than yourself.

You can manage permissions on items for which you already have permissions, even if you’re not an administrator.

If you’re an administrator, you can see how a user created or updated an object using a particular user API access token by selecting Info from the object’s Actions menu.

For example, to see information for a dashboard, select Dashboard > Info from the dashboard’s Actions menu.

To track API calls by user, ask your users to obtain and use their own user API access tokens.

Create an admin token

If you are an admin, you can create a token and assign it admin permissions. All admins have the capability token_mgmt .

Any user with token management capabilities (capability: token_mgmt) can create a token. However, only users with the admin role can create a token with the admin role. A user can only create a token if the user has the token_mgmt capability. Even if a user has the the token_mgmt capability, the user can only create tokens for the roles that the user has.

All users with permissions to create tokens can create RUM and Ingest tokens.