Add multiple users to an organization

You can use a CSV file to add multiple users to an organization.

Before you begin

  • For on-premises customers, a SuperAdmin role is required.

  • For hosted customers, an Organization Administrator role is required.

Steps

  1. Go to the Users list:.

    1. For hosted customers, under the user menu, select Organization settings and then, select Users.

    2. For on-premises customers, under SuperAdmin, select Users in the header.

  2. Create a spreadsheet with the recommended information and save it as a CSV file:

    • Include the required fields for each user.

    • Format all field headings and values exactly as shown in the table below.

    • Add a new column for any optional fields.

    Tip

    Hover over the Upload icon and select the link in the tooltip to download a CSV template to get started.

    Image shows link to CSV template download in the Upload icon tooltip.

    CSV fields:

    Field name

    Required

    Value

    First Name

    Required

    User first name

    Last Name

    Required

    User last name

    Email or Username

    Required

    If you are using the Contrast's default internal directory, enter the user's email.

    If you are using an external directory, change Email to Username in the CSV, and enter usernames that match those in your external directory exactly.

    Organization UUID

    Required for on-premises customers

    Get this value from the organization's general information settings.

    Organization Role

    Required

    Values can be View, Edit, Rules_admin or Admin.

    Date Format

    Optional

    The default value is the organization setting, such as MM/dd/YYYY.

    Time Format

    Optional

    The default value is the organization setting, such as hh:mm a.

    Timezone

    Optional

    The default value is the organization time zone.

    Protect

    Optional

    The default value is Off.

    Groups

    Optional

    Values can be View, Edit, Rules Admin, Admin or custom group names. Format multiple group names as GroupA&&GroupB&&GroupC.

    Language

    Optional

    The default is the value configured for the organization.

    System Administration

    Optional

    The default value is Off.

    Email Activation

    Optional

    If the value is None, the default is Required Password.

    Password

    Optional

    This field is required if the Email Activation field is set to false.

    Api Only

    Optional

    The default value is Off.

    Access

    Optional

    The default value is On.

  3. Select the black upload icon next to Add user, then select the CSV you created.

    Once the spreadsheet upload is in progress, you can leave the page and continue with other tasks in Contrast. If the upload is successful, you'll see a confirmation message that includes the number of users uploaded. If the upload failed, you'll see an error message that includes the source of the error in the spreadsheet.