Service: zimbraAdmin

Command: GetAllRights
Namespace: urn:zimbraAdmin
Description: Get all system defined rights
Properties:
Authorization token required true
Admin Authorization token required true

GetAllRightsRequest

    <GetAllRightsRequest [targetType="{target-type}"] [expandAllAttrs="{expand-all-attrs} (0|1)"]
                            [rightClass="{right-class-to-return}"] /> ## GetAllRightsRequest

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

XPath Required / Optional Description
@targetType Optional (0 or 1) Type: String
Target type on which a right is grantable
e.g. createAccount right is only grantable on domain entries and the globalgrant entry.
Don't confuse this with "whether a right is executable on a target type".
e.g. the renameAccount right is "executable" on account entries, but it is "grantable" on account, distribuiton list, domain, and globalgrant entries.
@expandAllAttrs Optional (0 or 1) Type: 0|1
Flags whether to include all attribute names in the <attrs> elements in GetRightResponse if the right is meant for all attributes
@rightClass Optional (0 or 1) Type: String
Right class to return
ADMIN return admin rights only
USER return user rights only
ALL return both admin rights and user rights

GetAllRightsResponse

    <GetAllRightsResponse> ## GetAllRightsResponse
        (<right name="{right-name}"
                    type="{right-type-getAttrs|setAttrs|combo|preset} (preset | getAttrs | setAttrs | combo)"
                    [targetType="{target-type}"] rightClass="{right-class} (ALL | ADMIN | USER)"> ## RightInfo
            <desc>{desc} (String)</desc>
            <attrs [all="{all-flag} (0|1)"]> ## RightsAttrs
                (<a n="{key}" /> ## Attr)*
             </attrs>
            <rights> ## ComboRights
                (<r n="{right-name}" type="{type} (preset | getAttrs | setAttrs | combo)" [targetType="{target-type}"] /> ## ComboRightInfo)*
             </rights>
          </right>)*
    </GetAllRightsResponse>

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

XPath Required / Optional Description
/right Optional (0 or more) Information for rights
/right@name Required (only 1) Type: String
Right name
/right@type Required (only 1) Type: preset | getAttrs | setAttrs | combo
Right type. Valid values : getAttrs | setAttrs | combo | preset
/right@targetType Optional (0 or 1) Type: String
Target type.
type=preset Always present (exactly target type)
type=getAttrs/setAttrs Always present (comma separated target types)
type=combo Always NOT present
/right@rightClass Required (only 1) Type: ALL | ADMIN | USER
Right class
ADMIN Admin right
USER User right
/right/desc Required (only 1) Type: {desc} (String)
Right description
/right/attrs Optional (0 or 1) Attrs
/right/attrs@all Optional (0 or 1) Type: 0|1
All flag
/right/attrs/a Optional (0 or more) Attrs
/right/attrs/a@n Required (only 1) Type: String
Key
/right/rights Optional (0 or 1) Rights
/right/rights/r Optional (0 or more) Rights information
/right/rights/r@n Required (only 1) Type: String
Right name
/right/rights/r@type Required (only 1) Type: preset | getAttrs | setAttrs | combo
Type
/right/rights/r@targetType Optional (0 or 1) Type: String
Target type