Service: zimbraAdmin

Command: CheckAuthConfig
Namespace: urn:zimbraAdmin
Description: Check Auth Config
For example:
 <CheckAuthConfigRequest>
     <a n='zimbraAuthMech'>ldap<</a>
     <a n='zimbraAuthLdapURL'>...</a>
     <a n='zimbraAuthLdapBindDn'>...</a>
     <a n='zimbraAuthLdapSearchFilter'>...</a>
     <a n='zimbraAuthLdapSearchBase'>...</a>
     <a n='zimbraAuthLdapSearchBindDn'>...</a>
     <a n='zimbraAuthLdapSearchBindPassword'>...</a>
     <name>...</name>
     <password>...</password>
 </CheckAuthConfigRequest>

 <CheckAuthConfigResponse>
     <code>...</code>
     <message>...</message>*
     <bindDn>{dn-computed-from-supplied-binddn-and-name}</bindDn>
 </CheckAuthConfigResponse>
 
notes: The following are optional, and only looked at if zimbraAuthLdapSearchFilter is set:
Properties:
Authorization token required true
Admin Authorization token required true

CheckAuthConfigRequest

    <CheckAuthConfigRequest name="{name}" password="{password}"> ## CheckAuthConfigRequest
        (<a n="{key}" /> ## Attr)*
    </CheckAuthConfigRequest>

elements and attributes you can define within a <CheckAuthConfigRequest> element:

XPath Required / Optional Description
@name Required (only 1) Type: String
Name
@password Required (only 1) Type: String
Password
/a Optional (0 or more) Attributes
/a@n Required (only 1) Type: String
Key

CheckAuthConfigResponse

    <CheckAuthConfigResponse> ## CheckAuthConfigResponse
        <code>{code} (String)</code>
        <message>{message} (String)</message>
        <bindDn>{bindDn} (String)</bindDn>
    </CheckAuthConfigResponse>

elements and attributes you can define within a <CheckAuthConfigResponse> element:

XPath Required / Optional Description
/code Required (only 1) Type: {code} (String)
Code
/message Optional (0 or 1) Type: {message} (String)
Message
/bindDn Required (only 1) Type: {bindDn} (String)
DN computed from supplied bind DN and name