Manage Users

Updated

Introduction

User is a standard construct that interacts with various touch-points within the system using unique accounts. A user often has a user account and is identified to the system by username. Individual users can be assigned one of the available roles so that they can perform specific activities through the ZEDEDA CLI or the ZEDEDA GUI. Currently, the ZEDEDA Cloud supports username/password-based logins, as well as OAuth schemes. All operations performed on the system are recorded against the user and captured in an audit trail.
 
User creation and deletion can be performed by someone with the corresponding CRUD access for the user permissions group. In ZEDEDA Cloud, the system admin can perform create, monitor, update, and remove operations with the user's permission.
 
Note: ZEDEDA will create only one user as part of the process of creating a new enterprise. 
For Azure accounts, there is no need to create a user.
 

Access ZEDEDA Cloud
 

ZEDEDA Cloud is one central control center for management and monitoring all your assets, applications, and resources. There are 2 ways to access ZEDEDA Cloud:
  • A command-line interface called ZEDEDA CLI, or "zCLI" is available as a Docker image. 
    For details on how to use the zCLI see zCLI Overview. 

Realms support on Sign-up page

Realms can be a domain or a sub-domain for enterprise users to log in (email/username). Multiple realms are supported currently. For example, the same enterprise can have user1@enterpriseA-dept1.com and user2@enterpriseA-dept2.com based logins supported even through SSO. After filling in all details, click on sign-up button.
 
Once a user is created, they can perform the following activities:
  • Activate
  • Deactivate
  • Delete
  • Reset Password

The user can also edit the first name, last name, email address, and the role to which they are assigned.

 

Change Password

Follow the procedure below to change your existing password. 
  1. Click on your User Profile at the top right corner.
  2. Hover on YOUR_NAME and select select Change Password.
  3. From the Change Password screen, enter the following:
    • Current Password: enter your current (old) password.
    • New Password: enter the new password you wish to change it to.
    • Confirm New Password: enter the new password a second time to confirm.
  4. ZEDEDA Cloud will send you an email to notify you that your password has been changed.
 

Forgot Password

If you have forgotten your password, you can use the Forgot Password workflow to reclaim your credentials. When you provide the username in the 'forgot password' screen, you will receive an email containing a reset link.
  1. Go to the ZEDEDA Cloud login page, for example: https://zedcontrol.zededa.net/login
  2. Enter your username in the field.
  3. Click the Forgot Password link under the Password field.
  4. Click the reCAPTCHA checkbox to confirm you are not a robot.
  5. Click Send Reset Instructions.
  6. Check your email for a reset link, and follow the instructions in that email to set a new password.
 

Reset Password

If you are not sure of your password, you can ask the system admin to reset the password on your behalf. You will receive an email containing a reset link. More details about the reset password are discussed under the Delete operation.
 

List View

After you log into the ZEDEDA GUI:
  1. Hover over Administration icon. 
  2. Select Users.
  3. Click the Expand icon at upper right to display the summary panel.

The Summary Panel displays information about the users in this enterprise, such as:

  • Sessions: The total number of users, as well as how many are active as opposed to offline.  
  • Status: The status of these users (for example, Active, Inactive, Suspended, etc.)
  • Top Active Users (24 Hours): This bar chart shows which enterprise users are the most active.
  • Hover your cursor over the "donut" icon to display the number of users in each distribution.

Detail View

To view a user's detailed view: 

  1. Click on any of the users that appear in List View. This displays a Detailed View for this user. 
    Detailed View displays the 'Basic Info' tab and 'Activity Logs' tab.
  2. The Basic Info tab is shown by default and contains information such as:
    • Identity section fields:
      • First Name: the user's first name
      • Last Name: user's last name
      • Profile Type: How the user authenticates (for example, 'Local' for passwords stored in ZEDEDA Cloud, or could also display a Single Sign-On provider)
      • Username: This is the unique identifier for the user to log into ZEDEDA Cloud
      • Email: User's primary email address for notifications and password resets
      • Mobile Number: User's phone number used for two-factor authentication (2FA)
      • Locale: User's preferred language and regional format for UI
      • Preferred Time Zone: Time zone used for all timestamps in the GUI for this user
      • Activated: A toggle to enable or disable the user's ability to log in
      • Created By: Audit field showing which administrator created this user's account
      • Created At: Audit field showing date and time the user's account was created
      • Last Updated By: Audit field showing which administrator last modified the account
      • Last Updated At: Audit field showing date and time the account was last modified
    • Role:
      • This displays the user's permission level within the system, such as SysAdmin (System Administrator), which grants broad access and control. 
        Note: For more details about roles and permissions, see Manage Roles. 
    • Notifications:
      • Email: This is the user's email setting, indicating whether it is enabled (Yes) or disabled (No) for sending system alerts to the user's registered email address.
      • Mobile: This is the user's mobile phone number setting, indicating whether it is enabled (Yes) or disabled (No) for sending system alerts to the user's mobile number, typically via SMS.
  3. Click the Activity Logs tab to display a list of events for this user. The following information is shown for user logs:
    • Date & Time: The exact date and timestamp when an event occurred.
    • Severity: The importance level of the log entry (for example, INFO, NOTICE, WARNING)
    • Edge Node: The specific edge node associated with an event, if applicable
    • Edge App Instance: The edge application running on the edge node that is related to the event
    • Project: The project that the logged event is associated with
    • Description: A detailed text summary of the specific action or event that was logged
 

