added notes to influx cli commands that do not work with cloud, resolves influxdata/DAR#148
parent
afd6408725
commit
4b4dd77ba7
|
@ -1,7 +1,9 @@
|
||||||
---
|
---
|
||||||
title: Change your password
|
title: Change your password
|
||||||
seotitle: Change your password in InfluxDB
|
seotitle: Change your InfluxDB Cloud password
|
||||||
description: Change your password in InfluxDB using the influx CLI.
|
description: >
|
||||||
|
To update your InfluxDB Cloud password, Use the **forgot password** button on
|
||||||
|
the [InfluxDB Cloud login page](https://cloud2.influxdata.com/login).
|
||||||
menu:
|
menu:
|
||||||
influxdb_cloud:
|
influxdb_cloud:
|
||||||
name: Change your password
|
name: Change your password
|
||||||
|
@ -9,27 +11,10 @@ menu:
|
||||||
weight: 105
|
weight: 105
|
||||||
---
|
---
|
||||||
|
|
||||||
Use `influx` command line interface (CLI) to update your password.
|
To change or reset your InfluxDB Cloud password:
|
||||||
|
|
||||||
{{% note %}}
|
1. Use the **Forgot Password** button on the [InfluxDB Cloud login page](https://cloud2.influxdata.com/login).
|
||||||
User passwords cannot be updated in the InfluxDB UI.
|
2. Open the **InfluxCloud: Password Change Requested** email sent to the email
|
||||||
{{% /note %}}
|
address associated with your InfluxDB Cloud account, and then click the link
|
||||||
|
to choose a new password.
|
||||||
## Change your password using the influx CLI
|
3. Provide a new password and save.
|
||||||
|
|
||||||
Use the [`influx user password` command](/influxdb/cloud/reference/cli/influx/user/password)
|
|
||||||
to update a password for a user. To update a password, you need the following:
|
|
||||||
|
|
||||||
- Username or user ID _(provided in the output of `influx user list`)_
|
|
||||||
- New password
|
|
||||||
|
|
||||||
##### Update a password
|
|
||||||
```sh
|
|
||||||
# Syntax
|
|
||||||
influx user password -n <username>
|
|
||||||
|
|
||||||
# Example
|
|
||||||
influx user password -n johndoe
|
|
||||||
```
|
|
||||||
|
|
||||||
When prompted, enter and confirm the new password.
|
|
||||||
|
|
|
@ -12,11 +12,19 @@ aliases:
|
||||||
- /influxdb/v2.0/account-management/multi-user/invite-user/
|
- /influxdb/v2.0/account-management/multi-user/invite-user/
|
||||||
---
|
---
|
||||||
|
|
||||||
|
Use the InfluxDB Cloud user interface (UI) to invite users to collaborate in
|
||||||
|
your InfluxDB Cloud organization.
|
||||||
|
|
||||||
|
- [Invite a user](#invite-a-user)
|
||||||
|
- [Withdraw an invitation](#withdraw-an-invitation)
|
||||||
|
|
||||||
## Invite a user
|
## Invite a user
|
||||||
|
|
||||||
1. In the {{< cloud-name "short" >}} UI, select the user avatar in the left navigation menu, and select **Users**.
|
1. In the {{< cloud-name "short" >}} UI, click your user avatar in the left
|
||||||
|
navigation menu, and select **Users**.
|
||||||
|
|
||||||
{{< nav-icon "account" >}}
|
{{< nav-icon "account" >}}
|
||||||
|
|
||||||
2. Under **Add a new user to your organization**, enter the email address of the user to invite.
|
2. Under **Add a new user to your organization**, enter the email address of the user to invite.
|
||||||
(Users must be invited one at a time.)
|
(Users must be invited one at a time.)
|
||||||
3. Click **Add & Invite**.
|
3. Click **Add & Invite**.
|
||||||
|
@ -33,6 +41,7 @@ Accounts can have up to 50 pending invitations at one time.
|
||||||
1. In the {{< cloud-name "short" >}} UI, select the user avatar in the left navigation menu, and select **Users**.
|
1. In the {{< cloud-name "short" >}} UI, select the user avatar in the left navigation menu, and select **Users**.
|
||||||
|
|
||||||
{{< nav-icon "account" >}}
|
{{< nav-icon "account" >}}
|
||||||
|
|
||||||
2. Click the {{< icon "delete" >}} next to the invitation you want to withdraw.
|
2. Click the {{< icon "delete" >}} next to the invitation you want to withdraw.
|
||||||
3. Confirm the withdrawl.
|
3. Confirm the withdrawl.
|
||||||
|
|
||||||
|
|
|
@ -12,6 +12,11 @@ aliases:
|
||||||
- /influxdb/v2.0/account-management/multi-user/remove-user/
|
- /influxdb/v2.0/account-management/multi-user/remove-user/
|
||||||
---
|
---
|
||||||
|
|
||||||
1. Navigate to the **Users** page in the left navigation bar.
|
To remove a user from your InfluxDB Cloud organization:
|
||||||
|
|
||||||
|
1. Click your user avatar in the left navigation bar and select **Users**.
|
||||||
|
|
||||||
|
{{< nav-icon "account" >}}
|
||||||
|
|
||||||
2. Click the {{< icon "delete" >}} next to the user you want to remove.
|
2. Click the {{< icon "delete" >}} next to the user you want to remove.
|
||||||
3. Confirm the removal.
|
3. Confirm the removal.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: influx setup
|
title: influx setup
|
||||||
description: >
|
description: >
|
||||||
The `influx setup` command walks through the initial InfluxDB setup process,
|
The `influx setup` command walks through the initial InfluxDB OSS setup process,
|
||||||
creating a default user, organization, and bucket.
|
creating a default user, organization, and bucket.
|
||||||
menu:
|
menu:
|
||||||
influxdb_cloud_ref:
|
influxdb_cloud_ref:
|
||||||
|
@ -9,6 +9,13 @@ menu:
|
||||||
parent: influx
|
parent: influx
|
||||||
weight: 101
|
weight: 101
|
||||||
influxdb/cloud/tags: [get-started]
|
influxdb/cloud/tags: [get-started]
|
||||||
|
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/setup/
|
||||||
---
|
---
|
||||||
|
|
||||||
|
{{% cloud %}}
|
||||||
|
#### This command does not work with InfluxDB Cloud
|
||||||
|
The `influx setup` command **does not** work with **InfluxDB Cloud**.
|
||||||
|
It intiates the setup process for **InfluxDB OSS 2.x** instances only.
|
||||||
|
{{% /cloud %}}
|
||||||
|
|
||||||
{{< duplicate-oss >}}
|
{{< duplicate-oss >}}
|
||||||
|
|
|
@ -1,12 +1,20 @@
|
||||||
---
|
---
|
||||||
title: influx user
|
title: influx user
|
||||||
description: The `influx user` command and its subcommands manage user information in InfluxDB.
|
description: The `influx user` command and its subcommands manage user information in InfluxDB OSS.
|
||||||
menu:
|
menu:
|
||||||
influxdb_cloud_ref:
|
influxdb_cloud_ref:
|
||||||
name: influx user
|
name: influx user
|
||||||
parent: influx
|
parent: influx
|
||||||
weight: 101
|
weight: 101
|
||||||
influxdb/cloud/tags: [users]
|
influxdb/cloud/tags: [users]
|
||||||
|
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/
|
||||||
---
|
---
|
||||||
|
|
||||||
|
{{% cloud %}}
|
||||||
|
#### This command does not work with InfluxDB Cloud
|
||||||
|
The `influx user` command and its subcommands **do not** manage users in **InfluxDB Cloud**.
|
||||||
|
They manage **InfluxDB OSS 2.x** users only.
|
||||||
|
Use the InfluxDB Cloud user interface to manage account information.
|
||||||
|
{{% /cloud %}}
|
||||||
|
|
||||||
{{< duplicate-oss >}}
|
{{< duplicate-oss >}}
|
||||||
|
|
|
@ -1,11 +1,20 @@
|
||||||
---
|
---
|
||||||
title: influx user create
|
title: influx user create
|
||||||
description: The `influx user create` command creates a user in InfluxDB.
|
description: The `influx user create` command creates a user in InfluxDB OSS.
|
||||||
menu:
|
menu:
|
||||||
influxdb_cloud_ref:
|
influxdb_cloud_ref:
|
||||||
name: influx user create
|
name: influx user create
|
||||||
parent: influx user
|
parent: influx user
|
||||||
weight: 201
|
weight: 201
|
||||||
|
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/create/
|
||||||
---
|
---
|
||||||
|
|
||||||
|
{{% cloud %}}
|
||||||
|
#### This command does not work with InfluxDB Cloud
|
||||||
|
The `influx user create` command **does not** create users in **InfluxDB Cloud**.
|
||||||
|
It creates users in **InfluxDB OSS 2.x** only.
|
||||||
|
For information about inviting users into your InfluxDB Cloud organization, see
|
||||||
|
[Manage multiple users](/influxdb/cloud/account-management/multi-user/).
|
||||||
|
{{% /cloud %}}
|
||||||
|
|
||||||
{{< duplicate-oss >}}
|
{{< duplicate-oss >}}
|
||||||
|
|
|
@ -6,6 +6,15 @@ menu:
|
||||||
name: influx user delete
|
name: influx user delete
|
||||||
parent: influx user
|
parent: influx user
|
||||||
weight: 201
|
weight: 201
|
||||||
|
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/delete/
|
||||||
---
|
---
|
||||||
|
|
||||||
|
{{% cloud %}}
|
||||||
|
#### This command does not work with InfluxDB Cloud
|
||||||
|
The `influx user delete` command **does not** delete users from **InfluxDB Cloud**.
|
||||||
|
It deletes users from **InfluxDB OSS 2.x** only.
|
||||||
|
For information about removing a user from your InfluxDB Cloud organization, see
|
||||||
|
[Remove a user](/influxdb/cloud/account-management/multi-user/remove-user/).
|
||||||
|
{{% /cloud %}}
|
||||||
|
|
||||||
{{< duplicate-oss >}}
|
{{< duplicate-oss >}}
|
||||||
|
|
|
@ -8,6 +8,15 @@ menu:
|
||||||
weight: 201
|
weight: 201
|
||||||
aliases:
|
aliases:
|
||||||
- /influxdb/cloud/reference/cli/influx/user/find
|
- /influxdb/cloud/reference/cli/influx/user/find
|
||||||
|
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/list/
|
||||||
---
|
---
|
||||||
|
|
||||||
|
{{% cloud %}}
|
||||||
|
#### This command does not work with InfluxDB Cloud
|
||||||
|
The `influx user list` command **does not** list users in **InfluxDB Cloud**.
|
||||||
|
It lists users in **InfluxDB OSS 2.x** only.
|
||||||
|
For information about managing InfluxDB Cloud users, see
|
||||||
|
[Manage multiple users](/influxdb/cloud/account-management/multi-user/.)
|
||||||
|
{{% /cloud %}}
|
||||||
|
|
||||||
{{< duplicate-oss >}}
|
{{< duplicate-oss >}}
|
||||||
|
|
|
@ -7,7 +7,16 @@ menu:
|
||||||
parent: influx user
|
parent: influx user
|
||||||
weight: 201
|
weight: 201
|
||||||
related:
|
related:
|
||||||
- /influxdb/cloud/users/change-password/
|
- /influxdb/cloud/account-management/change-password/
|
||||||
|
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/password/
|
||||||
---
|
---
|
||||||
|
|
||||||
|
{{% cloud %}}
|
||||||
|
#### This command does not work with InfluxDB Cloud
|
||||||
|
The `influx user password` command **does not** update passwords for **InfluxDB Cloud** accounts.
|
||||||
|
It updates passwords for **InfluxDB OSS 2.x** users only.
|
||||||
|
To change your InfluxDB Cloud account password, see
|
||||||
|
[Change your password](/influxdb/cloud/account-management/change-password/).
|
||||||
|
{{% /cloud %}}
|
||||||
|
|
||||||
{{< duplicate-oss >}}
|
{{< duplicate-oss >}}
|
||||||
|
|
|
@ -7,6 +7,14 @@ menu:
|
||||||
name: influx user update
|
name: influx user update
|
||||||
parent: influx user
|
parent: influx user
|
||||||
weight: 201
|
weight: 201
|
||||||
|
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/update/
|
||||||
---
|
---
|
||||||
|
|
||||||
|
{{% cloud %}}
|
||||||
|
#### This command does not work with InfluxDB Cloud
|
||||||
|
The `influx user update` command **does not** update users in **InfluxDB Cloud**.
|
||||||
|
It updates users in **InfluxDB OSS 2.x** only.
|
||||||
|
Use the InfluxDB Cloud user interface to update account information.
|
||||||
|
{{% /cloud %}}
|
||||||
|
|
||||||
{{< duplicate-oss >}}
|
{{< duplicate-oss >}}
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: influx setup
|
title: influx setup
|
||||||
description: >
|
description: >
|
||||||
The `influx setup` command walks through the initial InfluxDB setup process,
|
The `influx setup` command walks through the initial InfluxDB OSS setup process,
|
||||||
creating a default user, organization, and bucket.
|
creating a default user, organization, and bucket.
|
||||||
menu:
|
menu:
|
||||||
influxdb_2_0_ref:
|
influxdb_2_0_ref:
|
||||||
|
@ -9,9 +9,10 @@ menu:
|
||||||
parent: influx
|
parent: influx
|
||||||
weight: 101
|
weight: 101
|
||||||
influxdb/v2.0/tags: [get-started]
|
influxdb/v2.0/tags: [get-started]
|
||||||
|
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/setup/
|
||||||
---
|
---
|
||||||
|
|
||||||
The `influx setup` command walks through the initial InfluxDB setup process,
|
The `influx setup` command walks through the initial InfluxDB OSS setup process,
|
||||||
creating a default user, organization, and bucket.
|
creating a default user, organization, and bucket.
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
|
@ -7,6 +7,7 @@ menu:
|
||||||
parent: influx
|
parent: influx
|
||||||
weight: 101
|
weight: 101
|
||||||
influxdb/v2.0/tags: [users]
|
influxdb/v2.0/tags: [users]
|
||||||
|
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/
|
||||||
---
|
---
|
||||||
|
|
||||||
The `influx user` command and its subcommands manage user information in InfluxDB.
|
The `influx user` command and its subcommands manage user information in InfluxDB.
|
||||||
|
|
|
@ -6,6 +6,7 @@ menu:
|
||||||
name: influx user create
|
name: influx user create
|
||||||
parent: influx user
|
parent: influx user
|
||||||
weight: 201
|
weight: 201
|
||||||
|
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/create/
|
||||||
---
|
---
|
||||||
|
|
||||||
The `influx user create` command creates a new user in InfluxDB.
|
The `influx user create` command creates a new user in InfluxDB.
|
||||||
|
|
|
@ -6,6 +6,7 @@ menu:
|
||||||
name: influx user delete
|
name: influx user delete
|
||||||
parent: influx user
|
parent: influx user
|
||||||
weight: 201
|
weight: 201
|
||||||
|
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/delete/
|
||||||
---
|
---
|
||||||
|
|
||||||
The `influx user delete` command deletes a specified user in InfluxDB.
|
The `influx user delete` command deletes a specified user in InfluxDB.
|
||||||
|
|
|
@ -8,6 +8,7 @@ menu:
|
||||||
weight: 201
|
weight: 201
|
||||||
aliases:
|
aliases:
|
||||||
- /influxdb/v2.0/reference/cli/influx/user/find
|
- /influxdb/v2.0/reference/cli/influx/user/find
|
||||||
|
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/list/
|
||||||
---
|
---
|
||||||
|
|
||||||
The `influx user list` command lists users in InfluxDB.
|
The `influx user list` command lists users in InfluxDB.
|
||||||
|
|
|
@ -8,6 +8,7 @@ menu:
|
||||||
weight: 201
|
weight: 201
|
||||||
related:
|
related:
|
||||||
- /influxdb/v2.0/users/change-password/
|
- /influxdb/v2.0/users/change-password/
|
||||||
|
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/password/
|
||||||
---
|
---
|
||||||
|
|
||||||
The `influx user password` command updates the password for a user in InfluxDB.
|
The `influx user password` command updates the password for a user in InfluxDB.
|
||||||
|
|
|
@ -7,6 +7,7 @@ menu:
|
||||||
name: influx user update
|
name: influx user update
|
||||||
parent: influx user
|
parent: influx user
|
||||||
weight: 201
|
weight: 201
|
||||||
|
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/update/
|
||||||
---
|
---
|
||||||
|
|
||||||
The `influx user update` command updates information related to a user in InfluxDB.
|
The `influx user update` command updates information related to a user in InfluxDB.
|
||||||
|
|
Loading…
Reference in New Issue