docs-v2/content/influxdb/v2.0/security/tokens/create-token.md

3.7 KiB

title seotitle description aliases menu weight
Create a token Create an API token in InfluxDB Create an API token in InfluxDB using the InfluxDB UI, the `influx` CLI, or the InfluxDB API.
/influxdb/v2.0/users/tokens/create-token/
influxdb_2_0
name parent
Create a token Manage tokens
201

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

{{% note %}} Tokens are visible to the user who created the token. {{% oss-only %}} Users who own a token with Operator permissions also have access to all tokens. {{% /oss-only %}} Tokens stop working when the user who created the token is deleted. We recommend creating a generic user to create and manage tokens for writing data. {{% /note %}}

Create a token in the InfluxDB UI

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

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

  2. Click {{< icon "plus" "v2" >}} Generate and select a token type (Read/Write Token or All-Access Token).

  3. In the window that appears, enter a description for your token in the Description field.

  4. If generating a read/write token:

    • Search for and select buckets to read from in the Read pane.
    • Search for and select buckets to write to in the Write pane.
  5. Click Save.

Create a token using the influx CLI

Use the influx auth create command to create a token. Include flags with the command to grant specific permissions to the token. See the available flags. Only tokens with the write: authorizations permission can create tokens.

# Syntax
influx auth create -o <org-name> [permission-flags]

Examples

Create an All-Access token

Create an All-Access token to grant permissions to all resources in an organization.

influx auth create \
  --org my-org \
  --all-access

{{% oss-only %}}

Create an Operator token

Create an Operator token to grant permissions to all resources in all organizations.

influx auth create \
  --org my-org \
  --operator

{{% /oss-only %}}

Create a token with specified read permissions

influx auth create \
  --org my-org \
  --read-bucket 03a2bbf46309a000 \
  --read-bucket 3a87c03ace269000 \
  --read-dashboards \
  --read-tasks \
  --read-telegrafs \
  --read-user

See the influx auth create documentation for information about other available flags.

Create a token using the InfluxDB API

Use the /authorizations endpoint of the InfluxDB API to create a token.

{{% api-endpoint method="POST" endpoint="/api/v2/authorizations" %}}

Include the following in your request:

Requirement Include by
API token with the write: authorizations permission Use the Authorization: Token YOUR_API_TOKEN header.
Organization Pass as orgID in the request body.
Permissions list Pass as a permissions array in the request body.
{{% get-shared-text "api/v2.0/auth/oss/token-create.sh" %}}

Create a token scoped to a user

To scope a token to a user other than the token creator, pass userID in the request body.

{{% get-shared-text "api/v2.0/auth/oss/tokens-create-with-user.sh" %}}

See the POST /api/v2/authorizations documentation for more information about options.