Users reference
Overview
This reference guide includes detailed information about managing users and their devices, adding new users, and managing roles.
Users
To view users, sign in to the Code42 console, then go to Administration > Environment > Users. The Users table displays information about the users in your enterprise.
Incydr Professional, Enterprise, Horizon, and Gov F2
The Users table for Incydr Professional, Enterprise, Horizon, and Gov F2 displays the following users:
- Users in your organization with devices that are monitored by Code42. Generally, these users are automatically added to the Code42 console:
- By syncing with your organization's identity management provisioning provider.
- When the Code42 app installed on the endpoint successfully registers with the Code42 cloud.
- Administrative users that log into the Code42 console for management and monitoring tasks. You manually add these users to the Code42 console using the Organizations screens.
| Item | Description | |
|---|---|---|
| a | Create user | Displays a pane in which you enter information to add a user. |
| b | Export  |
Exports the current list of users to a CSV file.
For more information on the fields included in the export, see CSV export field descriptions. For definitions of user attributes, see the Users section in the Code42 Developer Portal. |
| c | Filter  |
Filters the list of users by the criteria you select. You can filter the list by username, organization, User UID, or user status. By default, the table displays only active users. |
| d | Filtered by | Identifies the filter used to display information in the table. Click the X to remove that filter. When you remove the last filter, the table displays all users. |
| e | Username | The Code42 username assigned to the user. |
| f | Name | The user's first and last name. If first and last names were not specified when the user was created, a dash appears here. |
| g | Status | The user's status. By default, the table displays only active users. Click Filter to view users that have different statuses. |
| h | View user details  |
Click to open the user's details to view more information about that user. |
Create user
To add a user to an organization manually, click Create user. The fields that appear depend on the settings of the organization you select. For example, if you select an organization that uses local authentication, the First name, Last name, and password fields appear. If you select an organization that uses single sign-on, only the Organization and Email address fields appear.
Filter the Users table
By default, the table displays only active users. To change the view:
- Click Filter .
- When the Filters panel opens, select the filters to use to display users in the table.
- Enter the first few characters of a username, then select the Username to view only that user.
Code42 displays users with first or last names that begin with the characters you enter. - Select the organization from the View organization list to view users in a specific organization.
- Enter the User UID to view only that user. (You can find user UIDs by clicking Export . )
- Select the Status of users to view: Any, Active, Deactivated, or Blocked.
- Enter the first few characters of a username, then select the Username to view only that user.
- Click Apply.
The table changes to list users according to the filters you selected.
View user details
Click any row in the Users table to view more details about that user.
| Item | Description | |
|---|---|---|
| a | User | Displays the user's first and last name, if available. If first and last names were not specified when the user was created, a dash appears here. Next to the user's name, Active, Deactivated, and Blocked appears to indicate the user's status. Blocked appears only for users who have been blocked via the API. |
| b | View profile | Click the link to view the user's profile. |
| c | Organization | Name of the organization to which the user has been assigned. Click the link to view that organization's details. |
| d | Actions |
Select the action you want to take on the user from the menu:
|
| e | Code42 username | The users' Code42 username. |
| f | Date created | The date the user was added to Code42. |
| g | Additional employee details | If you use User Directory Sync or SCIM provisioning, this information is automatically populated by your provisioning provider. You must first add the department and title attributes if you use Okta provisioning or PingOne provisioning. If you don't use provisioning, this information does not appear and cannot be added manually. |
| h | Data Sources |
The endpoints that have been assigned to the user and that are monitored by Code42. If devices are listed here, click Details to view that device's details.
For more information, see Add user data sources. |
| i | Roles |
The roles assigned to the user.
Click Edit |
| j | Reference | Notes about the user for reference. For more information, see Add reference information to devices, users, and organizations. |
to edit the user's roles, then select the roles to assign to that user and click Save. For more information, see Edit user account details
To edit a user's account, select Actions > Edit account details from the user's details screen. All users can edit their own account information, but only administrators with the correct permissions can edit another user's account details.
| Item | Description | |
|---|---|---|
| a | General information |
The user's First name, Last name, and Code42 username.
Some users cannot edit their Code42 username. This happens when both of the following are true:
When such users attempt to change their Code42 username, the "Unable to save changes. Try again." message appears. |
| b | Change password |
This section appears only for local users who authenticate directly against the Code42 platform directory when they sign into the Code42 console.
|
| c | Save | Click to save your changes |
Incydr Basic, Advanced, and Gov F1
| Item | Description | Click to view | |
|---|---|---|---|
| a | Active | Displays all active users. | |
| b | Deactivated | Displays all deactivated users. | |
| c | Invited | Displays users invited to create account, but not yet signed in. | |
| d | Action menu | Contains commands available in the user list view. | |
| e | Add a new user | Displays pane in which you enter information to add a user. | |
| f | Run a Device Report | Navigates to the Reporting web app, displaying results based the users listed. | |
| g | — | Selects all the users in the list. | |
| h | Name | User's first and last name. | Selected user's details |
| i | Username | User's username. | Selected user's details |
| j |
Backup Devices |
Number of devices registered to this user. Includes Code42 app devices. | Selected user's details |
| k | Used Storage | The amount of data this user has stored at all destinations. This information is refreshed at least once every 15 minutes. | List of all of the user's device archives and stats, by GUID |
Action menu
| Command | Description |
|---|---|
| Block | Signs out the selected user(s) from all devices and all current Code42 console sessions. Prevents future sign-in to all of the user's devices and the Code42 console. Incydr monitoring and backup continues and archives remain active and stored. Not available when the selected user is currently blocked. |
| Unblock | Unblock currently blocked users. Not available when the selected users are not blocked. |
| Reset Password |
Send an email containing a password reset link to the email address associated with the selected user(s).
Users in organizations where Client visibility is set to Hidden do not receive password reset emails. |
| Export All | Export selected item to CSV file. If no user is selected, all users in the list are exported. |
CSV export
Export all visible list items to a CSV file by selecting action menu > Export All. If no user is selected, all users in the list are exported.
For definitions of user attributes, see the Users section in the Code42 Developer Portal.
CSV export field descriptions
| Field | Description |
|---|---|
|
userId |
Identification number of the user. |
|
orgId |
Organization where the user resides. |
| username | Login name for the user. |
| Email address associated with the user's account. | |
| displayName | Name displayed in the Code42 console for the user. |
| status | Status of a user is active, blocked, or deactivated. |
| computerCount | Number of devices registered to the user. |
| shareDeviceCount | Number of SharePlan devices associated with the user. Deprecated—this information may no longer be accurate. |
| backupDeviceCount | Number of devices associated with the user. |
| lastLoginDate | Last time the user signed into the Code42 console. |
| active |
Indicates if the user is active. TRUE: Active FALSE: Deactivated |
| blocked |
Indicates if the user is blocked. TRUE: Blocked FALSE: Not blocked |
| warningCount | Number of user devices that have not backed up within the defined warning interval specified in the organization settings. |
| criticalCount | Number of user devices that have not backed up within the defined critical interval specified in the organization settings |
| targetComputer | Identification number for the device used for computer-to-computer backup. |
| selectedFiles | Total number of files selected for backup. |
| selectedBytes | |
| lastBackupDate | Date when any one of the user's devices backed up. |
| lastCompletedBackupDate | Date when any one of the user's devices had a 100% complete backup. |
| archiveBytes | |
| todoBytes | |
| todoFiles | |
| userUid | The user's UID (unique ID). |
| orgUid | The UID (unique ID) of the user's organization. |
| userExtRef | |
| notes | |
| firstName | The user's first name. |
| lastName | The user's last name. |
| orgName | The user's organization name. |
| orgType |
Organization type.
|
| authType | The authentication method for users in this organization (LOCAL, LDAP, RADIUS, or SSO). A blank value means the default of LOCAL. |
| usernameIAnEmail | Whether the username is an email. |
| creationDate | Organization creation date. |
| modificationDate | Date when the organization was last modified. |
| passwordReset | Whether a password reset is required. |
| invited | Whether the user was invited to Code42 via email. |
| securityKeyType | The type of security key for the user. |
| targetComputerGuid | GUID of the device used for computer-to-computer backup. Computer-to-computer backup is deprecated. |
| billableByes | Number of billable bytes. |
| quotaInBytes | User's backup quota in bytes. A value of -1 means unlimited backup. |
| percentComplete | Restore percent complete. |
| archiveBytesDelta | The difference, in bytes, between what has been backed up and what remains to be backed up. |
| archiveBytesDeltaMonth |
The difference, in bytes, in the archive from this month to the previous month. |
| archiveHistory | The number of archives for the user. |
| emailPromo | Whether the user receives promotional email. |
Add a new user
You can add users by sending an email invite, manually entering their information, or by importing user information.
| Command | Description |
|---|---|
| Invite Users | Send an invite to one or more users by sending an email invitation. |
| Add Users | Add or import users. |
Invite users
Use the Invite Users command to send an email invite to new users.
| Command | Description |
|---|---|
| a | Search for a specific organization within your environment |
| b | Select an organization for the user |
| c | Click to proceed or cancel |
When you click Select on the Invite User dialog, the following dialog is displayed:
| Item | Description |
|---|---|
| a | Enter email recipients for the invite email. |
| b | Modify the subject line for the email invite, if necessary. |
| c | Modify the default email message, if necessary. |
| d | Click to send email(s) or cancel. |
Add users
Use the Add a New User command to create a new user.
| Command | Description |
|---|---|
| a | Search for a specific organization within your environment |
| b | Select an organization for the user |
| c | Click to proceed or cancel |
When you click Select on the Add User dialog, the following dialog is displayed:
| Item | Description |
|---|---|
| a | Add users one by one. The Code42 app must be installed on each user's device(s) in order to back up. |
| b | Add users in bulk by uploading a text file (.CSV). |
| c | Download a sample text file for information on how to format the text file (.CSV). |
| d | Upload the text file (.CSV) containing the users you'd like to add. The desktop application must be installed on each user's device(s) in order to back up. |
Details
To view the user details, select a user from the overview. Here you can see information about a user's device.
| Item | Description | |
|---|---|---|
| a | User | Displays the user's first and last name, if available. If first and last names were not specified when creating the user, displays the user's username. |
| b | Organization | Name of the user's organization. Click to view organization details. |
| c | Action menu | Displays actions you can perform. |
| d | Email Address | Email address associated with the user's account. |
| e | Date Created | Date the user account was created. |
| f | Used Storage |
Amount of data stored from this user account's devices. Graph shows the past 30 days. Data points are updated once per day.
|
| g | Backup Restores |
Number of restores initiated, files restored, and total bytes restored over the past 30 days. These details are restricted by role: you can view only the restore history to which you have access based on your role permissions.
|
| h | Operating system | Operating system icon for this device. Displays Windows, Mac, or Linux. |
| i | Device name |
If the user has multiple devices, they all appear here. |
| j | Hostname |
|
| k | Destination | Name of the backup destination. |
| l | Selected | Size of the files selected for backup. |
| m |
Backup Status |
Backup completion percentage to each destination. Progress bar changes color if a device is in an alert state for that destination.
|
| n | Last Activity | Time since the last activity for the user's devices. |
| o | Completed | Time since the device last completed a backup to the specified destination. |
| p | Roles | Displays the roles assigned to the user. |
| q | Reference |
Displays optional information about the user. |
Action menu
| Command | Description |
|---|---|
| Edit | Edits this user's information, including name, email address, and password. |
| Show Deactivated Devices | Displays all of this user's deactivated devices. Not available when deactivated devices are displayed. |
| Hide Deactivated Devices | Hides this user's deactivated devices. Not available when deactivated devices are currently hidden. |
| View Archives | Opens the Archive List view, which displays information about the archives associated with this device. |
| Deactivate | Deactivates the user. All associated devices are deactivated. Incydr monitoring and backup stop. Archives for all associated devices are placed into cold storage. |
| Activate | Activates the user. You may also want to reactivate the user's devices. |
| Block | Blocks the user. User is signed out of all devices and all current Code42 console sessions. Prevents future sign in to all of the user's devices and the Code42 console. Incydr monitoring and backup continues. Not available when the selected user is currently blocked. |
| Unblock | Unblock currently blocked users. Not available when the selected users are not blocked. |
| Change Organization | Moves selected users to a different organization. |
| Reset Password |
Resets the selected user's password.
Users in organizations where Client visibility is set to Hidden do not receive password reset emails. |
| Reset Two-Factor Authentication | Resets the local two-factor authentication configuration for this user. This invalidates the secret used to generate this user's Time-based One-Time Password (TOTP). Select this option if a user loses or gets a new mobile device and needs to redo the initial configuration steps. |
Edit
General
| Item | Description | |
|---|---|---|
| a | First and Last Name | Edits the user's first or last name1 |
| b | Email Address | Edits the user's email address1 |
| c | Username | Edits the user's login name1 |
| d | Password | Changes the user's password1 |
| e | Backup Quota | Edits the user's storage quota |
1 Changing this field while the user is signed in to the Code42 console may require the user to sign in again.
Roles
| Item | Description | |
|---|---|---|
| a | Available Roles | Roles not currently assigned to the user. These roles are available to be assigned to the user by the admin that is currently logged in. Admins can only grant roles to users if the admin user account is assigned the role. Click a role to display the permissions associated with the selected role. |
| b | Current Roles | Roles currently assigned to the selected user. Click a role to display the permissions associated with the selected role. |
| c | Add Role | Adds the selected role(s) to the user account. |
| d | Remove Role | Removes the selected role(s) from the user account. |
| e | Currently Assigned Permissions OR Role's Permissions | When no role is selected, this field displays all permissions currently assigned to the user account. When a role is selected from Available Roles or Current Roles, this field displays all permissions associated with the selected role. |
| f | Cancel | Reverts changes and close the Edit User pane. |
| g | Update User | Saves changes and close the Edit User pane. |
Reference
| Item | Description | |
|---|---|---|
| a | External Reference | Specifies optional external reference information, such as a serial number, asset tag, employee ID, or help desk issue ID. |
| b | Notes | Specifies optional descriptive information. |
Change organization
| Item | Description | |
|---|---|---|
| a | Search | Searches available organizations |
| b | Organization | Selects the new parent organization |
If users are moved to a different organization, it could affect their backup. For example:
- Different destinations offered: If the new organization does not offer the same destinations as the user's previous organization, any of the user's data from destinations that are no longer offered are put in to cold storage.
- Frequency and version settings: Any differences in the new organization's frequency and version settings are applied to the backup archive after the user device connects to the Code42 cloud instance. Depending on the new organization's frequency and version settings, some data could be removed.
- Auto-start backups: If the new organization has any destinations configured to auto-start, the Code42 app begins backing up to those destinations immediately. Destinations that are not configured to auto-start appear in the Code42 app for the user to select.