Merge pull request #690 from influxdata/org/member-management
User, org, and member management updatespull/693/head
Scott Anderson
GitHub
commit
4f1d048cc0
|
|
@ -7,25 +7,39 @@ menu:
|
|||
name: Remove a member
|
||||
parent: Manage members
|
||||
weight: 203
|
||||
draft: true
|
||||
---
|
||||
|
||||
Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI)
|
||||
to remove a member from an organization.
|
||||
|
||||
{{% note %}}
|
||||
Removing a member from an organization removes all permissions associated with the organization,
|
||||
but it does not delete the user from the system entirely.
|
||||
For information about deleting a user from InfluxDB, see [Delete a user](/v2.0/users/delete-user/).
|
||||
{{% /note %}}
|
||||
|
||||
## Remove a member from an organization in the InfluxDB UI
|
||||
|
||||
1. Click the **Settings** tab in the navigation bar.
|
||||
1. Click **Settings** in the left navigation bar.
|
||||
|
||||
{{< nav-icon "settings" >}}
|
||||
|
||||
2. Select the **Members** tab.
|
||||
|
||||
_Complete content coming soon_
|
||||
2. Select **Members**.
|
||||
3. Hover over the member you would like to delete and click the **{{< icon "delete" >}}** icon.
|
||||
4. Click **Delete**.
|
||||
|
||||
## Remove a member from an organization using the influx CLI
|
||||
|
||||
Use the [`influx org members add` command](/v2.0/reference/cli/influx/org/members/add)
|
||||
Use the [`influx org members remove` command](/v2.0/reference/cli/influx/org/members/remove)
|
||||
to remove a member from an organization. Removing a member requires the following:
|
||||
|
||||
_Complete content coming soon_
|
||||
- The organization name or ID _(provided in the output of [`influx org find`](/v2.0/reference/cli/influx/org/find/))_
|
||||
- The member ID _(provided in the output of [`influx org members list`](/v2.0/reference/cli/influx/org/members/list/))_
|
||||
|
||||
```sh
|
||||
# Pattern
|
||||
influx org members remove -o <member-id> -i <organization-id>
|
||||
|
||||
# Example
|
||||
influx org members remove -o 00xXx0x00xXX0000 -i x0xXXXx00x0x000X
|
||||
```
|
||||
|
|
|
|||
|
|
@ -16,11 +16,12 @@ influx user create [flags]
|
|||
```
|
||||
|
||||
## Flags
|
||||
| Flag | Description | Input type |
|
||||
|:---- |:----------- |:----------: |
|
||||
| `-h`, `--help` | Help for `create` | |
|
||||
| `-n`, `--name` | The user name **(Required)** | string |
|
||||
| `-o`, `--org-id` | The organization ID to add the user to<br/> _(Required if password is provided)_ | string |
|
||||
| `-p`, `--password` | The user password | string |
|
||||
| Flag | Description | Input type |
|
||||
|:---- |:----------- |:----------: |
|
||||
| `-h`, `--help` | Help for `create` | |
|
||||
| `-n`, `--name` | The username **(Required)** | string |
|
||||
| `-o`, `--org` | The name of the organization to add the user to | string |
|
||||
| `--org-id` | The ID of the organization to add the user to | string |
|
||||
| `-p`, `--password` | The user password | string |
|
||||
|
||||
{{% influx-cli-global-flags %}}
|
||||
|
|
|
|||
|
|
@ -20,6 +20,6 @@ influx user find [flags]
|
|||
|:---- |:----------- |:----------: |
|
||||
| `-h`, `--help` | Help for `find` | |
|
||||
| `-i`, `--id` | The user ID | string |
|
||||
| `-n`, `--name` | The user name | string |
|
||||
| `-n`, `--name` | The username | string |
|
||||
|
||||
{{% influx-cli-global-flags %}}
|
||||
|
|
|
|||
|
|
@ -21,6 +21,6 @@ influx user update [flags]
|
|||
|:---- |:----------- |:----------: |
|
||||
| `-h`, `--help` | Help for `update` | |
|
||||
| `-i`, `--id` | The user ID **(Required)** | string |
|
||||
| `-n`, `--name` | The user name | string |
|
||||
| `-n`, `--name` | The username | string |
|
||||
|
||||
{{% influx-cli-global-flags %}}
|
||||
|
|
|
|||
|
|
@ -15,35 +15,39 @@ to create a user.
|
|||
## Create a user in the InfluxDB UI
|
||||
|
||||
{{% note %}}
|
||||
While in alpha, additional users cannot be created in the InfluxDB UI.
|
||||
Currently, additional users cannot be created in the InfluxDB UI.
|
||||
{{% /note %}}
|
||||
|
||||
## Create a user using the influx CLI
|
||||
|
||||
Use the [`influx user create` command](/v2.0/reference/cli/influx/user/create)
|
||||
to create a new user. A new user requires the following:
|
||||
To create a new user, use the [`influx user create` command](/v2.0/reference/cli/influx/user/create)
|
||||
and include the following:
|
||||
|
||||
- A username
|
||||
- Username
|
||||
- Organization name or organization ID to add the user to _(provided in the output of
|
||||
[`influx org find`](/v2.0/reference/cli/influx/org/find/))_
|
||||
|
||||
```sh
|
||||
# Pattern
|
||||
influx user create -n <username>
|
||||
influx user create -n <username> -o <org-name>
|
||||
|
||||
# Example
|
||||
influx user create -n johndoe
|
||||
influx user create -n johndoe -o example-org
|
||||
```
|
||||
|
||||
### Create a user with a password and organization
|
||||
To create a new user with a password and add the user as a member of an organization,
|
||||
include a password and organization ID with the `influx user create` command.
|
||||
|
||||
_Use the [`influx org find` command](/v2.0/reference/cli/influx/org/find/)
|
||||
to retrieve your organization ID._
|
||||
- Username
|
||||
- Organization name or organization ID to add the user to _(provided in the output of
|
||||
[`influx org find`](/v2.0/reference/cli/influx/org/find/))_
|
||||
- Password
|
||||
|
||||
```sh
|
||||
# Pattern
|
||||
influx user create -n <username> -p <password> -o <org-id>
|
||||
influx user create -n <username> -p <password> -o <org-name>
|
||||
|
||||
# Example
|
||||
influx user create -n johndoe -p PaSsWoRd -o 0o0x00o0x0000oo0
|
||||
influx user create -n johndoe -p PaSsWoRd -o example-org
|
||||
```
|
||||
|
|
|
|||
|
|
@ -10,12 +10,18 @@ weight: 103
|
|||
---
|
||||
|
||||
Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI)
|
||||
to create a user.
|
||||
to delete a user.
|
||||
|
||||
{{% warn %}}
|
||||
Deleting a user removes them completely from InfluxDB.
|
||||
To remove a user from an organization without deleting the user entirely, see
|
||||
[Remove a member from an organization](/v2.0/org/members/remove/).
|
||||
{{% /warn %}}
|
||||
|
||||
## Delete a user from the InfluxDB UI
|
||||
|
||||
{{% note %}}
|
||||
While in alpha, users cannot be deleted from the InfluxDB UI.
|
||||
Currently, users cannot be deleted from the InfluxDB UI.
|
||||
{{% /note %}}
|
||||
|
||||
## Delete a user using the influx CLI
|
||||
|
|
|
|||
Loading…
Reference in New Issue