Skip to content

User Management


Overview

This topic describes how you may manage users and grant them different level of access to CloudAEye services.

Tenant administrators control who can be authenticated (signed in) and authorized (have permissions) to use CloudAEye SaaS services.

Groups

Group Name Priviledges
TenantAdminGroup Root users for your CloudAEye SaS account. A minimum of 1 user is required
TenantUserGroup Provisoned user who is not granted any acceess yet
LogsServiceAdminGroup Users who are granted administrative access to Logs and Logs Analyzer services
LogsServiceUserGroup Users who are granted view access to Logs and Logs Analyzer services
MetricsServiceAdminGroup Users who are granted administrative access to Metrics and Metrics Analyzer services
MetricsServiceUserGroup Users who are granted view access to Metrics and Metrics Analyzer services
DashboardsServiceAdminGroup Users who are granted administrative access to Dashboards (Grafana) Service
DashboardsServiceUserGroup Users who are granted view access to Dashboards (Grafana) Service

Operations

The operations are organized into two buckets:

  • users - For managing users in the system
  • groups - For managing group memberships of the users who are in the system

Manage Users

If you want to register, update, get the details, remove or find out the current group membership of a user, you may use caeops users command. Here are all the available operations for managing users.

Task Command Name
Register a new user caeops users register
List all registered users caeops users list
Get details of a specific user caeops users get
Update a user caeops users update
Delete a user caeops users delete
List the groups a user is part of caeops users list-groups

Example: Register a New User

Here is an example of how to register a new user.

Select Users > Users from the left navigation. A list of existing users under Users / List will be shown.

To add a new user to the system, click CREATE on the top right corner. A new form will be shown.

Fill out the following information for the person being added:

  • Email Address - Work email address of the person.
  • Name - Name of the person.
  • Phone number - Phone number of the person.
  • LinkedIn url - LinkedIn profile url of the person.
  • Gender - Select the gender of the person from the drop-down menu.
  • Address - Mailing address of the person.
  • Department - Name of the department or organization of the person.
  • Job Title - Job title of the person at work.
  • Birthdte - Date of birth of the person.

Click REGISTER button to add the person to the system. An email will be sent to the email address with a temporary password.

caeops users register --email=demouser1@cloudaeye.com --given-name=Demo --family-name=User1 --phone-number=+911111111111

Output shows details of the newly added user. 
{
   "email": "maruti1@cloudaeye.com",
   "givenName": "Demo",
   "familyName": "User1",
   "linkedinUrl": "",
   "picture": "",
   "phoneNumber": "+911111111111",
   "roles": [
     "tenantUser"
   ],
   "createdAt": 1629944781663,
   "updatedAt": 1629944781663
 }

List All Users

Select Users > Users from the left navigation. A list of existing users under Users / List will be shown.

caeops users list

Output:
[
  {
    "email": "bhavya@cloudaeye.com",
    "givenName": "Bhavya",
    "familyName": "Latha",
    "linkedinUrl": "",
    "picture": "",
    "phoneNumber": "+919437062557",
    "roles": [
      "tenantAdmin"
    ],
    "createdAt": 1629522299148,
    "updatedAt": 1629523528644
  },
  {
    "email": "piyush@cloudaeye.com",
    "givenName": "Piyush",
    "familyName": "Kumar",
    "linkedinUrl": "",
    "picture": "xyz",
    "phoneNumber": "+919879188114",
    "roles": [
      "tenantUser"
    ],
    "createdAt": 1629692098084,
    "updatedAt": 1629692349180
  },
  {
    "email": "nazrul@cloudaeye.com",
    "givenName": "Nazrul",
    "familyName": "Islam",
    "linkedinUrl": "",
    "picture": "",
    "phoneNumber": "+911224411561",
    "roles": [
      "tenantUser"
    ],
    "createdAt": 1629944781663,
    "updatedAt": 1629944781663
  }
]

Manage Access

To manage user's group membership, you may use caeops groups command. Here are all the available operations for managing access priviledges.

Task Command Name
List all available groups caeops groups list
List all users for a specific group caeops groups list-users
Add user to a group caeops groups add-user
Remove user from a group caeops groups remove-user

Example: Add User to a Group

caeops groups add-users --group-name democloudaeyeLogsServiceAdminGroup --email=demouser1@cloudaeye.com
Note: Name of the account (in the above example, democloudaeye) is added to the group names to make them unique.

Example: List Users of a Group

caeops groups list-users --group-name democloudaeyeLogsServiceAdminGroup