Contents x
    CSV File User Directories
    • 26 Aug 2024
    • 2 Minutes to read
    • Dark
      Light
    Contents

    CSV File User Directories

    • Updated on 26 Aug 2024
    • 2 Minutes to read
    • Dark
      Light
    Article summary

    General

    This type of user directory synchronizes Users and User Groups with a CSV file.

    NOTE

    This type of user directory is not available in the SaaS version of Mail & Deploy.

    File Structure

    The CSV file contains two types of entries; each entry needs to be in a line of its own.

    User Group Entry

    This type of entry describes a user group and has the following syntax:

    CSV File User Group Entry

    usergroup;<id>;<name>

    The entry has the following values:

    Name

    		Description
    idThe ID of the user group which is used by to identify a user group throughout multiple synchronizations with the CSV file. This is an alphanumeric string that needs to be unique.
    he ID of the user group which is used by to identify a user group throughout multiple synchronizations with the CSV file. This is an alphanumeric string that needs to be unique.The name of the user group.
    #### User Entry
    This type of entry describes a user and has the following syntax:
    CSV File User Entry

    user;<id>;<name>;<match_code>;<type>;<language>;<email>;<time_zone>;<culture>;<has_windows_account>;<windows_account_name>;<has_custom_credentials>;<custom_username>;<custom_password>[;<usergroup_id_1>;...<usergroup_id_n>]

    The entry has the following values:

    Name

    		Description
    idThe ID of the user which is used by to identify a user throughout multiple synchronizations with the CSV file. This is an alphanumeric string that needs to be unique.
    nameThe name of the user.
    match_codeThe match-code of the user. This property is optional and can be an empty string.
    type0. Standard User
    1. API User
    2. Administrator
    languageen. English
    de. German
    emailThe e-mail address of the user. This property is optional and can be an empty string.
    time_zoneThe timezone of the user; this needs to be one of the values of the Timezone column of the  Windows Default Time Zones.
    cultureThe culture of the user; this needs to be one of the values of the CultureInfo Code column of the  Culture Code List.
    has_windows_accountFalse. The user does not have a windows account.
    True. The user does have a windows account.
    windows_account_nameThe name of the windows account of the user in DOMAIN\accountname format. This property can be an empty string if haswindowsaccount is set to False.
    has_custom_credentialsFalse. The user does not have custom credentials.
    True. The user does have custom credentials.
    custom_usernameThe custom username of the user. This property can be an empty string if hascustomcredentials is set to False.
    custom_passwordThe custom password of the user. This property can be an empty string if hascustomcredentials is set to False. The custom password of a user will only be set if the user is first added during a synchronization; when an existing user is updated, the password will not be overwritten.
    usergroup_id_1
    ...
    usergroup_id_n    		One or more IDs of user group entries within the same CSV file (see User Group Entry above).
    NOTE

    For a full description of the individual properties see the Users article.

    Was this article helpful?
    What's Next