docs-v2/content/influxdb/v2/admin/tokens/view-tokens.md

4.1 KiB

title seotitle description menu weight aliases
View tokens View API tokens in InfluxDB View API tokens in InfluxDB using the InfluxDB UI, the `influx` CLI, or the InfluxDB API.
influxdb_v2
name parent
View tokens Manage tokens
202
/influxdb/v2/users/tokens/view-tokens
/influxdb/v2/security/tokens/view-tokens/

View API tokens and permissions using the InfluxDB user interface (UI), the influx command line interface (CLI), or the InfluxDB API.

{{% note %}}

{{% oss-only %}}Tokens are visible to the user who created the token. Users who own a token with operator permissions also have access to all tokens. Tokens stop working when the user who created the token is deleted.

In the InfluxDB UI, full tokens are only visible immediately after the token is created.

We recommend creating a generic user to create and manage tokens for writing data. {{% /oss-only %}}

{{% cloud-only %}} To follow best practices for secure API token generation and retrieval, InfluxDB Cloud enforces access restrictions on API tokens.

  • InfluxDB Cloud UI only allows access to the API token value immediately after the token is created.
  • You can't change access (read/write) permissions for an API token after it's created.
  • Tokens stop working when the user who created the token is deleted.

We recommend the following for managing your tokens:

  • Create a generic user to create and manage tokens for writing data.
  • Store your tokens in a secure password vault for future access. {{% /cloud-only %}} {{% /note %}}

View tokens in the InfluxDB UI

{{% oss-only %}}

  1. In the navigation menu on the left, select Data (Load Data) > API Tokens.

{{< nav-icon "load-data" >}}

  1. Click a token name in the list to view the token status and a summary of access permissions.

{{% /oss-only %}}

{{% cloud-only %}}

  1. In the navigation menu on the left, select Load Data > API Tokens.

{{< nav-icon "load-data" >}}

  1. Click a token description in the list to view the token status and a list of access permissions.

{{% /cloud-only %}}

View tokens using the influx CLI

Use the influx auth list command to view tokens.

influx auth list

Filtering options such as filtering by authorization ID, username, or user ID are available. See the influx auth list documentation for information about other available flags.

View tokens using the InfluxDB API

Use the /api/v2/authorizations InfluxDB API endpoint to view tokens and permissions.

{{< api-endpoint method="GET" endpoint="/api/v2/authorizations" api-ref="/influxdb/v2/api/#operation/GetAuthorizations" >}}

Include the following in your request:

Requirement Include by
API token with the read: authorizations permission Use the Authorization: Token YOUR_API_TOKEN header.
{{% get-shared-text "api/v2.0/auth/oss/tokens-view.sh" %}}

View a single token

To view a specific authorization and token, include the authorization ID in the URL path.

{{% api-endpoint method="GET" endpoint="/api/v2/authorizations/{authID}" api-ref="/influxdb/v2/api/#operation/GetAuthorizationsID" %}}

Filter the token list

InfluxDB returns authorizations from the same organization as the token used in the request. To filter tokens by user, include userID as a query parameter in your request.

{{% get-shared-text "api/v2.0/auth/oss/tokens-view-filter.sh" %}}

{{% oss-only %}}

Operator tokens have access to all organizations' authorizations. To filter authorizations by organization when using an operator token, include an org or orgID query parameter in your request.

{{% /oss-only %}}

See the /authorizations endpoint documentation for more information about available parameters.