Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
docs-v2/content/influxdb3/cloud-serverless/admin/tokens/view-tokens.md

4.7 KiB
Raw Permalink Blame History

title seotitle description menu weight
View tokens View API tokens in InfluxDB View API tokens in InfluxDB using the InfluxDB UI, the `influx` CLI, or the InfluxDB API.
influxdb3_cloud_serverless
name parent
View tokens Manage tokens
202

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

{{% note %}} To follow best practices for secure API token generation and retrieval, {{% product-name %}} enforces access restrictions on API tokens.

  • InfluxDB 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. {{% /note %}}

{{< tabs-wrapper >}} {{% tabs %}} InfluxDB UI influx CLI InfluxDB API {{% /tabs %}}

{{% tab-content %}}

View tokens in the InfluxDB UI

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

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

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

{{% /tab-content %}}

{{% tab-content %}}

View tokens using the influx CLI

Use the influx auth list command to view tokens.

Provide the following flags:

  • --token: API token with permission to read authorizations

{{% code-placeholders "API_TOKEN" %}}

influx auth list --token API_TOKEN

{{% /code-placeholders %}}

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.

{{% /tab-content %}}

{{% tab-content %}}

View tokens using the InfluxDB API

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

{{< api-endpoint method="GET" endpoint="https://{{< influxdb/host >}}/api/v2/authorizations" api-ref="/influxdb3/cloud-serverless/api/#operation/GetAuthorizations" >}}

Include the following in your request:

  • Headers:
    • Authorization: Token API_TOKEN (API token with the read: authorizations permission)
    • Content-type: application/json

{{% code-placeholders "API_TOKEN" %}}

{{% get-shared-text "api/cloud-serverless/auth/tokens-view.sh" %}}

{{% /code-placeholders %}}

View a single token

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

{{% api-endpoint method="GET" endpoint="https://{{< influxdb/host >}}/api/v2/authorizations/{authID}" api-ref="/influxdb3/cloud-serverless/api/#operation/GetAuthorizationsID" %}}

Include the following in your request:

  • Headers:
    • Authorization: Token API_TOKEN (API token with the read: authorizations permission)
    • Content-type: application/json

{{% code-placeholders "(API|AUTHORIZATION)_(TOKEN|ID)" %}}

curl --request GET \
	"https://us-west-2-1.aws.{{< influxdb/host >}}/api/v2/authorizations/AUTHORIZATION_ID" \
  --header "Authorization: Token API_TOKEN" \
  --header 'Content-type: application/json'

{{% /code-placeholders %}}

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.

{{% code-placeholders "API_TOKEN" %}}

{{% get-shared-text "api/cloud-serverless/auth/tokens-view-filter.sh" %}}

{{% /code-placeholders %}}

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

{{% /tab-content %}}

{{< /tabs-wrapper >}}