<CreateGalSyncAccountRequest name="zimbra" domain="mydomain.com" type="zimbra" server="mailhost.mydomain.com">
<account by="name">gal@mydomain.com</account>
</CreateGalSyncAccountRequest>
Example for creating domain gal sync account.
<CreateGalSyncAccountRequest name="mydomain" domain="mydomain.com" type="ldap" server="mailhost.mydomain.com">
<account by="name">gal@mydomain.com</account>
<a n="zimbraGalSyncLdapURL">ldap://ldap.mydomain.com</a>
<a n="zimbraGalSyncLdapStartTlsEnabled">TRUE</a>
<a n="zimbraGalSyncLdapSearchBase">cn=users</a>
<a n="zimbraGalSyncLdapAuthMech">simple</a>
<a n="zimbraGalSyncLdapBindDn">uid=admin,cn=users</a>
<a n="zimbraGalSyncLdapBindPassword">password</a>
<a n="zimbraGalSyncLdapFilter">(&(mail=*)(objectClass=user))</a>
<a n="zimbraGalLdapAttrMap">whenChanged,modifyTimeStamp=modifyTimeStamp</a>
<a n="zimbraGalLdapAttrMap">whenCreated,createTimeStamp=createTimeStamp</a>
<a n="zimbraGalLdapAttrMap">zimbraMailDeliveryAddress,zimbraMailAlias,mail=email,email2,email3,email4,email5,email6,email7,email8,email9,email10,email11,email12,email13,email14,email15,email16</a>
</CreateGalSyncAccountRequest>
Access: domain admin sufficient
| Authorization token required | true |
| Admin Authorization token required | true |
<CreateGalSyncAccountRequest name="{identifier}" domain="{domain-name}" type="(both | ldap | zimbra)"
[password="{password}"] [folder="{contact-folder-name}"] server="{server}"> ## CreateGalSyncAccountRequest
<account by="{acct-selector-by} (adminName | appAdminName | id | foreignPrincipal | name | krb5Principal)">{key}</account> ## AccountSelector
(<a n="{key}" /> ## Attr)*
</CreateGalSyncAccountRequest>
elements and attributes you can define within a
<CreateGalSyncAccountRequest> element:
| XPath | Required / Optional | Description |
| @name | Required (only 1) | Type: String Name of the data source. |
| @domain | Required (only 1) | Type: String Domain name |
| @type | Required (only 1) | Type: both | ldap | zimbra GalMode type |
| @password | Optional (0 or 1) | Type: String |
| @folder | Optional (0 or 1) | Type: String Contact folder name |
| @server | Required (only 1) | Type: String The mailhost on which this account resides |
| /account | Required (only 1) | Type: {key} Account Description for element text content:The key used to identify the account. Meaning determined by {acct-selector-by} |
| /account@by | Required (only 1) | Type: adminName | appAdminName | id | foreignPrincipal | name | krb5Principal Select the meaning of {acct-selector-key} |
| /a | Optional (0 or more) | Attributes |
| /a@n | Required (only 1) | Type: String Key |
<CreateGalSyncAccountResponse> ## CreateGalSyncAccountResponse
<account [isExternal="{is-external} (0|1)"] name="{name}" id="{id}"> ## AccountInfo
(<a n="{key}" /> ## Attr)*
</account>
</CreateGalSyncAccountResponse>
elements and attributes you can define within a
<CreateGalSyncAccountResponse> element:
| XPath | Required / Optional | Description |
| /account | Required (only 1) | Information about the newly created GalSync account |
| /account@isExternal | Optional (0 or 1) | Type: 0|1 Whether the account's zimbraMailTranport points to the designated protocol(lmtp) and server(home server of the account). |
| /account@name | Required (only 1) | Type: String Name |
| /account@id | Required (only 1) | Type: String ID |
| /account/a | Optional (0 or more) | Attributes |
| /account/a@n | Required (only 1) | Type: String Key |