Overview | Service | Command |
Check if the authed user has the specified right(s) on a target.
Authorization token required | true |
Admin Authorization token required | false |
<CheckRightsRequest> ## CheckRightsRequest
(<target
type="{target-type} (account|calresource|cos|dl|group|domain|server|alwaysoncluster|ucservice|xmppcomponent|zimlet|config|global)"
by="{target-by} (id|name)" key="{target-key}"> ## CheckRightsTargetSpec
(<right>{rights} (String)</right>)+
</target>)+
</CheckRightsRequest>
The following table describes elements and attributes you can define within a
<CheckRightsRequest>
element:
XPath | Required / Optional | Description |
/target | Required (1 or more) | The targets |
/target@type | Required (only 1) | Type:account|calresource|cos|dl|group|domain|server|alwaysoncluster|ucservice|xmppcomponent|zimlet|config|global Target type |
/target@by | Required (only 1) | Type:id|name Selects the meaning of {target-key} |
/target@key | Required (only 1) | Type:String Key for target. If {target-by} is id this key is the zimbraId of the target entry If {target-by} is name this key is the name of the target entry |
/target/right | Required (1 or more) | Type:{rights} (String) Rights |
<CheckRightsResponse> ## CheckRightsResponse
(<target
type="{target-type} (account|calresource|cos|dl|group|domain|server|alwaysoncluster|ucservice|xmppcomponent|zimlet|config|global)"
by="{target-by} (id|name)" key="{target-key}" allow="{target-allow} (0|1)"> ## CheckRightsTargetInfo
(<right allow="{right-allow} (0|1)">{right}</right> ## CheckRightsRightInfo)+
</target>)+
</CheckRightsResponse>
The following table describes elements and attributes you can define within a
<CheckRightsResponse>
element:
XPath | Required / Optional | Description |
/target | Required (1 or more) | Rights information for targets |
/target@type | Required (only 1) | Type:account|calresource|cos|dl|group|domain|server|alwaysoncluster|ucservice|xmppcomponent|zimlet|config|global Target type |
/target@by | Required (only 1) | Type:id|name Selects the meaning of {target-key} |
/target@key | Required (only 1) | Type:String Key for target. If {target-by} is id this key is the zimbraId of the target entry If {target-by} is name this key is the name of the target entry |
/target@allow | Required (only 1) | Type:0|1 This is the AND value of all requested rights for the target |
/target/right | Required (1 or more) | Type:{right} Information on the rights Description for element text content:Name of right |
/target/right@allow | Required (only 1) | Type:0|1 Flags whether the authed user has the right on the target
|