| Authorization token required | true |
| Admin Authorization token required | false |
<DistributionListActionRequest> ## DistributionListActionRequest
<dl by="{dl-selector-by} (id | name)">{key}</dl> ## DistributionListSelector
<action
op="{operation} (delete | modify | rename | addOwners | removeOwners | setOwners | grantRights | revokeRights | setRights | addMembers | removeMembers)"> ## DistributionListAction
(<dlm>{members} (String)</dlm>)*
<newName>{newName} (String)</newName>
(<owner type="{dl-grantee-type} (usr | grp | egp | all | dom | edom | gst | key | pub | email)"
by="{dl-grantee-by} (id | name)">{key}</owner> ## DistributionListGranteeSelector)*
(<right right="..."> ## DistributionListRightSpec
(<grantee type="{dl-grantee-type} (usr | grp | egp | all | dom | edom | gst | key | pub | email)"
by="{dl-grantee-by} (id | name)">{key}</grantee> ## See /action/owner [ ## DistributionListGranteeSelector])*
</right>)*
(<a n="{key}">{value}</a> ## KeyValuePair)*
</action>
(<a name="{attr-name}" [pd="{attr-perm-denied} (0|1)"]>{value}</a> ## Attr)*
</DistributionListActionRequest>
elements and attributes you can define within a
<DistributionListActionRequest> element:
| XPath | Required / Optional | Description | ||||||||||||||||||||||
| /dl | Required (only 1) | Type: {key} Identifies the distribution list to act upon Description for element text content:The key used to identify the account. Meaning determined by {dl-selector-by} |
||||||||||||||||||||||
| /dl@by | Required (only 1) | Type: id | name Select the meaning of {dl-selector-key} |
||||||||||||||||||||||
| /action | Required (only 1) | Specifies the action to perform | ||||||||||||||||||||||
| /action@op | Required (only 1) | Type: delete | modify | rename | addOwners | removeOwners | setOwners | grantRights | revokeRights | setRights | addMembers | removeMembers Operation to perform.
|
||||||||||||||||||||||
| /action/dlm | Optional (0 or more) | Type: {members} (String) Group members Required if op="addMembers" or op="removeMembers" |
||||||||||||||||||||||
| /action/newName | Optional (0 or 1) | Type: {newName} (String) New Name Required if op="rename" |
||||||||||||||||||||||
| /action/owner | Optional (0 or more) | Type: {key} Owner Required if op="addOwners" or op="removeOwners", Optional if op="setOwners". If not present when op="setOwners" all current owners will be removed. Description for element text content:Value of selector. Meaning depends on value of {dl-grantee-by} |
||||||||||||||||||||||
| /action/owner@type | Required (only 1) | Type: usr | grp | egp | all | dom | edom | gst | key | pub | email Grantee type |
||||||||||||||||||||||
| /action/owner@by | Required (only 1) | Type: id | name Selects meaning of {dl-grantee-key} |
||||||||||||||||||||||
| /action/right | Optional (0 or more) | Rights
Required if op="grantRight", op="revokeRight", op="setRight". |
||||||||||||||||||||||
| /action/right@right | Required (only 1) | Type: String Right |
||||||||||||||||||||||
| /action/right/grantee | Optional (0 or more) | Type: {key} Grantees Description for element text content:Value of selector. Meaning depends on value of {dl-grantee-by} See /action/owner for more details. |
||||||||||||||||||||||
| /action/a | Optional (0 or more) | Type: {value} Attributes specified as key value pairs Description for element text content:Value |
||||||||||||||||||||||
| /action/a@n | Required (only 1) | Type: String Key |
||||||||||||||||||||||
| /a | Optional (0 or more) | Type: {value} Attributes Description for element text content:Value of attribute |
||||||||||||||||||||||
| /a@name | Required (only 1) | Type: String Name of attribute |
||||||||||||||||||||||
| /a@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 "" |
<DistributionListActionResponse /> ## DistributionListActionResponse