Skip to main content
All CollectionsGetting startedTechnical preparationPlatform setup
How-to-guide: Add and manage users and groups in bulk using CSV.
How-to-guide: Add and manage users and groups in bulk using CSV.

A step-by-step guide on using the .csv files to manage users and their groups in bulk

C
Written by Cyprian Brytan
Updated over 3 months ago

Introduction

This article will show how to use our csv import functionality to manage bulk changes such as:

  • add new users

  • edit existing users' details

  • activate and deactivate users

  • create new groups and assign users group membership

  • edit groups and memberships

This article also covers:

  • how do Department, Division, Organisation and groups work?

  • how do delimiters work?

CybSafe recommends: when to use the bulk feature?

We recommend using our bulk CSV management primarily for organizations without active SCIM connections. If you have a SCIM connection, changes made through CSV might be overwritten or cause unexpected behavior during the SCIM sync.

How to add new users?

  1. Navigate to the People Page:
    Go to the "People" page in your dashboard.

  2. Select 'Add People':
    Click on the "Add people" button, and from the dropdown menu, select "Upload CSV Version 2."

  3. Download the Template:
    We recommend downloading the blank template, which contains all the mandatory and optional fields required for adding new users.

  4. Fill in the Template:
    Complete the downloaded template with your users' data and save the file to your desktop. For more information on each field, click here.

  5. Upload Your CSV File:
    Click "Choose CSV file," and select the completed file from your desktop.

  6. Select the Header Row:
    When the validation pop-up appears, select the header row of your file.

  7. Map the Headers:
    In the headers mapping step, match the columns from your CSV file to the recognized fields in CybSafe. If any fields have been changed in the header, you can still align them with the platform’s expected fields.

  8. Review and Edit:
    In the final step, review the data before submission. You can make last-minute changes directly in the editable cells. To remove any unwanted rows, scroll to the left, select the row, and click "Discard selected rows" to exclude them from the upload.

  9. Confirm the Upload:
    Once you have reviewed and made any necessary changes, click "Confirm" to upload the file.

How to activate and deactivate users?

  1. Navigate to the People Page:
    Go to the "People" page on your dashboard.

  2. Select 'Add People':
    Click the "Add people" button and choose "Upload CSV Version 2" from the dropdown menu.

  3. Download the CSV of All Users:
    Download the CSV file to view a record of all active and deactivated users.

  4. Find Users to Activate or Deactivate:
    Locate the users you want to activate or deactivate.

  5. Update the 'Active' Status:
    To deactivate an active user, set the 'Active' column to 'False.' To activate a deactivated user, set the 'Active' column to 'True.'

  6. Upload Your CSV File:
    Click "Choose CSV file," and select the updated file from your desktop.

  7. Select the Header Row:
    When the validation pop-up appears, select the header row of your file.

  8. Map the Headers:
    In the header mapping step, match the columns from your CSV file to the recognized fields in CybSafe. If any fields have been modified in the header, align them with the platform's expected fields.

  9. Review and Edit:
    Review the data before submission. You can make last-minute changes directly in the editable cells. To remove any unwanted rows, scroll to the left, select the row, and click "Discard selected rows" to exclude them from the upload.

  10. Confirm the Upload:
    Once you have reviewed the data and made any necessary changes, click "Confirm" to upload the file.

How to edit existing users?

  1. Navigate to the People Page:
    Go to the "People" page on your dashboard.

  2. Select 'Add People':
    Click the "Add people" button, then choose "Upload CSV Version 2" from the dropdown menu.

  3. Download the CSV of All Users:
    Download the CSV file to access a complete record of all active and deactivated users.

  4. Amend User Details:
    Make any necessary changes to the user details in the CSV file. Do not change or delete the Public ID; doing so will result in errors.

  5. Upload Your CSV File:
    Click "Choose CSV file" and select the updated file from your desktop.

  6. Select the Header Row:
    When the validation pop-up appears, select the header row of your file.

  7. Map the Headers:
    Match the columns from your CSV file to the recognized fields in CybSafe during the header mapping step. If any fields have been modified in the header, align them with the platform's expected fields.

  8. Review and Edit:
    Carefully review the data before submission. You can make last-minute changes directly in the editable cells. To remove unwanted rows, scroll to the left, select the row, and click "Discard selected rows."

  9. Confirm the Upload:
    Once you have reviewed the data and made any necessary changes, click "Confirm" to upload the file.

Important: Please keep a copy of the original CSV file you downloaded before making any changes. If you encounter errors or made mistakes after uploading the amended file, you can revert the changes by re-uploading the original CSV.

CSV fields

Both, the blank template and the CSV of all users have the same header structure:

Field

Description

Mandatory/optional

Public ID

