Service: zimbraAdmin
Namespace: "urn:zimbraAdmin"
GetLDAPEntries SOAP Command

Get LDAP entries
GetLDAPEntriesRequest fetches ldap entry (or entries) by a search-base ({ldap-search-base}) and a search query ({query}).

Authorization token required true
Admin Authorization token required true

GetLDAPEntriesRequest

    <GetLDAPEntriesRequest [sortBy="{sort-by-attrib}"] [sortAscending="{sort-ascending} (0|1)"] [limit="(Integer)"]
                              [offset="(Integer)"] query="{query}"> ## GetLDAPEntriesRequest
        <ldapSearchBase>{ldapSearchBase} (String)</ldapSearchBase>
    </GetLDAPEntriesRequest>

The following table describes elements and attributes you can define within a <GetLDAPEntriesRequest> element:

XPath Required / Optional Description
@sortBy Optional (0 or 1) Type:String
Name of attribute to sort on. default is null
@sortAscending Optional (0 or 1) Type:0|1
Flag whether to sort in ascending order 1 (true) is default
@limit Optional (0 or 1) Type:Integer
Limit - the maximum number of LDAP objects (records) to return (0 is default and means all)
@offset Optional (0 or 1) Type:Integer
The starting offset (0, 25, etc)
@query Required (only 1) Type:String
Query string. Should be an LDAP-style filter string (RFC 2254)
/ldapSearchBase Required (only 1) Type:{ldapSearchBase} (String)
LDAP search base. An LDAP-style filter string that defines an LDAP search base (RFC 2254)

GetLDAPEntriesResponse

    <GetLDAPEntriesResponse> ## GetLDAPEntriesResponse
        (<LDAPEntry name="{ldap-entry-name}"> ## LDAPEntryInfo
            (<a n="{key}" /> ## Attr)*
          </LDAPEntry>)*
    </GetLDAPEntriesResponse>

The following table describes elements and attributes you can define within a <GetLDAPEntriesResponse> element:

XPath Required / Optional Description
/LDAPEntry Optional (0 or more) LDAP entries
/LDAPEntry@name Required (only 1) Type:String
LDAP Entry name
/LDAPEntry/a Optional (0 or more) Attributes
/LDAPEntry/a@n Required (only 1) Type:String
Key