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/update-tokens.md

5.0 KiB
Raw Permalink Blame History

title seotitle description menu weight
Update a token Update API tokens in InfluxDB Update API tokens' descriptions in InfluxDB using the InfluxDB UI.
influxdb3_cloud_serverless
name parent
Update a token Manage tokens
203

Update an API token's description and status using the InfluxDB user interface (UI), influx CLI, or InfluxDB API.

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

{{% tab-content %}}

Update a token in the InfluxDB UI

To update tokens in the InfluxDB UI, navigate to the API Tokens management page. In the navigation menu on the left, select Load Data > API Tokens.

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

Update a token's description

  1. On the token management page, click the pencil icon ({{< icon "pencil" >}}) next to the token's description.
  2. Update the token description, and then click anywhere else to save.

Enable or disable a token in the InfluxDB UI

  1. On the token management page, find the token that you would like to enable or disable.
  2. Click the token description.
  3. Click the {{< icon "toggle-blue" >}} Active toggle.

{{% /tab-content %}}

{{% tab-content %}}

Enable a token using the influx CLI

Use the influx auth active command to activate a token.

Provide the following flags:

  • --token: API token with permission to update authorizations
  • --id: Authorization ID to enable (available in the output of influx auth list)

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

influx auth active \
  --token API_TOKEN \
  --id AUTHORIZATION_ID

{{% /code-placeholders %}}

Disable a token using the influx CLI

Use the influx auth inactive command to deactivate a token.

Provide the following flags:

  • --token: API token with permission to update authorizations
  • --id: Authorization ID to disable (available in the output of influx auth list)

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

influx auth inactive \
  --token API_TOKEN \
  --id AUTHORIZATION_ID

{{% /code-placeholders %}}

{{% /tab-content %}}

{{% tab-content %}}

Update a token using the InfluxDB API

Use the /api/v2/authorizations InfluxDB API endpoint to update the description and status of a token.

{{< api-endpoint method="PATCH" endpoint="https://{{< influxdb/host >}}/api/v2/authorizations/{AUTH_ID}" api-ref="/influxdb/v2/api/#operation/PatchAuthorizationsID" >}}

Include the following in your request:

  • Headers:
    • Authorization: Token API_TOKEN (API token with the write: authorizations permission)
    • Content-type: application/json
  • Path parameters:
    • authID: Authorization ID to update
  • Request body: JSON object with authorization properties to update

Disable a token

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

# Update the description and status of the first authorization listed for the user.

curl --request GET \
  https://{{< influxdb/host >}}/api/v2/authorizations?user=user2 \
  --header "Authorization: Token API_TOKEN" \
  --header 'Content-type: application/json' \
| jq .authorizations[0].id \
| xargs -I authid curl --request PATCH \
  https://{{< influxdb/host >}}/api/v2/authorizations/authid \
  --header "Authorization: Token API_TOKEN" \
  --header 'Content-type: application/json' \
  --data '{
            "description": "deactivated_auth",
            "status": "inactive"
          }' | jq .

{{% /code-placeholders %}}

{{% /tab-content %}}

{{< /tabs-wrapper >}}