User Operations from ZEDEDA GUI

The following user operations can be performed from the ZEDEDA GUI: 

 

Create

The create operation can be performed from the 'Users' list view:
  1. Select Administration > Users.
  2. Click the Add icon at upper right.
  3. Populate the input field values for the 'Identity' section with user-specific details.
  4. Select the Role you want to assign to this particular user. Various permissions for the selected role are displayed with the CRUD details.
  5. Click Add.
  6. When you click on the 'Add' button, the new user will be added to the user List View, and a toast message similar to the following appears:
    User: john@gmail.com has been added.

Filter and Search

After you have created a user, you can filter and search to find the account.

  1. Select Administration > Users.
  2. Click the Filter icon at upper right.
  3. Enter the user's Name or Email. 
  4. Click Apply.
  5. You will see the accounts that match the filter. 

Read

After you have created a user, you can view as a list or details.

  1. Select Administration > Users.
  2. This will display a list of available users who are already configured on the system.
  3. Click the name of any user from the List View to display a Detailed View for them.
  4. The read view shows the 'Basic Info' and 'Activity Logs' sections.
 

Basic Info

Identity

This section shows the details which are populated when a user is created under the 'create' operation.

 
Notification
The section shows the details about the mode of notification, either as an email or mobile, when a user is created using the 'create' operation.
 

Activity Logs

The Activity Logs capture the details (such as user login, date and time, severity, description, and so on), along with a summary of these entries. 
 

Update (Edit)

The update/edit operation can be performed from the user's detailed view. After you log into ZEDEDA, you can click on the Administration and select the user to modify their profile.
 

Basic Info

You can update (or edit) a user profile by following the procedure below:
  1. Select Administration > Users.
  2. Click the name of the user whose profile you want to update.
  3. Click the Edit icon at upper-right corner.
  4. The 'Basic Info' tab lets you update or edit some of the fields.
  5. In the 'Identity' section, update any of the following fields:
    • First Name
    • Last Name
    • Profile Type (Local or OAuth)
    • Email address
  6. In the 'Role' section, if you want to change the Role for this user, click into the field and select the desired Role (e.g., SysAdmin, SysManager, SysOperator).
  7. In the 'Notification' section, select the checkbox to enable notifications for either of these options:
    • Email
    • Mobile
  8. Click the Save button.
  9. When you click 'Save', a toast message similar to the following appears:
    User: john@gmail.com has been updated.
 

Delete

The delete operation can be performed from the user's detailed view after you log into the ZEDEDA Cloud. You can delete a user by following the procedure below:
 
  1. Select Administration > Users.
  2. Click the name of the user whose profile you want to update.
  3. Click the More icon at the top-right corner.
  4. From the drop-down menu, select Delete.
  5. Click the Confirm button on the modal dialogue which appears similar to that shown below: Deleting these 1 User(s) will permanently remove the data about these user(s) from management platform. Note: There is no way to reclaim the data after the delete operation is performed.
  6. When you click on the 'Confirm' button, a toast message similar to the following appears: 
    User: john@gmail.com has been deleted.
 

Reset Password

You can reset the password for a user by following the procedure below:
  1. Select Administration > Users.
  2. Click the name of the user for whom you wish to reset the password.
  3. Click the More icon at the top-right corner.
  4. From the drop-down, select Reset Password.
  5. Enter the desired password, and confirming it by entering the same password.
  6. Click the Reset Password button to confirm.
  7. When you click the 'Confirm' button, a toast message similar to the following appears: 
    Password for john@gmail.com was reset successfully!

     
Deactivate
You can temporarily deactivate a user by using the following procedure. If a user's account has been temporarily disabled, they will be unable to access ZEDEDA Cloud. Deactivating an account may be preferable to permanently deleting an account. 
  1. Select Administration > Users.
  2. Click the name of the user whose account you want to De-activate. This will temporarily disable the user’s access (without deleting their account), so they will be unable to log into ZEDEDA Cloud.
  3. Click the More icon at the top-right corner.
  4. From the drop-down, select Deactivate.
  5. Click the Confirm button on the modal dialogue.
  6. When you click on the 'Confirm' button, a toast message similar to the following appears: john@gmail.com was successfully deactivated.
 
