General
This type of user directory synchronizes Users and User Groups with an XML file.
This type of user directory is not available in the SaaS version of Mail & Deploy.
File Structure
The XML file contains two types of entries. The basic structure of the XML looks like this:
User Group Entry
This type of entry describes a user group and has the following syntax:
<UserGroup
Id="
Name="
The entry has the following values:
Name |
Description |
|---|---|
| id | The ID of the user group which is used by to identify a user group throughout multiple synchronizations with the XML file. This is an alphanumeric string that needs to be unique. |
| name | The name of the user group. |
User Entry
This type of entry describes a user and has the following syntax:
<User
Id="
Name="
MatchCode="<match_code>"
Type="
LanguageCode="
EMailAddress="
TimeZone="<time_zone>"
Culture="
HasWindowsAccount="<has_windows_account>"
WindowsAccountName="<windows_account_name>"
HasCustomCredentials="<has_custom_credentials>"
CustomUserName="<custom_username>"
InitialCustomPassword="<initial_custom_password>" />
<UserGroupMembership UserGroupId="<usergroup_id>" />
</User>
The entry has the following values:
Name |
Description |
|---|---|
| id | The ID of the user which is used by to identify a user throughout multiple synchronizations with the XML file. This is an alphanumeric string that needs to be unique. |
| name | The name of the user. |
| match_code | The match-code of the user. This property is optional and can be an empty string. |
| type | 0. Standard User 1. API User 2. Administrator |
| language | en. English de. German |
| The e-mail address of the user. This property is optional and can be an empty string. | |
| time_zone | The timezone of the user; this needs to be one of the values of the Timezone column of the Windows Default Time Zones. |
| culture | The culture of the user; this needs to be one of the values of the CultureInfo Code column of the Culture Code List. |
| has_windows_account | False. The user does not have a windows account. True. The user does have a windows account. |
| windows_account_name | The 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_credentials | False. The user does not have custom credentials. True. The user does have custom credentials. |
| custom_username | The custom username of the user. This property can be an empty string if hascustomcredentials is set to False. |
| custom_password | The 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. |
For a full description of the individual properties see the Users article.
Every user entry can have zero or more user group membership entries which define the membership of a user in a user group. The values are:
Name |
Description |
|---|---|
| usergroup_id | The ID of the user group of which the user is a member. This must be the ID of one of the user groups defined in a user group entry of the XML file. |