---
title: "XML File User Directories"
slug: "xml-file-user-directories"
updated: 2024-10-11T10:10:09Z
published: 2024-10-11T10:10:09Z
canonical: "help.mail-and-deploy.com/xml-file-user-directories"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://help.mail-and-deploy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XML File User Directories

### General

This type of user directory synchronizes [Users](/release35/docs/users) and [User Groups](/release35/docs/user-groups) with an XML file.

          NOTE

          

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:

          XML File Structures

          <xmluserdirectory data-tomark-pass="">
User Group Entries...
User Entries...
</xmluserdirectory>

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

          XML File User Group Entry

          

<UserGroup Id="<id>"<br> Name="<name>"/&gt;</name></id>

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:

          XML File User Entry

          

<User Id="<id>"<br> Name="<name>"<br> MatchCode="&lt;match_code&gt;"<br> Type="<type>"<br> LanguageCode="<language>"<br> EMailAddress="<email>"<br> TimeZone="&lt;time_zone&gt;"<br> Culture="<culture>"<br> HasWindowsAccount="&lt;has_windows_account&gt;"<br> WindowsAccountName="&lt;windows_account_name&gt;"<br> HasCustomCredentials="&lt;has_custom_credentials&gt;"<br> CustomUserName="&lt;custom_username&gt;"<br> InitialCustomPassword="&lt;initial_custom_password&gt;" /&gt;<br> &lt;UserGroupMembership UserGroupId="&lt;usergroup_id&gt;" /&gt;<br> &lt;/User&gt;</culture></email></language></type></name></id>

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 |
| email | 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](https://learn.microsoft.com/en-us/windows-hardware/manufacture/desktop/default-time-zones?view=windows-11). |
| culture | The culture of the user; this needs to be one of the values of the *CultureInfo Code* column of the [Culture Code List](https://azuliadesigns.com/c-sharp-tutorials/list-net-culture-country-codes/). |
| 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. |

          NOTE

          

For a full description of the individual properties see the [Users](/version340/docs/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. |