-
Notifications
You must be signed in to change notification settings - Fork 317
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
Merged
MeelahMe
merged 31 commits into
master
from
feature/cloud-dedicated-user-management-docs
Oct 20, 2025
Merged
Changes from 14 commits
Commits
Show all changes
31 commits
Select commit
Hold shift + click to select a range
14eee40
changing file name
MeelahMe 498e374
Merge branch 'master' into feature/cloud-dedicated-user-management-docs
MeelahMe db8f70a
adding intro and TOC
MeelahMe 8993037
adding content
MeelahMe 818efb6
Merge branch 'feature/cloud-dedicated-user-management-docs' of github…
MeelahMe 8b36a3c
revising index.md and updating content
MeelahMe 7e4e2e9
revising user management section in index.md
MeelahMe fad1866
docs: updates to admin-ui.md content
MeelahMe 635af32
Merge branch 'master' into feature/cloud-dedicated-user-management-docs
MeelahMe dde2854
Update content/influxdb3/cloud-dedicated/admin/users/_index.md
MeelahMe 526a098
Update content/influxdb3/cloud-dedicated/admin/users/admin-ui.md
MeelahMe 1390e5e
Merge branch 'master' into feature/cloud-dedicated-user-management-docs
MeelahMe 0c62fd2
fix: correct influxctl CLI reference URL in user management docs
MeelahMe 29eb2ce
fix: update to TOC
MeelahMe df51d8c
Update content/influxdb3/cloud-dedicated/admin/users/_index.md
MeelahMe 8e2e2ec
Update content/influxdb3/cloud-dedicated/admin/users/_index.md
MeelahMe 01bd7b2
Update content/influxdb3/cloud-dedicated/admin/users/admin-ui.md
MeelahMe 48f1e40
Update content/influxdb3/cloud-dedicated/admin/users/admin-ui.md
MeelahMe b3ab36e
Merge branch 'master' into feature/cloud-dedicated-user-management-docs
MeelahMe 6af3c72
Merge branch 'master' into feature/cloud-dedicated-user-management-docs
MeelahMe c498579
Adding an extra period at the end for a test
MeelahMe 72bea7e
Fix formatting of role permissions note
MeelahMe 98d0f29
Merge branch 'master' into feature/cloud-dedicated-user-management-docs
MeelahMe d72ab4b
Merge branch 'master' into feature/cloud-dedicated-user-management-docs
MeelahMe e871671
Merge branch 'master' into feature/cloud-dedicated-user-management-docs
MeelahMe cfe1d32
Merge branch 'master' into feature/cloud-dedicated-user-management-docs
jstirnaman 5afb288
updating broken link
MeelahMe 142b827
updating broken link in _index.md
MeelahMe d30ffb3
Merge branch 'master' into feature/cloud-dedicated-user-management-docs
MeelahMe c0cf22c
Merge branch 'master' into feature/cloud-dedicated-user-management-docs
MeelahMe d5a55be
Merge branch 'feature/cloud-dedicated-user-management-docs' of github…
MeelahMe File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
124 changes: 124 additions & 0 deletions
124
content/influxdb3/cloud-dedicated/admin/users/admin-ui.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| --- | ||
| 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: | ||
MeelahMe marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ### 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). | ||
| {{% /note %}} | ||
MeelahMe marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ## 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. | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.