This is an ID CybSafe uses to identify if any changes to the user have been made. Please do not edit or remove this when updating records.

Optional

Email

User's email address

Mandatory

First Name

User's first name. This ensures the user is identifiable and their platform emails will be a bit more friendly.

Mandatory

Last Name

User's last name. This ensures the user is identifiable and their platform emails will be a bit more friendly.

Mandatory

Account Type

The type of user's account. Available types are: 'User', 'Manager', 'Admin'

Optional, if left blank it will default to 'User'

Active

This field controls whether user is active or deactivated. Set to 'True' means user is active, 'False' means user will be deactivated.

Optional, if left blank it will default to 'True'

Country Code

Country of user's residence. It will give your reporting an additional dimension where country information is available.

Use the Alpha-2 country codes found here.

Optional, if left blank it will default to your organisation's country setting.

Language

User's default language. For language codes please refer to the table here

Optional, if left blank it will default to your organisation's language setting.

Department

Department user will belong to

Optional

Division

Division user will belong to

Optional

Organisation

The organisation user will belong to

Optional

Groups

Groups the user will belong to.

Optional

How do Department, Division, Organisation and Groups work?

"Department," "Division," and "Organisation" are fixed top-level groups that cannot be removed. However, if you do not need them, you can leave those columns blank. You can also add subdepartments, subdivisions, or suborganisations by entering them in the corresponding CSV columns.

We support multi-membership, allowing a user to belong to multiple Departments, Divisions, and Organisations.

For Groups, you can create as many top-level groups and subgroups as needed. A separate field called "Groups" manages all these memberships.

Please note that the CSV file will accept blank cells for the Department, Division, Organization, and Groups fields as valid input. If you delete any value for a given user, our records will update that field to indicate no membership. For example, if a user previously had a group membership and you delete the value, that membership will be removed from our records.

How do delimiters work?

Delimiters are characters used to define boundaries between groups and their subgroups, as well as between different groups.

  • The default delimiter to separate a group from its subgroup is the forward slash ("/").

  • This delimiter applies to Departments, Divisions, and Organizations and groups.

To separate one top-level group (and its subgroups) from another, use a line break:

  • On Windows, press Alt + Enter.

  • On macOS, press Option + Enter or Control + Command + Enter.

Example: If you want to add multiple memberships in a CSV, it should look like this:

The result of such CSV upload would be:

How to create new groups and assign users group membership?

If a group does not exist you can add it by simply adding it in the 'Groups' column for any user that you'd like to be a member of. To do this:

  1. Navigate to the People Page:
    Go to the "People" page on your dashboard.

  2. Select 'Add People':
    Click the "Add people" button, then choose "Upload CSV Version 2" from the dropdown menu.

  3. Download the CSV: Download either a blank CSV or a CSV containing all users.

  4. Update the 'Groups' Column: In the spreadsheet navigate to the last column labeled 'Groups'. If a group does not exist, adding new values in this column will automatically create those groups and subgroups.

  5. Upload Your CSV File: Click "Choose CSV file" and select the updated file from your desktop.

  6. Select the Header Row: When the validation pop-up appears, choose the header row from your file.

  7. Map the Headers: During the header mapping step, match the columns in your CSV file to the corresponding fields in CybSafe. If any headers have been modified, align them with the platform's recognized fields.

  8. Review and Edit: Carefully review the data before submitting. You can make final changes directly in the editable cells. To remove any unwanted rows, scroll to the left, select the row, and click "Discard selected rows."

  9. Confirm the Upload: Once all data has been reviewed and edited as necessary, click "Confirm" to complete the upload.

How to edit groups?

  1. Navigate to the People Page:
    Go to the "People" page on your dashboard.

  2. Select 'Add People':
    Click the "Add people" button, then choose "Upload CSV Version 2" from the dropdown menu.

  3. Download the CSV of All Users:
    Download the CSV file to access a complete record of all active and deactivated users and their groups.

  4. Amend Group Details:
    Make any necessary changes to the Groups' column in the CSV file. Do not change or delete the Public ID; doing so will result in errors.

  5. Upload Your CSV File:
    Click "Choose CSV file" and select the updated file from your desktop.

  6. Select the Header Row:
    When the validation pop-up appears, select the header row of your file.

  7. Map the Headers:
    Match the columns from your CSV file to the recognized fields in CybSafe during the header mapping step. If any fields have been modified in the header, align them with the platform's expected fields.

  8. Review and Edit:
    Carefully review the data before submission. You can make last-minute changes directly in the editable cells. To remove unwanted rows, scroll to the left, select the row, and click "Discard selected rows."

  9. Confirm the Upload:
    Once you have reviewed the data and made any necessary changes, click "Confirm" to upload the file.

Did this answer your question?