mirror of
https://github.com/VictoriaMetrics/VictoriaMetrics.git
synced 2024-11-21 14:44:00 +00:00
a2ecba4154
Signed-off-by: Artem Navoiev <tenmozes@gmail.com>
220 lines
6 KiB
Markdown
220 lines
6 KiB
Markdown
---
|
|
weight: 6
|
|
title: User Management in VictoriaMetrics Cloud
|
|
menu:
|
|
docs:
|
|
parent: "cloud"
|
|
weight: 6
|
|
name: User Management
|
|
aliases:
|
|
- /victoriametrics-cloud/user-management/index.html
|
|
- /managed-victoriametrics/user-management/index.html
|
|
---
|
|
The user management system enables admins to control user access and onboard and offboard users to the VictoriaMetrics Cloud. It organizes users according to their needs and role.
|
|
|
|
The document covers the following topics
|
|
1. [User Roles](#user-roles)
|
|
1. [User List](#user-list)
|
|
1. [How to Add User](#how-to-add-user)
|
|
1. [How to Update User](#how-to-update-user)
|
|
1. [How to Delete User](#how-to-delete-user)
|
|
|
|
## User roles
|
|
|
|
VictoriaMetrics Cloud provides different levels of user access. It defines what information users can access and edit in your account.
|
|
|
|
You assign the role to the user during the user creation procedure. You can change the role after the creation
|
|
|
|
|
|
### Roles definition
|
|
|
|
<table class="params">
|
|
<tr>
|
|
<td><strong>User Role</strong></td>
|
|
<td><strong>Categories</strong></td>
|
|
<td><strong>Description</strong></td>
|
|
</tr>
|
|
<tr>
|
|
<td rowspan="7" ><strong>Admin</strong></td>
|
|
<td>Deployments</td>
|
|
<td>
|
|
Access to all deployments tabs and information
|
|
<p>Create, update and delete deployment</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Integrations</td>
|
|
<td>Access to different integration configurations</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Billing</td>
|
|
<td>Check billing information</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Notifications</td>
|
|
<td>Create and update notifications</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Audit Logs</td>
|
|
<td>Can check all information in audit logs</td>
|
|
</tr>
|
|
<tr>
|
|
<td>User Management</td>
|
|
<td>Add, edit and delete users</td>
|
|
</tr>
|
|
<tr>
|
|
<td>API Keys</td>
|
|
<td>Add, edit and delete API Keys</td>
|
|
</tr>
|
|
<tr>
|
|
<td rowspan="3"><strong>Editor</strong></td>
|
|
<td>Deployments</td>
|
|
<td>
|
|
Access to all deployments tabs and information
|
|
<p>Create, update and delete deployment</p>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Notifications</td>
|
|
<td>Create and update notifications</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Audit Logs</td>
|
|
<td>Can check all information in audit logs</td>
|
|
</tr>
|
|
<tr>
|
|
<td><strong>Viewer</strong></td>
|
|
<td>Deployments</td>
|
|
<td>Access to Overview, Monitoring, Explore and Alerts deployments tabs and information</td>
|
|
</tr>
|
|
</table>
|
|
|
|
### User statuses
|
|
|
|
|
|
<table class="params">
|
|
<tr>
|
|
<td class="highlight"><strong class="sr">Active</strong></td>
|
|
<td>The user can log in and use VictoriaMetrics Cloud. The user role defines the access level.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="highlight"><strong class="s1">Pending Invitation</strong></td>
|
|
<td>An invitation was sent. The user must accept this.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="highlight"><strong class="s1">Expired Invitation</strong></td>
|
|
<td>An invitation was expired. The admin should resend invitation to the user.</td>
|
|
</tr>
|
|
<tr>
|
|
<td class="highlight"><strong class="nn">Inactive</strong></td>
|
|
<td>The user is registered in the VictoriaMetrics Cloud but has no access to perform any actions. Admin can activate or completely delete the user.</td>
|
|
</tr>
|
|
</table>
|
|
|
|
|
|
## User list
|
|
|
|
It shows all users with different roles, and you can apply provided actions with them.
|
|
|
|
![User Management list](user_management_list.webp)
|
|
|
|
In the table, there is additional information about the users:
|
|
|
|
|
|
<table class="params">
|
|
<tr>
|
|
<td>Email:</td>
|
|
<td>Registration user email</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Status:</td>
|
|
<td>Active, Inactive or Pending Invitation</td>
|
|
</tr>
|
|
<tr>
|
|
<td>User Role:</td>
|
|
<td>Admin, Editor or Viewer</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Created At:</td>
|
|
<td>When user was created</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Last Active:</td>
|
|
<td>Last login date and time</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Auth method:</td>
|
|
<td>Auth options to login into the VictoriaMetrics Cloud</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Actions:</td>
|
|
<td>Actions to manipulate with users</td>
|
|
</tr>
|
|
</table>
|
|
|
|
## How to Add User
|
|
|
|
Click on `Invite user` button
|
|
the user invitation button and fill out the form in the modal, which will appear after you click. All fields are mandatory.
|
|
|
|
![Invite user](user_management_invite_user.webp)
|
|
|
|
After filling out the form, click on the `Invite` button.
|
|
The user will be saved, and an invitation email to the provided email address will be sent. As a confirmation, you will see the success message.
|
|
|
|
**The invitation link is only active for 24 hours.**
|
|
|
|
The user will be at Pending Invitation status. After accepting the invitation user status changes to Active.
|
|
|
|
|
|
![Invite success](user_management_invite_success.webp)
|
|
|
|
|
|
## How to Update User
|
|
|
|
To edit the user role and details, activate or deactivate a user, and click on
|
|
|
|
|
|
![Update user](user_management_update_user.webp)
|
|
|
|
![Update user dropdown](user_management_update_user_dropdown.webp)
|
|
|
|
User editing form:
|
|
|
|
![Update form](user_management_user_update_form.webp)
|
|
|
|
To save changes, click the `Update` button. If changes are saved successfully, you will see a message at the top of the page.
|
|
|
|
![Updated success](user_management_user_updated_success.webp)
|
|
|
|
## How to Delete User
|
|
|
|
You can delete a user from your account. However, you will need to invite them again if you want to give them access.
|
|
|
|
Click on `Delete` button to delete the user.
|
|
|
|
![User delete](user_management_user_delete.webp)
|
|
|
|
To confirm the deletion of a user, you will need to re-enter their email address and press the **Confirm** button
|
|
|
|
![User delete form](user_management_delete_user_form.webp)
|
|
|
|
If the user is deleted successfully, you will see a success message
|
|
|
|
![Delete success](user_management_delete_success.webp)
|
|
|
|
## How to resend invitation
|
|
|
|
If the invitation is expired, it is possible to resend email to the user
|
|
|
|
Click `Resend invitation` button
|
|
|
|
![Resend invitation](user_management_resend_invitation.webp)
|
|
|
|
Confirm resend invitation by clicking `Confirm` button in the modal dialog
|
|
|
|
![Confirm resend invitation](user_management_confirm_resend_invitation.webp)
|
|
|
|
If invitation successfully resented to the user success message will appear
|
|
|
|
![Resend success](user_management_resend_success.webp)
|