Namespace: "urn:zimbraAdmin"
GetRightsDoc SOAP Command

Get Rights Document

Authorization token required false
Admin Authorization token required false

GetRightsDocRequest

    <GetRightsDocRequest> ## GetRightsDocRequest
        (<package [name="{name}"] /> ## PackageSelector)*
    </GetRightsDocRequest>

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

XPath Required / Optional Description
/package Optional (0 or more) Packages
/package@name Optional (0 or 1) Type:String
Name

GetRightsDocResponse

    <GetRightsDocResponse> ## GetRightsDocResponse
        (<package [name="{name}"]> ## PackageRightsInfo
            (<cmd [name="{name}"]> ## CmdRightsInfo
                <rights>
                    (<right [name="..."] /> ## NamedElement)*
                </rights>
                <desc>
                    (<note>{notes} (String)</note>)*
                </desc>
              </cmd>)*
          </package>)*
        (<notUsed>{notUsed} (String)</notUsed>)*
        <domainAdmin-copypaste-to-zimbra-rights-domainadmin-xml-template>
            (<right name="{dom-admin-right-name}" type="{right-type} (preset|getAttrs|setAttrs|combo)"> ## DomainAdminRight
                <desc>{desc} (String)</desc>
                <rights>
                    (<r [n="{right-name}"] /> ## RightWithName)*
                </rights>
              </right>)*
        </domainAdmin-copypaste-to-zimbra-rights-domainadmin-xml-template>
    </GetRightsDocResponse>

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

XPath Required / Optional Description
/package Optional (0 or more) Information for packages
/package@name Optional (0 or 1) Type:String
Name
/package/cmd Optional (0 or more) Command rights information
/package/cmd@name Optional (0 or 1) Type:String
Name
/package/cmd/rights Required (only 1)
/package/cmd/rights/right Optional (0 or more)
/package/cmd/rights/right@name Optional (0 or 1) Type:String
Name
/package/cmd/desc Required (only 1)
/package/cmd/desc/note Optional (0 or more) Type:{notes} (String)
/notUsed Optional (0 or more) Type:{notUsed} (String)
Unused Admin rights
/domainAdmin-copypaste-to-zimbra-rights-domainadmin-xml-template Required (only 1)
/domainAdmin-copypaste-to-zimbra-rights-domainadmin-xml-template/right Optional (0 or more)
/domainAdmin-copypaste-to-zimbra-rights-domainadmin-xml-template/right@name Required (only 1) Type:String
Domain admin right name
/domainAdmin-copypaste-to-zimbra-rights-domainadmin-xml-template/right@type Required (only 1) Type:preset|getAttrs|setAttrs|combo
Right type
/domainAdmin-copypaste-to-zimbra-rights-domainadmin-xml-template/right/desc Required (only 1) Type:{desc} (String)
Description
/domainAdmin-copypaste-to-zimbra-rights-domainadmin-xml-template/right/rights Required (only 1)
/domainAdmin-copypaste-to-zimbra-rights-domainadmin-xml-template/right/rights/r Optional (0 or more)
/domainAdmin-copypaste-to-zimbra-rights-domainadmin-xml-template/right/rights/r@n Optional (0 or 1) Type:String
Right name