zimbra_wsdl 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,806 @@
1
+ -----------------------------
2
+ urn:zimbraAdmin
3
+ -----------------------------
4
+
5
+ ----------------------------------------------------------
6
+ Grant a right on a target to an individual or group grantee.
7
+
8
+ <GrantRightRequest>
9
+ <target type={target-type} by="{target-by}">{target-name-or-id}</target>
10
+ <grantee type={grantee-type} by="{grantee-by}" [secret="{secret}"]>{grantee-name-or-id}</grantee>
11
+ <right [deny="${deny}"] [canDelegate="${canDelegate}"]
12
+ [disinheritSubGroups="${disinheritSubGroups}"] [subDomain="${subDomain}"]>
13
+ {right}
14
+ </right>
15
+ </GrantRightRequest>
16
+
17
+ {target-type} = account | calresource | dl | domain | cos | server | xmppcomponent | zimlet | config | global
18
+
19
+ {target-by} = name | id
20
+
21
+ {grantee-type} = usr | grp | all | dom | gst | key | pub
22
+ all: user right only
23
+ dom: user right only unless the right is crossDomainAdmin
24
+ gst: user right only
25
+ key: user right only
26
+ pub: user right only
27
+
28
+ {grantee-by} = name | id
29
+
30
+ {secret} : for user right only
31
+ password for guest grantee or the access key for key grantee
32
+
33
+ {deny} = 1 | 0(default)
34
+
35
+ {canDelegate} = 1 | 0(default)
36
+
37
+ {disinheritSubGroups} = 1 | 0(default)
38
+
39
+ {subDomain} = 1 | 0(default)
40
+
41
+ {right} = {right-name} | {inline-right}
42
+
43
+ {right-name} = a system defined right name
44
+
45
+ {inline-right} = {op}.{target-type}.{attr-name}
46
+
47
+ {op} = set | get
48
+
49
+ {attr-name} = a valid attribute name on the specified target type
50
+
51
+
52
+
53
+ <GrantRightResponse/>
54
+
55
+
56
+ ----------------------------------------------------------
57
+ Revoke a right from a target that was previously granted to
58
+ an individual or group grantee.
59
+
60
+
61
+ <RevokeRightRequest>
62
+ <target type={target-type} by="{target-by}">{target-name-or-id}</target>
63
+ <grantee type={grantee-type} by="{grantee-by}">{grantee-name-or-id}</grantee>
64
+ <right [deny="${deny}"] [canDelegate="${canDelegate}"]
65
+ [disinheritSubGroups="${disinheritSubGroups}"] [subDomain="${subDomain}"]>
66
+ {right-name}
67
+ </right>
68
+ </RevokeRightRequest>
69
+
70
+ <RevokeRightResponse/>
71
+
72
+ ----------------------------------------------------------
73
+ Check if a principal has the specified right on target.
74
+
75
+
76
+ <CheckRightRequest>
77
+ <target type={target-type} by="{target-by}">{target-name-or-id}</target>
78
+ <grantee by="{grantee-by}">{grantee-name-or-id}</grantee>
79
+ <right>{right-name}</right>
80
+ [<attrs>
81
+ <a n="...">...</a>+
82
+ </attrs>]
83
+ </CheckPermissionRequest>
84
+
85
+ {right-name}: right name
86
+ must be a preset, getAttrs, or setAttrs right, it cannot be a combo right.
87
+
88
+ If right is a setAttrs right, an attr/value map can be provided
89
+ in <attrs>, which contains the attrs/values that are attempted to
90
+ be modified. If one of the values to be modified violates one of
91
+ the constraint for the the attributes, the result in CheckRightResponse
92
+ will be allow="0". If attr/value map is not provided, system will just
93
+ check if all attributes defined by the setAttrs right are allowed,
94
+ without taking into account any constraint.
95
+
96
+
97
+
98
+ <CheckRightResponse allow="{1|0}">
99
+ [<via>
100
+ <target type={target-type}>{target-name-or-id}</target>
101
+ <grantee type={grantee-type}>{grantee-name-or-id}</grantee>
102
+ <right [deny="${deny}"]>{right-name}</right>
103
+ <via>]
104
+ </CheckRightResponse>
105
+
106
+ A successful return means the principal specified by the <grantee> is allowed
107
+ for the specified right on the target object.
108
+ If PERM_DENIED is thrown, it means the authed user does not have privilege
109
+ to run this SOAP command(has to be an admin because this command is in admin namespace).
110
+ Result of CheckRightRequest is in the allow="1|0" attribute in CheckRightResponse.
111
+ <via> in the CheckRightResponse is the grant that decisively
112
+ lead to the result.
113
+
114
+ e.g. if a combo right C containing renameAccount is granted to group G on domain D, and
115
+ admin A is in group G, then
116
+ <CheckRightRequest>
117
+ <target type="account"> by="name">user1@D</target>
118
+ <grantee by="name">admin@D</grantee>
119
+ <right>renameAccount</right>
120
+ </CheckRightRequest>
121
+
122
+ will return:
123
+ <CheckRightResponse hasRight="1">
124
+ <via>
125
+ <target type=domain>D</target>
126
+ <grantee type=grp>G</grantee>
127
+ <right>C</right>
128
+ </via>
129
+ </CheckRightResponse>
130
+
131
+ Note, <via> is optional. If the right of interest is not granted at all, there will be no <via>
132
+ in the response. Also, <via> will probably be hairy for rights that modify/get
133
+ selective attrs, it may not be returned for those rights. TDB...
134
+
135
+ e.g.
136
+ <CheckRightRequest>
137
+ <target type="account"> by="name">user1@D</target>
138
+ <grantee by="name">admin@D</grantee>
139
+ <right>configureQuota</right>
140
+ <attrs>
141
+ <a n="zimbraMailQuota">100000</a>
142
+ <a n="zimbraQuotaWarnPercent">80</a>
143
+ <attrs>
144
+ </CheckRightRequest>
145
+
146
+ <CheckRightResponse hasRight="0">
147
+
148
+
149
+ ----------------------------------------------------------
150
+ Returns all grants on the specified target entry, or all grants
151
+ granted to the specified grantee entry.
152
+ The authenticated admin must have an effective "viewGrants" (TBD) system
153
+ right on the specified target/grantee.
154
+
155
+ At least one of <target> or <grantee> must be specified.
156
+ If both <target> and <grantee> are specified, only grants that are granted
157
+ on the target to the grantee are returned.
158
+
159
+
160
+ <GetGrantsRequest>
161
+ [<target type={target-type} by="{target-by}">{target-name-or-id}</target>]
162
+ [<grantee type={grantee-type} by="{grantee-by}">{grantee-name-or-id} all={0|1(default)}</grantee>]
163
+ </GetGrantsRequest>
164
+
165
+
166
+ all = whether to include grants granted to groups the specified grantee belongs to.
167
+ 1: include (default)
168
+ 0: do not include
169
+
170
+ <GetGrantsResponse>
171
+ <grant>
172
+ <target type={target-type} by="{target-by}">{target-name-or-id}</target>
173
+ <grantee type={grantee-type} by="{grantee-by}">{grantee-name-or-id}</grantee>
174
+ <right [deny="${deny}"] [canDelegate="${canDelegate}"]
175
+ [disinheritSubGroups="${disinheritSubGroups}"] [subDomain="${subDomain}"]>
176
+ {right}
177
+ </right>
178
+ </grant>+
179
+ </GetGrantsResponse>
180
+
181
+
182
+ ----------------------------------------------------------
183
+ Returns *effective* *admin* rights the authenticated admin has on the specified target entry.
184
+
185
+ Effective rights are the rights the admin is actually allowed. It is the net result of
186
+ applying ACL checking rules given the target and grantee. Specifically denied rights
187
+ will *not* be returned.
188
+
189
+ The result can help the admin console decide on what tabs to display after a target
190
+ is selected. For example, after user1 is selected, if the admin does not have right
191
+ to setPassword, it should probably hide or gray out the setPassword tab.
192
+
193
+
194
+ <GetEffectiveRightsRequest expandAllAttrs="{expand-all-attrs}">
195
+ <target type={target-type} by="{target-by}">{target-name-or-id}</target>
196
+ [<grantee by="{grantee-by}">{grantee-name-or-id}</grantee>]
197
+ </GetEffectiveRightsRequest>
198
+
199
+ if <grantee> is omitted, it means the account identified by the auth token.
200
+
201
+ {expand-all-attrs} : whether to include all attribute names in the <getAttrs>/<setAttrs> elements in
202
+ GetEffectiveRightsResponse if all attributes of the target are gettable/settable
203
+
204
+ comma separated values of "getAttrs", "setAttrs"
205
+
206
+ e.g. getAttrs - expand attrs in getAttrs in GetEffectiveRightsResponse
207
+ setAttrs - expand attrs in setAttrs in GetEffectiveRightsResponse
208
+ getAttrs,setAttrs - expand attrs in both getAttrs and setAttrs in GetEffectiveRightsResponse
209
+
210
+ - when all="1" in setAttrs/getAttrs in GetEffectiveRightsResponse:
211
+ 0: do not expand attributes
212
+ 1: expand all attributes
213
+ - when all is not present or is 0 in setAttrs/getAttrs in GetEffectiveRightsResponse:
214
+ value of {whether-to-expand-all-attrs} does not apply. Allowed attributes are always
215
+ returned in setAttrs/getAttrs in GetEffectiveRightsResponse.
216
+
217
+ <GetEffectiveRightsResponse>
218
+ <grantee id="{grantee-id}" name="{grantee-name}">
219
+ <target type="{target-type}" [id"{target-id}"] [name="{target-name}"]>
220
+ <right n="{right-name}"/>+
221
+ <setAttrs [all="{all}"]>
222
+ <a n="...">
223
+ [<default>
224
+ <v>...</v>+
225
+ </default>]
226
+ [<constraint>
227
+ [<min>{min}</min>]
228
+ [<max>{max}</max>]
229
+ [<values>
230
+ <v>...</v>+
231
+ </values>]
232
+ </constraint>]
233
+ </a>+
234
+ </setAttrs>
235
+ <getAttrs [all="{all}"]>
236
+ <a n="...">
237
+ [<default>
238
+ <v>...</v>+
239
+ </default>]
240
+ </a>+
241
+ </getAttrs>
242
+ </target>
243
+ </GetEffectiveRightsResponse>
244
+
245
+ <right> : all effective system rights
246
+ - getAttrs/setAttrs rights will not appear in the list because they will be
247
+ expanded to a list of attributes that can be get/set, which appear in the
248
+ <getAttrs> and <setAttrs> elements in the response.
249
+ - Combo rights will not appear in the list because they will be expanded to
250
+ system rights and/or a set of attributes that can be get/set.
251
+ <setAttrs> : all attrs can be set
252
+ <getAttrs> : all attrs can be get
253
+
254
+ {all} : 0(default) | 1
255
+ 1 - all attributes on the target entry are accessible
256
+ if 1, no <a> elements will appear under the <setAttrs>/<getAttrs>
257
+
258
+ <default> : inherited default value(or values if the attribute is multl-valued)
259
+
260
+ e.g.
261
+ <GetEffectiveRightsRequest>
262
+ <target type="account" by="id">bba95d7d-0b13-401f-a343-03a8f5a96f7c"/>
263
+ <grantee by="name">admin@test.com</grantee>
264
+ </GetEffectiveRightsRequest>
265
+
266
+ <GetEffectiveRightsResponse>
267
+ <grantee name="admin@test.com</grantee" id=""/>
268
+ <target type="account" name="user1@test.com" id="bba95d7d-0b13-401f-a343-03a8f5a96f7c">
269
+ <right n="setPassword"/>
270
+ <right n="renameAccount"/>
271
+ <right n="deleteAccount"/>
272
+ <setAttrs>
273
+ <a n="zimbraMailQuota" min="100000000"/>
274
+ <a n="zimbraMailStatus"/>
275
+ <a n="zimbraFeatureMailEnabled" values="TRUE,FALSE"/>
276
+ ...
277
+ </setAttrs>
278
+ <getAttrs>
279
+ <a n="..."/>
280
+ <a n="..."/>
281
+ ...
282
+ </getAttrs>
283
+ </target>
284
+ </GetEffectiveRightsRequest>
285
+
286
+
287
+ ----------------------------------------------------------
288
+ Returns attributes, with defaults and constraints if any, that can be set by the authed admin when an
289
+ object is created.
290
+
291
+ GetCreateObjectAttrsRequest returns the equivalent of setAttrs portion of GetEffectiveRightsResponse.
292
+ GetCreateObjectAttrsRequest is needed becasue GetEffectiveRightsRequest requires a target, but when we are
293
+ creating a object, the target object does not exist yet.
294
+
295
+ The result can help the admin console decide on what tabs/attributes to display for creating objects.
296
+
297
+
298
+ <GetCreateObjectAttrsRequest>
299
+ <target type="{target-type}">
300
+ [<domain by="{domain-by}">...</domain>]
301
+ [<cos by="{cos-by}">...</cos>]
302
+ </GetCreateObjectAttrsRequest>
303
+
304
+ <domain> : required if {target-type} is account/calresource/dl/domain, ignored otherwise
305
+ - if {target-type} is account/calresource/dl: this is the domain in whcih the object will be in.
306
+ the domain can be speciffied by id or by name
307
+ - if {target-type} is domain, it is the domain name to be created.
308
+ e.g. to create a subdomain named foo.bar.test.com, should pass in <domain by="name">foo.bar.test.com</domain>.
309
+
310
+
311
+ <cos> : optional if {target-type} is account/calresource, ignored otherwise
312
+ if missing, default cos of the domain will be used
313
+
314
+ e.g. 1 creating an account:
315
+
316
+ <GetCreateObjectAttrsRequest>
317
+ <target type="account"/>
318
+ <domain by="name">test.com</domain>
319
+ <cos by="name">standard</cos>
320
+ </GetCreateObjectAttrsRequest>
321
+
322
+ <GetCreateObjectAttrsResponse>
323
+ <setAttrs>
324
+ <a n="zimbraMailQuota"/>
325
+ <constraint>
326
+ <min>1</min>
327
+ <max>3</max>
328
+ </constraint>
329
+ <default>
330
+ <v>2</v>
331
+ </default>
332
+ <a n="zimbraMailStatus"/>
333
+ <a n="zimbraFeatureCalendarEnabled"/>
334
+ ...
335
+ </setAttrs>
336
+ </GetCreateObjectAttrsResponse>
337
+
338
+
339
+ e.g. 2 creating a server:
340
+
341
+ <GetCreateObjectAttrsRequest>
342
+ <target type="server"/>
343
+ </GetCreateObjectAttrsRequest>
344
+
345
+ <GetCreateObjectAttrsResponse>
346
+ <target type="server"/>
347
+ <setAttrs>
348
+ <a n="zimbraLmtpExposeVersionOnBanner"/>
349
+ <a n="zimbraXMPPServerDialbackKey"/>
350
+ <a n="zimbraReverseProxyImapEnabledCapability"/>
351
+ <constraint>
352
+ <values>
353
+ <v>IMAP4rev1</v>
354
+ <v>BINARY</v>
355
+ </values>
356
+ </constraint>
357
+ ...
358
+ </setAttrs>
359
+ </GetCreateObjectAttrsResponse>
360
+
361
+ ----------------------------------------------------------
362
+ Get all effective *admin* rights.
363
+
364
+
365
+ <GetAllEffectiveRightsRequest>
366
+ <grantee type={grantee-type} by="{grantee-by}">{grantee-name-or-id}</grantee>
367
+ </GetAllEffectiveRightsRequest>
368
+
369
+
370
+ <GetAllEffectiveRightsResponse>
371
+ <grantee id="{grantee-id}" name="{grantee-name}">
372
+ <target type="{target-type}">
373
+ {right-specifiers}
374
+ </target>+
375
+ </GetAllEffectiveRightsResponse>
376
+
377
+ {right-specifiers} =
378
+ - if target type is account, calresource, dl: {domained-entries-right-specifiers}
379
+ - otherwise: {non-domained-entries-right-specifiers}
380
+
381
+ {domained-entries-right-specifiers} =
382
+ <all>
383
+ {effective-rights}
384
+ </all>
385
+ [<inDomains>
386
+ <domain name="{domain-name}">+
387
+ {effective-rights}
388
+ <inDomains>]+
389
+ [<entries>
390
+ <entry name="{name}">+
391
+ {effective-rights}
392
+ </entries>]+
393
+
394
+ {non-domained-entries-right-specifiers} =
395
+ <all>
396
+ {effective-rights}
397
+ </all>
398
+ [<entries>
399
+ <entry name="{name}">+
400
+ {effective-rights}
401
+ </entries>]+
402
+
403
+ {effective-rights} =
404
+ <rights>
405
+ <right n="..."/>+
406
+ <setAttrs>
407
+ <a n="..."/>+
408
+ </setAttrs>
409
+ <getAttrs>
410
+ <a n="..."/>+
411
+ </getAttrs>
412
+ </rights>
413
+
414
+
415
+ e.g.
416
+
417
+ <GetAllEffectiveRightsRequest xmlns="urn:zimbraAdmin">
418
+ <grantee type="usr" by="name">admin1@test.com</grantee>
419
+ </GetAllEffectiveRightsRequest>
420
+
421
+ <GetAllEffectiveRightsResponse xmlns="urn:zimbraAdmin">
422
+ <grantee name="admin1@test.com" id="a13b4659-ea6a-4050-bb58-65a9559138d1"/>
423
+ <target type="cos">
424
+ <entries>
425
+ <entry name="cos2"/>
426
+ <entry name="cos1"/>
427
+ <rights>
428
+ <right n="assignCos"/>
429
+ <right n="listCos"/>
430
+ <setAttrs/>
431
+ <getAttrs all="1"/>
432
+ </rights>
433
+ </entries>
434
+ <entries>
435
+ <entry name="cos3"/>
436
+ <entry name="cos4"/>
437
+ <rights>
438
+ <right n="deleteCos"/>
439
+ <setAttrs all="1"/>
440
+ </rights>
441
+ </entries>
442
+ </target>
443
+ <target type="zimlet">
444
+ <all>
445
+ <right n="listZimlet"/>
446
+ <setAttrs/>
447
+ <getAttrs all="1"/>
448
+ </all>
449
+ </target>
450
+ <target type="account">
451
+ <inDomains>
452
+ <domain name="domain1.com"/>
453
+ <domain name="domain2.com"/>
454
+ <rights>
455
+ <right n="addAccountAlias"/>
456
+ <right n="adminLoginAs"/>
457
+ <setAttrs>
458
+ <a n="c"/>
459
+ ...
460
+ <a n="zimbraAccountCalendarUserType"/>
461
+ <a n="zimbraAccountStatus"/>
462
+ <a n="zimbraAdminAuthTokenLifetime">
463
+ <default>
464
+ <v>12h</v>
465
+ </default>
466
+ </a>
467
+ <a n="zimbraAdminSavedSearches"/>
468
+ ...
469
+ <a n="zimbraZimletAvailableZimlets">
470
+ <default>
471
+ <v>com_zimbra_ymemoticons</v>
472
+ <v>com_zimbra_local</v>
473
+ </default>
474
+ </a>
475
+ ...
476
+ </setAttrs>
477
+ <getAttrs all="1"/>
478
+ </rights>
479
+ </inDomains>
480
+ <inDomains>
481
+ <domain name="domain3.com"/>
482
+ <domain name="domain4.com"/>
483
+ <rights>
484
+ <right n="renameAccount"/>
485
+ <right n="adminLoginAs"/>
486
+ <setAttrs>
487
+ <a n="zimbraAccountCalendarUserType"/>
488
+ <a n="zimbraAccountStatus"/>
489
+ ...
490
+ </setAttrs>
491
+ <getAttrs all="1"/>
492
+ </rights>
493
+ </inDomains>
494
+ <entries>
495
+ <entry name="user1@domain1.com"/>
496
+ <entry name="user2@domain1.com"/>
497
+ <rights>
498
+ <right n="renameAccount"/>
499
+ <setAttrs>
500
+ <a n="zimbraAccountStatus"/>
501
+ ...
502
+ </setAttrs>
503
+ <getAttrs all="1"/>
504
+ </rights>
505
+ </entries>
506
+ <entries>
507
+ <entry name="user3@domain1.com"/>
508
+ <entry name="user4@domain1.com"/>
509
+ <rights>
510
+ <right n="addAccountAlias"/>
511
+ <right n="removeAccountAlias"/>
512
+ <right n="setAccountPassword"/>
513
+ <setAttrs>
514
+ </setAttrs>
515
+ <getAttrs/>
516
+ </rights>
517
+ </entries>
518
+ </target>
519
+ <target type="calresource">
520
+ <inDomains>
521
+ <domain name="domain1.com"/>
522
+ <domain name="domain2.com"/>
523
+ <rights>
524
+ <right n="addCalendarResourceAlias"/>
525
+ <right n="deleteCalendarResource"/>
526
+ <right n="listCalendarResource"/>
527
+ <right n="purgeCalendarResourceCalendarCache"/>
528
+ <right n="removeCalendarResourceAlias"/>
529
+ <right n="renameCalendarResource"/>
530
+ <right n="setCalendarResourcePassword"/>
531
+ <setAttrs>
532
+ <a n="c"/>
533
+ ...
534
+ </setAttrs>
535
+ <getAttrs all="1"/>
536
+ </rights>
537
+ </inDomains>
538
+ </target>
539
+ <target type="xmppcomponent"/>
540
+ <target type="server"/>
541
+ <target type="config"/>
542
+ <target type="global"/>
543
+ <target type="domain">
544
+ <entries>
545
+ <entry name="domain1.com"/>
546
+ <entry name="domain2.com"/>
547
+ <rights>
548
+ <right n="accessGAL"/>
549
+ <right n="checkDomainMXRecord"/>
550
+ <right n="countAccount"/>
551
+ <right n="createAccount"/>
552
+ <right n="createAlias"/>
553
+ <right n="createCalendarResource"/>
554
+ <right n="createDistributionList"/>
555
+ <right n="deleteAlias"/>
556
+ <right n="listDomain"/>
557
+ <setAttrs>
558
+ <a n="description"/>
559
+ <a n="zimbraAdminConsoleLoginURL"/>
560
+ ...
561
+ </setAttrs>
562
+ <getAttrs all="1"/>
563
+ </rights>
564
+ </entries>
565
+ </target>
566
+ <target type="dl">
567
+ <inDomains>
568
+ <domain name="domain1.com"/>
569
+ <domain name="domain2.com"/>
570
+ <rights>
571
+ <right n="addDistributionListAlias"/>
572
+ <right n="addDistributionListMember"/>
573
+ <right n="deleteDistributionList"/>
574
+ <right n="getDistributionListMembership"/>
575
+ <right n="getDistributionListShareInfo"/>
576
+ <right n="listDistributionList"/>
577
+ <right n="publishDistributionListShareInfo"/>
578
+ <right n="removeDistributionListAlias"/>
579
+ <right n="removeDistributionListMember"/>
580
+ <right n="renameDistributionList"/>
581
+ <right n="viewDistributionListAdminUI"/>
582
+ <setAttrs>
583
+ <a n="cn"/>
584
+ <a n="description"/>
585
+ <a n="displayName"/>
586
+ <a n="zimbraHideInGal"/>
587
+ <a n="zimbraLocale"/>
588
+ <a n="zimbraMailCanonicalAddress"/>
589
+ <a n="zimbraMailForwardingAddress"/>
590
+ <a n="zimbraMailStatus"/>
591
+ <a n="zimbraNotes"/>
592
+ </setAttrs>
593
+ <getAttrs all="1"/>
594
+ </rights>
595
+ </inDomains>
596
+ <inDomains>
597
+ <domain name="domain3.com"/>
598
+ <rights>
599
+ <right n="publishDistributionListShareInfo"/>
600
+ <setAttrs>
601
+ <a n="zimbraMailCanonicalAddress"/>
602
+ <a n="zimbraMailForwardingAddress"/>
603
+ <a n="zimbraMailStatus"/>
604
+ <a n="zimbraNotes"/>
605
+ </setAttrs>
606
+ <getAttrs all="1"/>
607
+ </rights>
608
+ </inDomains>
609
+ <entries>
610
+ <entry name="dl1@domain1.com"/>
611
+ <entry name="dl2@domain1.com"/>
612
+ <rights>
613
+ <right n="addDistributionListAlias"/>
614
+ <right n="addDistributionListMember"/>
615
+ <setAttrs>
616
+ <a n="zimbraMailCanonicalAddress"/>
617
+ <a n="zimbraMailForwardingAddress"/>
618
+ <a n="zimbraMailStatus"/>
619
+ <a n="zimbraNotes"/>
620
+ </setAttrs>
621
+ <getAttrs all="1"/>
622
+ </rights>
623
+ </entries>
624
+ <entries>
625
+ <entry name="dl3@domain1.com"/>
626
+ <entry name="dl4@domain1.com"/>
627
+ <rights>
628
+ <setAttrs>
629
+ <a n="zimbraMailCanonicalAddress"/>
630
+ <a n="zimbraMailForwardingAddress"/>
631
+ <a n="zimbraMailStatus"/>
632
+ <a n="zimbraNotes"/>
633
+ </setAttrs>
634
+ <getAttrs all="1"/>
635
+ </rights>
636
+ </entries>
637
+ </target>
638
+ </GetAllEffectiveRightsResponse>
639
+
640
+
641
+ ----------------------------------------------------------
642
+ Returns the union of the zimbraAdminConsoleUIComponents values on the
643
+ specified account/dl entry and that on all admin groups the entry
644
+ belongs.
645
+
646
+
647
+ <GetAdminConsoleUICompRequest>
648
+ [<account by="id|name">...</account>]
649
+ [<dl by="id|name">...</dl>]
650
+ </GetAdminConsoleUICompRequest>
651
+
652
+ Note: if neither account nor dl is specified, the authed admin account will
653
+ be used as the perspective entry.
654
+
655
+ <GetAdminConsoleUICompResponse>
656
+ <a inherited="{inherited}">...</a>+
657
+ </GetAdminConsoleUICompResponse>
658
+
659
+ {inherited} = 0 | 1
660
+ 0: set directly on the entry
661
+ 1: inherited from a group
662
+
663
+ ----------------------------------------------------------
664
+ Get definition of a right.
665
+
666
+
667
+ <GetRightRequest [expandAllAttrs="{expand-all-attrs}"]>
668
+ <right>{right-name}</right>
669
+ </GetRightRequest>
670
+
671
+ {expand-all-attrs} : whether to include all attribute names in the <attrs> elements in
672
+ GetRightResponse if the right is meant for all attributes
673
+ 0: default, do not include all attribute names in the <attrs> elements
674
+ 1: include all attribute names in the <attrs> elements
675
+
676
+ <GetRightResponse>
677
+ <right name="{right-name}" type="{right-type}" rightClass="{right-class} [targetType="{target-type}"]>
678
+ <desc>{right-description}</desc>
679
+ [<attrs [all="1"]>
680
+ [<a n="{attr-name}"/>+]
681
+ </attrs>]
682
+ [<rights>
683
+ <r n="{right-name}" type="{right-type}" [targetType="{target-type}"]/>+
684
+ </rights>]
685
+ </right>
686
+ </GetRightResponse>
687
+
688
+ {right-name}: right name
689
+
690
+ {right-type}: getAttrs | setAttrs | combo | preset
691
+
692
+ {target-type}: if {right-type} is:
693
+ - preset: always present (exactly target type)
694
+ - getAttrs/setAtrts: always present (comma-separated target types)
695
+ - combo: always not present
696
+
697
+ right-class: right class
698
+ ADMIN: admin right
699
+ USER: user right
700
+
701
+ ----------------------------------------------------------
702
+ Get all system defined rights.
703
+
704
+
705
+ <GetAllRightsRequest [targetType="{target-type}"] [expandAllAttrs="{expand-all-attrs}"] [rightClass={right-class}]/>
706
+
707
+ {target-type} : target type on which a right is grantable
708
+ e.g. createAccount right is only grantable on domain entries and the globalgrant
709
+ entry.
710
+ Don't confuse this with "whether a right is executable on a target type".
711
+ e.g. the renameAccount right is "executable" on account entries, but it is "grantable"
712
+ on account, distribuiton list, domain, and globalgrant entries.
713
+
714
+ {expand-all-attrs} : whether to include all attribute names in the <attrs> elements in
715
+ GetRightResponse if the right is meant for all attributes
716
+ 0: default, do not include all attribute names in the <attrs> elements
717
+ 1: include all attribute names in the <attrs> elements
718
+
719
+ {right-class} : right class
720
+ ADMIN: return admin rights only
721
+ USER: return user rights only
722
+ ALL: return oth admin rights and user rights
723
+
724
+
725
+
726
+ <GetAllRightsResponse>
727
+ <right name="{right-name}" type="{right-type}" rightClass="{right-class} [targetType="{target-type}"]">
728
+ <desc>{right-description}</desc>
729
+ [<attrs all="1">
730
+ [<a n="{attr-name}"/>+]
731
+ </attrs>]
732
+ [<rights>
733
+ <r n="{right-name}"/>+
734
+ </rights>]
735
+ </right>+
736
+ </GetAllRightsResponse>
737
+
738
+ right-class: right class
739
+ ADMIN: admin right
740
+ USER: user right
741
+
742
+ See <GetRightResponse> for description of each <right> in the response.
743
+
744
+ ----------------------------------------------------------
745
+ Get constraints (zimbraConstraint) for delegated admin on global config or a cos
746
+
747
+ <GetDelegatedAdminConstraintsRequest type="config|cos" [id="..."] [name="..."]>
748
+ [<a name="{attr-name}">+]
749
+ </GetDelegatedAdminConstraintsRequest>
750
+
751
+ type: - if set to config, id and name is ignored
752
+ will retrieve constraints on global config
753
+ - if set to cos, either id or name has to be specified to identify the cos
754
+
755
+ none or several attributes can be specified for which constraints are to be returned.
756
+ If no attribute is specified, all constraints on the global config/cos will be returned.
757
+
758
+ If there is no constraint for a requested attribute, <a> element for the attribute
759
+ will not appear in the response.
760
+
761
+ <GetDelegatedAdminConstraintsResponse type="config|cos" [id="..."] [name="..."]>
762
+ [<a n="...">
763
+ <constraint>
764
+ [<min>{min}</min>]
765
+ [<max>{max}</max>]
766
+ [<values>
767
+ <v>...</v>+
768
+ </values>]
769
+ </constraint>
770
+ </a>+]
771
+ </GetDelegatedAdminConstraintsResponse>
772
+
773
+ e.g.
774
+
775
+ <GetDelegatedAdminConstraintsRequest type="cos" name="cos1">
776
+ <a name="zimbraMailQuota">
777
+ </GetDelegatedAdminConstraintsRequest>
778
+
779
+ <GetDelegatedAdminConstraintsResponse type="cos" id="e00428a1-0c00-11d9-836a-000d93afea2a" name="cos1">
780
+ <a n="zimbraMailQuota">
781
+ <constraint>
782
+ <max>524288000</max>
783
+ <min>20971520</min>
784
+ </constraint>
785
+ </a>
786
+ </GetDelegatedAdminConstraintsResponse>
787
+
788
+ ----------------------------------------------------------
789
+ Modify constraint (zimbraConstraint) for delegated admin on global config or a cos
790
+
791
+ <ModifyDelegatedAdminConstraintsRequest type="config|cos" [id="..."] [name="..."]>
792
+ <a name="{attr-name}">
793
+ <constraint>
794
+ [<min>{min}</min>]
795
+ [<max>{max}</max>]
796
+ [<values>
797
+ <v>...</v>+
798
+ </values>]
799
+ </constraint>]
800
+ </a>
801
+ </ModifyDelegatedAdminConstraintsRequest>
802
+
803
+ If constraints for an attribute already exists, it will be replaced by the new constraints.
804
+ If <constraint> is an empty element, constraints for the attribute will be removed.
805
+
806
+ <ModifyDelegatedAdminConstraintsResponse/>