Uploading CSV Files for Creating Clearlogin Directory Users


Maybe you want to have another Identity Source to fall back on in case Active Directory or G Suite fails, or maybe you want to switch entirely to Clearlogin Directory (CLD) as your primary Identity Source.

Whatever your reason may be, importing a user base is super easy thanks to CLD's support for uploading Comma-Separated Value (CSV) files.

To start, log into https://admin.clearlogin.com and then do the following:

    1. Click on Clearlogin Directory from the navigation bar.

    2. Select your CLD if you have more than one.  For demonstration purposes, I will be going with "My Clearlogin Directory".

    3. You will be brought to the People Manager screen.

      From here, click on the blue button that says Upload CSV.

    4. You should now be on the Import People from CSV page.

      In here you have quite a few options.  To start, select the CLD that you want to work from the Select Template dropdown menu.  (If you are working with Google Apps for Education CSVs, please refer to the article, "Uploading G Suite Apps for Education CSV Files for Creating Clearlogin Directory Users.")

    5. You may want to define more Attributes other than the defaults that the template comes with (name, avatar_url, groups, username, password, email, password_reset_required).  If you do, click on the blue button on the right that says Edit Template.

    6. You will be brought to the Default Person Template page.  The Default Person Template is how an administrator would define what attributes get attached to a Person (CLD user) by default.

      As discussed above, the default template only has so many attributes attached to it, however you can add more.

      Editing this template is a great way to ensure that all CLD users have the same attribute fields by default.  (These attributes can be applied to CLD Filters for use with Access Rules.)

      There are three different ways to add attributes:

      A. The blue button that says text will allow you to define one CLD Attribute Name and one CLD Attribute Value.

      In this case, the CLD Attribute Name is student and the CLD Attribute Value will be changed depending on who the user is.  IE:  Freshman, sophomore, junior, senior.

      B. The blue button that says List will allow you to define one CLD Attribute Name and multiple CLD Attribute Values.

      C. The blue button that says Checkbox will allow you to define one CLD Attribute Name and one CLD Attribute Value which can either be true or false.

      D. You can of course have any combination of Text, List and Checkbox attributes.

    7. Once you have created your template, click on the green button that says Save.

      The page will refresh and you will receive a message that states that the template was updated successfully.

    8. On the navigation bar, click on People, then Manage and then the blue button that says Upload CSV again (and select your CLD if necessary) to get back to the Import People from CSV page.

      Make sure to select your CLD template again.

      If you compare the below screenshot to the one in the 4th step in this article, you will see that your custom CLD Name Attributes have been added beneath the default ones on the right side of the screen under What am I doing?

      You can click on the purple button that says Download Sample to download a pre-generated example CSV file.  This example will have all of the criteria that you added to your template.  You may use this as a base for creating your CSV file.

      As you can see in my CSV viewers, all of my example criteria has made it over to the same CSV.

    9. Once you have generated your CSV file it's time to upload it from the Import People from CSV page.

      As you can see above the blue button that says upload, there are four optional checkboxes that you may or may not want to use:

      A. Destroy people that are not in CSV: Only check this checkbox if you want all users' accounts that are currently in your CLD but have not been entered in your CSV to be deleted.

      B. Destroy attributes not listed in CSV: Only check this checkbox if you want to delete all CLD attributes which are currently in your CLD, but not in your CSV.  Any user that is affected by this will be forced to change their password the next time that they log in.

      C. Require password reset: Only check this checkbox if you want to force all new users created with your CSV to reset their password when they log in for the first time.  If "Destroy attributes not listed in CSV" is checked as well, then users that already exists in your CLD will have to change their passwords as well.

      D. Lock people: Only check this checkbox if you want to keep all newly created accounts locked until you are ready to unlock them (this is useful if you are setting up your users' CLD accounts way in advance of their arrival).  If "Destroy attributes not listed in CSV" is checked as well, then users that already exist in your CLD will be locked as well.

      Once you've decided which options you will or will not be using, click on the grey button that says Choose File and select your CSV file from within your file system and then click on the blue button that says upload.

    10. After the file is done uploading you will be brought back to the People Manager screen for your CLD and your new users and changes will have all populated.

      You have successfully created new CLD users with a CSV file that you generated, congratulations!
Have more questions? Submit a request


Powered by Zendesk