Activate
If you deactivated an account, but later want to re-activate the account, you can do so as follows:
  1. Select Administration > Users.
  2. Click the name of the user for whom you wish to activate the user.
  3. Click the More icon at the top-right corner.
  4. From the dropdown, select Activate.
  5. When you click the 'Activate' button, a toast message similar to the following appears:
    john@gmail.com was successfully activated.
 
Note: Activate and Deactivate operations can be performed for multiple users from the user's list view.

Operations Using zCLI

To log into the ZEDEDA Cloud through the zCLI, see zCLI Overview.
 

Create

You can create a user with the following command:
zcli user create <name> [--password=<password> | --public-key-path=<pubkey> | --oauth] [--allowed-enterprise=<allowed-enterprise>...] --email=<email> [--firstname=<firstname>] [--lastname=<lastname>] [--locale=<locale>][--notify-pref=<notify-pref>...] [--phone=<phone>] [--time-zone=<time-zone>]
Example:
The following example shows how to use the --notify-pref parameter to get email or sms notifications about password expiration. To get both notifications, use the parameter twice. To get no notifications, don’t use the parameter (in which case, you only see the notification when you log into the GUI).
zcli user create ruskin@bond.com --email=ruskin@bond.com --firstname=Ruskin --lastname=Bond  --locale=EN --password=Abcd1234890@ --allowed-enterprise=foo --notify-pref=email --notify-pref=sms

 

View (Show)

You can use the following command to see the created user details:
zcli user show [[[<name>|--self | --uuid=<uuid>] [--detail]] | /
[[--salesforce-id=<sfdc-id>] [--hubspot-id=<hub-id>] [--name-pattern=<name-pattern>]]]
 
Example:
For example, the show command for the user displays the following output:
zcli user show
User                             Email                            FullName            Role
-------------------------------- -------------------------------- ------------------- ------------------------
admin@orangecorp-blr.com         admin@orangeCorp-blr.com         Admin               AAGFABCFc6p2XtZBGISdXrrSPmMm
john@gmail.com                   john@gmail.com                   John Doe            AAGFABAx0bu0T6ZKj7u0DDFyD7I0
ztest@orangecorp-blr.com         ztest@orangeCorp-blr.com         ztest ztest         AAGFABCFc6p2XtZBGISdXrrSPmMm

Total 3
zcli>
 

Show Active Users

You can use the following command to view the active users for a specified time.

zcli user show-active-users --starts=<datetime> --ends=<datetime> [--enterprise=<name>]

Example:

zcli user show-active-users --starts='2021-12-22 9:45:00' --ends='2021-12-22 12:53:00' --enterprise=dahl

Update (Edit)

You can update a user using the following command:
zcli user update [<name>|--self] [--firstname=<firstname>] /
[--lastname=<lastname>] [--locale=<locale>] [--salesforce-id=<sfdc-id>] /
[--hubspot-id=<hub-id>][--notify-pref=<notify-pref>...] [--phone=<phone>] /
[--time-zone=<time-zone>] [--email=<email>] [--allowed-enterprise=<allowed-enterprise>...]
 
Example:
zcli user update ruskin@bond.com --lastname=NEW_LAST_NAME
Example:
The following example shows how to update a user to give access to multiple enterprises. Note that you use the --allowed-enterprise parameter for each enterprise and you need to include the role for each enterprise. 
zcli user update ruskin@bond.com --allowed-enterprise=MY_ENT_A:MY_ROLE_A --allowed-enterprise=MY_ENT_B:MY_ROLE_B

 

Change Credential

You can change your own user credentials with the following command:

zcli user change-credential (--old-password=<old-password> /
--new-password=<new-password> | --new-public-key=<pubkey>)
Example:
zcli user change-credential --old-password=Test@123 --new-password=Test@456
 

Reset Credential

You can reset the user credentials with the following command:

zcli user reset-credential <name> (--new-password=<new-password> | --new-public-key=<pubkey>) [--enterprise=<enterprise>]
 
Example:
zcli user reset-credential ruskin@bond.com --new-password=Xyz@1234567 --enterprise=PlanetExplore
 

Deactivate

Rather than permanently deleting a user, you can temporarily deactivate with the following command:

zcli user deactivate <name>

Example:

zcli user deactivate ruskin@bond.com

Activate

After deactivating , you can activate with the following command:

zcli user activate <name>

Example:

zcli user activate ruskin@bond.com

Delete

You can delete a user with the following command:
zcli user delete <name> [-f]
 
Note: -f is to forcefully make the delete request to the ZEDEDA Cloud without prompting the user.
 
Example:
zcli user delete ruskin@bond.com -f
Was this article helpful?
0 out of 0 found this helpful