Skip to content
Dashboard
Theme
Theme

CSV file CSV directory import

Sync your directory from a CSV file

View Markdown

Export your people as a CSV file with the columns below and upload it in this setup; each new upload applies only the differences.

The values in braces, such as {acs_url}, are specific to your connection. The setup link from the application you are connecting shows them with a copy button. The same steps appear there.

  1. Export everyone who should be in the directory from your HR system or spreadsheet as one CSV file with a header row. Each upload replaces the whole directory, so always export everyone, not just recent changes.

  2. Add an external_id column with a value that never changes for each person, such as an employee ID. It is required and must be unique in the file. A person whose external_id changes is removed and added again as someone new.

  3. Add a user_name column, an email column or both. Each row needs one of the two; when user_name is empty, the email is used. User names must be unique, and emails must be valid addresses.

  4. You can also add given_name, family_name, display_name, active, title, department and employee_number. Set active to true or false; it is true when empty. Column names are not case-sensitive, and a file with any other column is refused.

  5. To sync groups, add a groups column with the person’s group names separated by semicolons, such as “Engineering;Managers”. Groups are created from the names in the file and removed when no row names them.

  6. A file can be at most 10 MiB and hold at most 50,000 users. A file with errors is refused as a whole, with up to 20 problem rows named, and nothing changes.

  7. Upload the file in this setup. Only the differences from the current directory are applied: new people are added, changed people are updated and people missing from the file are removed.

  8. Upload a new full export whenever people join, change roles or leave. As a safety check, a file that would remove more than half of a directory of 20 or more users is refused; check the export if that happens.