Service: zimbraAccount

Command: GetHAB
Namespace: urn:zimbraAccount
Description: Get the groups in a HAB org unit.
Properties:
Authorization token required true
Admin Authorization token required UNKNOWN

GetHABRequest

    <GetHABRequest habRootGroupId="{name}" /> ## GetHABRequest

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

XPath Required / Optional Description
@habRootGroupId Required (only 1) Type: String
HAB root group zimbra Id

GetHABResponse

    <GetHABResponse> ## GetHABResponse
        (<habGroups [rootHabGroup="{rootGroup indicator} (0|1)"] [parentHabGroupId="{parentGroupId}"]
                        [seniorityIndex="{seniorityIndex} (int)"]> ## HABGroup
            <id>{id} (String)</id>
            (<habGroups> ... </habGroups> ## See /habGroups [ ## HABGroup] # [inside itself])*
            (<attr name="{attr-name}" [pd="{attr-perm-denied} (0|1)"]>{value}</attr> ## Attr)*
            <name>{name} (String)</name>
          </habGroups>)*
    </GetHABResponse>

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

XPath Required / Optional Description
/habGroups Optional (0 or more) List of HabGroups under the root group
/habGroups@rootHabGroup Optional (0 or 1) Type: 0|1
indicates whether a HAB group is the parent group in the Hierarchy
/habGroups@parentHabGroupId Optional (0 or 1) Type: String
id of the parent group
/habGroups@seniorityIndex Optional (0 or 1) Type: int
seniorityIndex of the HAB group member
/habGroups/id Optional (0 or 1) Type: {id} (String)
id of the HAB group
/habGroups/habGroups Optional (0 or more) List of HabGroups under this HAB group
See /habGroups for more details.
/habGroups/attr Optional (0 or more) Type: {value}
Attributes of the HAB group
Description for element text content:Value of attribute
/habGroups/attr@name Required (only 1) Type: String
Name of attribute
/habGroups/attr@pd Optional (0 or 1) Type: 0|1
Flags whether permission has been denied (optional).
If 1 (true), flags that the real value of this attribute has not been provided.
The value is set to ""
/habGroups/name Required (only 1) Type: {name} (String)
HAB Member name - an email address (user@domain)