-
Notifications
You must be signed in to change notification settings - Fork 313
feat: add user management documentation for InfluxDB Cloud Dedicated Admin UI #6331
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
14eee40
498e374
db8f70a
8993037
818efb6
8b36a3c
7e4e2e9
fad1866
635af32
dde2854
526a098
1390e5e
0c62fd2
29eb2ce
df51d8c
8e2e2ec
01bd7b2
48f1e40
b3ab36e
6af3c72
c498579
72bea7e
98d0f29
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,125 @@ | ||||||||||||||||||||||||
--- | ||||||||||||||||||||||||
title: Manage users in the Admin UI | ||||||||||||||||||||||||
seotitle: Manage users in InfluxDB Cloud Dedicated Admin UI | ||||||||||||||||||||||||
description: > | ||||||||||||||||||||||||
Use the InfluxDB Cloud Dedicated Admin UI to view users, send invitations, assign roles, | ||||||||||||||||||||||||
and manage user access to your cluster. Learn how to invite new users, revoke invitations, | ||||||||||||||||||||||||
and understand role-based permissions. | ||||||||||||||||||||||||
menu: | ||||||||||||||||||||||||
influxdb3_cloud_dedicated: | ||||||||||||||||||||||||
parent: Manage users | ||||||||||||||||||||||||
name: Admin UI | ||||||||||||||||||||||||
weight: 201 | ||||||||||||||||||||||||
influxdb3/cloud-dedicated/tags: [users, admin ui, invitations, roles] | ||||||||||||||||||||||||
related: | ||||||||||||||||||||||||
- /influxdb3/cloud-dedicated/admin/users/ | ||||||||||||||||||||||||
- /influxdb3/cloud-dedicated/reference/internals/security/ | ||||||||||||||||||||||||
- /influxdb3/cloud-dedicated/admin/tokens/ | ||||||||||||||||||||||||
--- | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
Use the {{% product-name %}} Admin UI to manage users and control access to your cluster through a web-based interface. The Admin UI provides self-service user management capabilities, allowing administrators to invite new users, assign roles, and manage invitations without contacting support. | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
- [Access the Users page](#access-the-users-page) | ||||||||||||||||||||||||
- [View existing users](#view-existing-users) | ||||||||||||||||||||||||
- [Invite a user](#invite-a-user) | ||||||||||||||||||||||||
- [Manage invitations](#manage-invitations) | ||||||||||||||||||||||||
- [User roles and permissions](#user-roles-and-permissions) | ||||||||||||||||||||||||
- [Limitations](#limitations) | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
## Access the Users page | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
1. Access the {{% product-name %}} Admin UI at [console.influxdata.com](https://console.influxdata.com). | ||||||||||||||||||||||||
If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). | ||||||||||||||||||||||||
2. Log in using the credentials provided by InfluxData. | ||||||||||||||||||||||||
3. From the Account Management portal, select your cluster. | ||||||||||||||||||||||||
4. In the cluster resource management view, click **Users** in the navigation. | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
The Users page displays your account information and a table of existing users and invitations. | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
## View existing users | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
The Users page shows a comprehensive view of all users and pending invitations for your account: | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
- **Invite ID**: Unique identifier for each user invitation | ||||||||||||||||||||||||
- **Email**: Email address of the invited or existing user | ||||||||||||||||||||||||
- **Invited At**: Date and time when the invitation was sent | ||||||||||||||||||||||||
- **Status**: Current status of the invitation | ||||||||||||||||||||||||
- `accepted`: User has accepted the invitation and has access to the cluster | ||||||||||||||||||||||||
- `expired`: Invitation has expired and is no longer valid | ||||||||||||||||||||||||
- `revoked`: Invitation has been manually revoked by an administrator | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
Use the search functionality to quickly find specific users by email address or invitation details. | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
## Invite a user | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
Only users with the **Admin** role can send new invitations. | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
1. On the Users page, click **{{< icon "plus" >}} Invite Users**. | ||||||||||||||||||||||||
2. In the **Invite User** dialog: | ||||||||||||||||||||||||
- Enter the **email address** of the user you want to invite | ||||||||||||||||||||||||
- Select the appropriate **role** from the dropdown menu: | ||||||||||||||||||||||||
- **Admin**: Full read and write permissions on all resources | ||||||||||||||||||||||||
- **Member**: Read permission on certain resources and create permission for database tokens | ||||||||||||||||||||||||
- **Auditor**: Read permission on all resources without modification capabilities | ||||||||||||||||||||||||
3. Click **Send Invitation**. | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
An invitation email with an activation link is sent to the specified email address. The user must accept the invitation to gain access to your {{% product-name %}} cluster. | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
{{% note %}} | ||||||||||||||||||||||||
#### Invitation expiration | ||||||||||||||||||||||||
Invitations expire after a set period. If an invitation expires, you'll need to send a new invitation to the user. | ||||||||||||||||||||||||
{{% /note %}} | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
## Manage invitations | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
### Revoke an invitation | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
You can revoke pending invitations that haven't been accepted yet: | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
1. In the Users table, locate the invitation you want to revoke. | ||||||||||||||||||||||||
2. Click the **Actions** menu (⋮) for that invitation. | ||||||||||||||||||||||||
3. Select **Revoke Invitation**. | ||||||||||||||||||||||||
4. Confirm the revocation when prompted. | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
Revoked invitations can no longer be used to access your cluster. The invitation status will change to `revoked`. | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
### View invitation details | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
Click on any invitation in the table to view additional details, including: | ||||||||||||||||||||||||
- Complete invitation ID | ||||||||||||||||||||||||
- Exact timestamp of invitation creation | ||||||||||||||||||||||||
- Current status and any status changes | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
## User roles and permissions | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
{{% product-name %}} uses role-based access control to manage user permissions for the following roles: | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
### Admin | ||||||||||||||||||||||||
- Full read and write permissions on all cluster resources | ||||||||||||||||||||||||
- Can create and delete databases, tables, and tokens | ||||||||||||||||||||||||
- Can send and revoke user invitations | ||||||||||||||||||||||||
- Can manage all aspects of cluster administration | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
### Member | ||||||||||||||||||||||||
- Read permission on databases and certain cluster resources | ||||||||||||||||||||||||
- Can create database tokens for data access | ||||||||||||||||||||||||
- Cannot delete or create databases | ||||||||||||||||||||||||
- Cannot manage other users or send invitations | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
### Auditor | ||||||||||||||||||||||||
- Read-only access to all cluster resources | ||||||||||||||||||||||||
- Can view databases, tables, and configuration | ||||||||||||||||||||||||
- Can see user invitations but cannot create or revoke them | ||||||||||||||||||||||||
- Cannot modify any resources or create tokens | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
> [!Note] | ||||||||||||||||||||||||
> #### Role assignment | ||||||||||||||||||||||||
> | ||||||||||||||||||||||||
> User roles are assigned when sending invitations and cannot currently be changed through the Admin UI. | ||||||||||||||||||||||||
> To modify a user's role, [contact InfluxData support](https://support.influxdata.com). | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
Comment on lines
+115
to
+120
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The note block uses GitHub-style alert syntax
Suggested change
Copilot uses AI. Check for mistakes. Positive FeedbackNegative Feedback |
||||||||||||||||||||||||
## Limitations | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
- **Historical records**: Invitation records remain even after user removal; use the [`influxctl users list`](https://docs.influxdata.com/influxdb3/cloud-dedicated/reference/influxctl/#list-users) command to confirm current users | ||||||||||||||||||||||||
|
||||||||||||||||||||||||
For operations not available in the Admin UI, contact [InfluxData support](https://support.influxdata.com) for role changes, user removal, or other advanced user management tasks. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The note block uses GitHub-style alert syntax
> [!Note]
instead of the Hugo shortcode format used elsewhere in the documentation. This should be consistent with the Hugo shortcode format:{{% note %}}
and{{% /note %}}
.Copilot uses AI. Check for mistakes.