2023-02-13 13:29:03 +01:00
---
2024-06-24 08:10:25 +02:00
weight: 6
2024-07-30 09:59:29 +02:00
title: User Management in VictoriaMetrics Cloud
2023-02-13 13:29:03 +01:00
menu:
docs:
2024-07-30 09:59:29 +02:00
parent: "cloud"
2024-06-24 08:10:25 +02:00
weight: 6
2024-09-20 16:16:25 +02:00
name: User Management
2023-05-01 12:19:31 +02:00
aliases:
2024-07-30 09:59:29 +02:00
- /victoriametrics-cloud/user-management/index.html
- /managed-victoriametrics/user-management/index.html
2023-02-13 13:29:03 +01:00
---
2024-07-30 09:59:29 +02:00
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.
2023-01-26 17:18:02 +01:00
The document covers the following topics
1. [User Roles ](#user-roles )
2023-07-26 23:39:35 +02:00
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 )
2023-01-26 17:18:02 +01:00
## User roles
2024-07-30 09:59:29 +02:00
VictoriaMetrics Cloud provides different levels of user access. It defines what information users can access and edit in your account.
2023-01-26 17:18:02 +01:00
You assign the role to the user during the user creation procedure. You can change the role after the creation
2023-05-29 22:35:05 +02:00
### Roles definition
2023-01-26 17:18:02 +01:00
2024-07-24 10:00:31 +02:00
< table class = "params" >
2023-01-26 17:18:02 +01:00
< tr >
< td > < strong > User Role< / strong > < / td >
< td > < strong > Categories< / strong > < / td >
< td > < strong > Description< / strong > < / td >
< / tr >
< tr >
2024-08-08 09:16:36 +02:00
< td rowspan = "7" > < strong > Admin< / strong > < / td >
2023-01-26 17:18:02 +01:00
< td > Deployments< / td >
< td >
Access to all deployments tabs and information
< p > Create, update and delete deployment< / p >
< / td >
< / tr >
< tr >
2024-08-08 09:16:36 +02:00
< td > Integrations< / td >
< td > Access to different integration configurations< / td >
< / tr >
< tr >
< td > Billing< / td >
2023-01-26 17:18:02 +01:00
< 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 >
2024-08-08 09:16:36 +02:00
< tr >
< td > API Keys< / td >
< td > Add, edit and delete API Keys< / td >
< / tr >
2023-01-26 17:18:02 +01:00
< 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 >
2023-05-29 22:35:05 +02:00
### User statuses
2023-01-26 17:18:02 +01:00
2024-07-24 10:00:31 +02:00
< table class = "params" >
2023-01-26 17:18:02 +01:00
< tr >
< td class = "highlight" > < strong class = "sr" > Active< / strong > < / td >
2024-07-30 09:59:29 +02:00
< td > The user can log in and use VictoriaMetrics Cloud. The user role defines the access level.< / td >
2023-01-26 17:18:02 +01:00
< / tr >
< tr >
< td class = "highlight" > < strong class = "s1" > Pending Invitation< / strong > < / td >
< td > An invitation was sent. The user must accept this.< / td >
< / tr >
2024-08-08 09:16:36 +02:00
< 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 >
2023-01-26 17:18:02 +01:00
< tr >
< td class = "highlight" > < strong class = "nn" > Inactive< / strong > < / td >
2024-07-30 09:59:29 +02:00
< 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 >
2023-01-26 17:18:02 +01:00
< / tr >
< / table >
## User list
It shows all users with different roles, and you can apply provided actions with them.
2024-07-24 10:00:31 +02:00
![User Management list ](user_management_list.webp )
2023-01-26 17:18:02 +01:00
In the table, there is additional information about the users:
2024-07-24 10:00:31 +02:00
< table class = "params" >
2023-01-26 17:18:02 +01:00
< 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 >
2024-08-08 09:16:36 +02:00
< tr >
< td > Created At:< / td >
< td > When user was created< / td >
< / tr >
2023-01-26 17:18:02 +01:00
< tr >
< td > Last Active:< / td >
< td > Last login date and time< / td >
< / tr >
< tr >
< td > Auth method:< / td >
2024-07-30 09:59:29 +02:00
< td > Auth options to login into the VictoriaMetrics Cloud< / td >
2023-01-26 17:18:02 +01:00
< / tr >
2024-08-08 09:16:36 +02:00
< tr >
< td > Actions:< / td >
< td > Actions to manipulate with users< / td >
< / tr >
2023-01-26 17:18:02 +01:00
< / table >
## How to Add User
2023-10-10 13:48:22 +02:00
Click on `Invite user` button
2023-01-26 17:18:02 +01:00
the user invitation button and fill out the form in the modal, which will appear after you click. All fields are mandatory.
2024-07-24 10:00:31 +02:00
![Invite user ](user_management_invite_user.webp )
2023-01-26 17:18:02 +01:00
2023-10-10 13:48:22 +02:00
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.
2023-01-26 17:18:02 +01:00
**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.
2024-01-27 19:08:07 +01:00
2024-07-24 10:00:31 +02:00
![Invite success ](user_management_invite_success.webp )
2024-01-27 19:08:07 +01:00
2023-01-26 17:18:02 +01:00
## How to Update User
2023-10-10 13:48:22 +02:00
To edit the user role and details, activate or deactivate a user, and click on
2023-01-26 17:18:02 +01:00
2024-01-27 19:08:07 +01:00
2024-07-24 10:00:31 +02:00
![Update user ](user_management_update_user.webp )
2024-01-27 19:08:07 +01:00
2024-08-08 09:16:36 +02:00
![Update user dropdown ](user_management_update_user_dropdown.webp )
2023-01-26 17:18:02 +01:00
User editing form:
2024-07-24 10:00:31 +02:00
![Update form ](user_management_user_update_form.webp )
2023-01-26 17:18:02 +01:00
2024-08-08 09:16:36 +02:00
To save changes, click the `Update` button. If changes are saved successfully, you will see a message at the top of the page.
2023-01-26 17:18:02 +01:00
2024-07-24 10:00:31 +02:00
![Updated success ](user_management_user_updated_success.webp )
2023-01-26 17:18:02 +01:00
## 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.
2023-10-10 13:48:22 +02:00
Click on `Delete` button to delete the user.
2023-01-26 17:18:02 +01:00
2024-07-24 10:00:31 +02:00
![User delete ](user_management_user_delete.webp )
2023-01-26 17:18:02 +01:00
2024-08-08 09:16:36 +02:00
To confirm the deletion of a user, you will need to re-enter their email address and press the **Confirm** button
2023-01-26 17:18:02 +01:00
2024-07-24 10:00:31 +02:00
![User delete form ](user_management_delete_user_form.webp )
2023-01-26 17:18:02 +01:00
2024-08-08 09:16:36 +02:00
If the user is deleted successfully, you will see a success message
2023-01-26 17:18:02 +01:00
2024-07-24 10:00:31 +02:00
![Delete success ](user_management_delete_success.webp )
2023-10-10 13:48:22 +02:00
## How to resend invitation
If the invitation is expired, it is possible to resend email to the user
Click `Resend invitation` button
2024-07-24 10:00:31 +02:00
![Resend invitation ](user_management_resend_invitation.webp )
2023-10-10 13:48:22 +02:00
2024-08-08 09:16:36 +02:00
Confirm resend invitation by clicking `Confirm` button in the modal dialog
2023-10-10 13:48:22 +02:00
2024-07-24 10:00:31 +02:00
![Confirm resend invitation ](user_management_confirm_resend_invitation.webp )
2023-10-10 13:48:22 +02:00
If invitation successfully resented to the user success message will appear
2024-07-24 10:00:31 +02:00
![Resend success ](user_management_resend_success.webp )