Overview | Service | Command |
Generate bulk provision file from LDAP
Network edition only API | TRUE |
Authorization token required | true |
Admin Authorization token required | true |
<GenerateBulkProvisionFileFromLDAPRequest> ## GenerateBulkProvisionFileFromLDAPRequest
<password>{password} (String)</password>
<generatePassword>{generatePassword} (String)</generatePassword>
<genPasswordLength>{genPasswordLength} (Integer)</genPasswordLength>
<fileFormat>{fileFormat} (String)</fileFormat>
<mustChangePassword>{mustChangePassword} (String)</mustChangePassword>
<maxResults>{maxResults} (Integer)</maxResults>
<SMTPHost>{SMTPHost} (String)</SMTPHost>
<SMTPPort>{SMTPPort} (String)</SMTPPort>
<importMails>{importMails} (String)</importMails>
<importContacts>{importContacts} (String)</importContacts>
<importCalendar>{importCalendar} (String)</importCalendar>
<importTasks>{importTasks} (String)</importTasks>
<importJunk>{importJunk} (String)</importJunk>
<importDeletedItems>{importDeletedItems} (String)</importDeletedItems>
<ignorePreviouslyImported>{ignorePreviouslyImported} (String)</ignorePreviouslyImported>
<InvalidSSLOk>{invalidSSLOk} (String)</InvalidSSLOk>
<MapiProfile>{mapiProfile} (String)</MapiProfile>
<MapiServer>{mapiServer} (String)</MapiServer>
<MapiLogonUserDN>{mapiLogonUserDN} (String)</MapiLogonUserDN>
<ZimbraAdminLogin>{zimbraAdminLogin} (String)</ZimbraAdminLogin>
<ZimbraAdminPassword>{zimbraAdminPassword} (String)</ZimbraAdminPassword>
<TargetDomainName>{targetDomainName} (String)</TargetDomainName>
<provisionUsers>{provisionUsers} (String)</provisionUsers>
(<a name="{attr-name}">{value}</a> ## Attr)*
</GenerateBulkProvisionFileFromLDAPRequest>
The following table describes elements and attributes you can define within a
<GenerateBulkProvisionFileFromLDAPRequest>
element:
XPath | Required / Optional | Description |
/password | Optional (0 or 1) | Type:{password} (String) Password |
/generatePassword | Optional (0 or 1) | Type:{generatePassword} (String) Generate password flag. True if "true" (case insensitive) else false - default value "false" |
/genPasswordLength | Optional (0 or 1) | Type:{genPasswordLength} (Integer) Length for generated passwords (Default 8) |
/fileFormat | Optional (0 or 1) | Type:{fileFormat} (String) File format - preview|csv|bulkxml|migrationxml |
/mustChangePassword | Required (only 1) | Type:{mustChangePassword} (String) Flag whether must change password |
/maxResults | Optional (0 or 1) | Type:{maxResults} (Integer) Maximm number of results |
/SMTPHost | Optional (0 or 1) | Type:{SMTPHost} (String) SMTP host |
/SMTPPort | Optional (0 or 1) | Type:{SMTPPort} (String) SMTP port |
/importMails | Optional (0 or 1) | Type:{importMails} (String) Flag whether to import mails. True if "TRUE" (case insensitive) |
/importContacts | Optional (0 or 1) | Type:{importContacts} (String) Flag whether to import contacts. True if "TRUE" (case insensitive) |
/importCalendar | Optional (0 or 1) | Type:{importCalendar} (String) Flag whether to import calendars. True if "TRUE" (case insensitive) |
/importTasks | Optional (0 or 1) | Type:{importTasks} (String) Flag whether to import tasks. True if "TRUE" (case insensitive) |
/importJunk | Optional (0 or 1) | Type:{importJunk} (String) Flag whether to import junk. True if "TRUE" (case insensitive) |
/importDeletedItems | Optional (0 or 1) | Type:{importDeletedItems} (String) Flag whether to import deleted items. True if "TRUE" (case insensitive) |
/ignorePreviouslyImported | Optional (0 or 1) | Type:{ignorePreviouslyImported} (String) Flag whether to import previosly imported items. True if "TRUE" (case insensitive) |
/InvalidSSLOk | Optional (0 or 1) | Type:{invalidSSLOk} (String) Invalid SSL Ok flag. True if "TRUE" (case insensitive) |
/MapiProfile | Optional (0 or 1) | Type:{mapiProfile} (String) MAPI profile |
/MapiServer | Optional (0 or 1) | Type:{mapiServer} (String) MAPI Server |
/MapiLogonUserDN | Optional (0 or 1) | Type:{mapiLogonUserDN} (String) MAPI logon User DN |
/ZimbraAdminLogin | Optional (0 or 1) | Type:{zimbraAdminLogin} (String) Zimbra Admin login |
/ZimbraAdminPassword | Optional (0 or 1) | Type:{zimbraAdminPassword} (String) Zimbra Admin password |
/TargetDomainName | Optional (0 or 1) | Type:{targetDomainName} (String) Target domain name |
/provisionUsers | Optional (0 or 1) | Type:{provisionUsers} (String) Flag whether to provision users. True if "TRUE" (case insensitive) |
/a | Optional (0 or more) | Type:{value} Attrs Description for element text content:Attribute Value |
/a@name | Required (only 1) | Type:String Attribute name |
<GenerateBulkProvisionFileFromLDAPResponse> ## GenerateBulkProvisionFileFromLDAPResponse
<totalCount>{totalCount} (Integer)</totalCount>
<domainCount>{domainCount} (Integer)</domainCount>
<skippedAccountCount>{skippedAccountCount} (Integer)</skippedAccountCount>
<skippedDomainCount>{skippedDomainCount} (Integer)</skippedDomainCount>
<SMTPHost>{SMTPHost} (String)</SMTPHost>
<SMTPPort>{SMTPPort} (String)</SMTPPort>
<fileToken>{fileToken} (String)</fileToken>
</GenerateBulkProvisionFileFromLDAPResponse>
The following table describes elements and attributes you can define within a
<GenerateBulkProvisionFileFromLDAPResponse>
element:
XPath | Required / Optional | Description |
/totalCount | Optional (0 or 1) | Type:{totalCount} (Integer) Total count |
/domainCount | Optional (0 or 1) | Type:{domainCount} (Integer) Domain count |
/skippedAccountCount | Optional (0 or 1) | Type:{skippedAccountCount} (Integer) Count of number of skipped accounts |
/skippedDomainCount | Optional (0 or 1) | Type:{skippedDomainCount} (Integer) Count of number of skipped domains |
/SMTPHost | Optional (0 or 1) | Type:{SMTPHost} (String) SMTP host |
/SMTPPort | Optional (0 or 1) | Type:{SMTPPort} (String) SMTP port |
/fileToken | Optional (0 or 1) | Type:{fileToken} (String) File token |