How it works

This feature is designed to take advantage of user synchronisation via a CSV (Comma Separated Values) file rather than synchronising users from an AD Directory.

In the same way as a directory synchronisation on an Exchange On Premise, we use a PowerShell script, together with a JSON configuration file, in which we will place the "App ID" and "App Secret" (configuration file, "App ID" and "App Secret" provided on the platform) allowing the script to interact with our API (reachable on https://api.letsignit.com) to transmit the user information to us.

Technical requirements verification

In order to set up a synchronisation from a CSV file, please find below all the technical requirements:

  • Minimum required version of the PowerShell tool: Version 4.0

  • PowerShell execution strategy (to be applied for automation in scheduled tasks in order to launch the script without execution confirmation): RemoteSigned

CSV file format

The CSV file used must follow the correct column header format, which you can obtain from your local Active Directory, which should be as follows:

"DistinguishedName";"ObjectGUID";"mail";"DisplayName";"GivenName";"Surname";"Title";"Department";"OfficePhone";"MobilePhone";"Fax";"StreetAddress";"City";"PostalCode";"State";"Country";"Company";"HomePage"

PowerShell for creating the CSV file

In order to generate the CSV file, you need to be able to run PowerShell commands on a workstation with access to the local Active Directory server (or directly on the server).

Here is the complete command to be entered to create the CSV file:

Get-ADUser -Filter * -Properties * | Select-Object DistinguishedName, ObjectGUID, mail, DisplayName, GivenName, Surname, Title, Department, OfficePhone, MobilePhone, Fax, StreetAddress, City, PostalCode, State, Country, Company, HomePage, thumbnailPhoto | export-csv -path c:\users.csv -Encoding UTF8 -Delimiter ';'

The command is structured in several parts:

  • Get-ADUser -Filter * -Properties * : Retrieves the list of users and all their parameters.

  • Select-Object DistinguishedName, ObjectGUID, mail, DisplayName, GivenName, Surname, Title, Department, OfficePhone, MobilePhone, Fax, StreetAddress, City, PostalCode, State, Country, Company, HomePage, thumbnailPhoto: The attributes to be returned for each user are selected (here, DN, ID, mail, display name, surname, given name, nickname, title...) This list can be modified.

  • Export-csv -path c:\users.csv -Encoding UTF8 -Delimiter ';': All the data selected above will be uploaded to a CSV file in the specified folder (C:\users.csv here). The file will be encoded in UTF-8-BOM and the delimiters between each value will be ";".

In the second part of the command, the attributes can be changed. There are only three mandatory attributes: DistinguishedName, ObjectGUID and mail.

Except for these, all attributes of a user can be moved up or down.

#Synchronisation #Synchronization #CSV Synchronisation #CSV

Did this answer your question?