This guide will teach you how to import data from a ".csv" file in Clarity Security. This is useful for loading new data or providing updates to data sets for applications that do not exist
Estimated time to complete: 10 minutes
If you run into any problems, please contact your support team or email@example.com.
Before You Begin
To successfully import data from a .csv into Clarity Security, you'll need the following pre-requisites before you begin:
- Properly formatted .csv file for import into clarity with UTF-8 text encoding. In Microsoft Excel "Save As..." is called: "CSV UTF-8 (comma delimited)(.csv)"
- Admin access within your Clarity Security tenant
- Note: If you are a full admin in Clarity Security and get a permission error when trying to add a new application, reach out to firstname.lastname@example.org.
How to Setup the Connector
Step 1: Log in to Clarity Security and click Applications
Step 2: Click the "Import Data from Files" button
Find the "Import Data from Files" button near the top of the page.
Step 3: Use the Bottom Half for New CSV connectors
For new Connectors use the bottom half of the form. If you provide updated data, select the application in the top section.
Step 4: Choose Between Complete and Partial
Step 5: Upload the File from Your Device
Click the "Choose Files" button to locate the relevant CSV from your machine. Then click "Upload Files".
Step 6: Select the Type of Data included in the CSV
Select from the options Identity, Entitlements, or Identity-Entitlements to indicate what type of data is included in the CSV.
- Select Identity if you are importing a user list with no Entitlement information.
- Select Entitlements if you are importing a list of roles, policies, teams, or entitlements with no identity information.
- Select Identity-Entitlements if you are importing a list of users with access to a given application.
Step 7: Choosing the Type Triggers CSV Data to Load
Once you have selected the import type, the first two rows of the CSV will load in the bottom section and you are then able to map Identity and Entitlement Attributes.
Step 8: Map the Fields you want to Import
Begin mapping the columns from your CSV to the relevant attributes in Clarity.
Example: Column 1 in the CSV is titled name, in the drop-down "Full Name" should be selected.
Step 9: Verify Requirements
Verify the requirements have been met for your CSV import. The requirements for each type of CSV import is listed below:
Required Fields for Users Only Import
- ID in Application
- Full Name or First & Last
Required Fields for Entitlements only Import
- ID in Application
Required Fields for Users + Entitlements Import
- ID in App of Identity
- ID in App of Entitlement
- Entitlement Type
Step 10: Validate Your Selections and Save and Process Import
Special Notes for Mappable Fields:
Not all fields are available for every type of data import
Ignore Field - This is the default, use this option for any data you don't want to import.
ID in App of Identity - This is a unique identifier used in the application
ID in App of Entitlement - This is the unique identifier or name of the entitlement from the application. Some applications like AD groups have a unique identifier as well as a name (GUID vs. the object name "Development Team". If your entitlement does not have a separate identifier, then use the checkbox "Entitlement Name is the unique Entitlement ID in the Application" to use the name for both fields.
Full Name or First & Last Name - You only need to provide the full name field, or the first and last name field to satisfy the name import.
Email - This is the email for the Identity. If this is your unique identifier, use the checkbox in the top right to indicate this.
Active - Use this field for data that indicates if the identity is active or inactive (Possible Values for true: 1, 'yes', 'Yes', 'YES', 'Y', 'y', 'ACTIVE', 'Active', 'active', 'True', 'true', 'TRUE', all other values would be interpreted as false)
Identity Status - This would be a field that helps describe their active/inactive status, however, this field is not used to determine the user's active or inactive status. Examples would include "Leave of Absence", "On Leave", etc.
Supervisor Identifier - This option is used for providing the identifier for the Identity's supervisor.
Attribute - Use this option to open a field for typing a custom attribute name.
Permission (options list) - An entitlement found on the user object where each user has a single value for this column.
Permission (true/false) - An entitlement found on the user object where the value in the column is either true or false. Clarity determines the user has the entitlement if the value is true only. (Possible Values for true: 1, 'yes', 'Yes', 'YES', 'Y', 'y', 'ACTIVE', 'Active', 'active', 'True', 'true', 'TRUE', all other values would be interpreted as false.
Entitlement Name - This field is for the name of the entitlement. Examples of this would be the group name, license name, policy name, role name, etc.
Entitlement Type - This field helps you provide helpful information about the entitlement. Entitlements can be groups, licenses, policies, roles, etc. This field is required if you are importing entitlements.
High Risk - This field is used to indicate if an entitlement is a High Risk. This is a flag in Clarity that you can perform Access Reviews filtering with. (Possible Values for True: 1, 'yes', 'Yes', 'YES', 'Y', 'y', 'High Risk', 'high risk', 'Highrisk', 'highrisk', 'true', 'True', 'TRUE', all other values would be interpreted as false.)
Definition - This field can be used to populate the definition field for entitlements in Clarity. Definitions act as the explanation of what an entitlement provides in its application. This is extremely helpful when an entitlement is an acronym or shorthand that an access reviewer may not recognize.
Entitlement Owner ID - This field is used to provide an owner's unique identifier for an entitlement. In Clarity, the owner of an entitlement is an indication of who is responsible for this access. Access Reviews can be sent to entitlement owners as well as many other options. This can be modified in the Clarity UI after import.
If you have any problems, contact your customer success team. You can also get in touch with our general support via email, open a support ticket. Our general support team is available Monday - Friday from 8:00 AM - 6:30 PM CST.