/
api-types-3.xsd
570 lines (525 loc) · 22.7 KB
/
api-types-3.xsd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
<?xml version="1.0" encoding="UTF-8"?>
<!--
~ Copyright (c) 2010-2017 Evolveum
~
~ Licensed under the Apache License, Version 2.0 (the "License");
~ you may not use this file except in compliance with the License.
~ You may obtain a copy of the License at
~
~ http://www.apache.org/licenses/LICENSE-2.0
~
~ Unless required by applicable law or agreed to in writing, software
~ distributed under the License is distributed on an "AS IS" BASIS,
~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
~ See the License for the specific language governing permissions and
~ limitations under the License.
-->
<xsd:schema targetNamespace="http://midpoint.evolveum.com/xml/ns/public/common/api-types-3"
xmlns:tns="http://midpoint.evolveum.com/xml/ns/public/common/api-types-3"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:c="http://midpoint.evolveum.com/xml/ns/public/common/common-3"
xmlns:a="http://prism.evolveum.com/xml/ns/public/annotation-3"
xmlns:s="http://midpoint.evolveum.com/xml/ns/public/model/scripting-3"
xmlns:t="http://prism.evolveum.com/xml/ns/public/types-3"
xmlns:jaxb="http://java.sun.com/xml/ns/jaxb"
xmlns:xjc="http://java.sun.com/xml/ns/jaxb/xjc"
elementFormDefault="qualified"
jaxb:extensionBindingPrefixes="xjc"
jaxb:version="2.0">
<xsd:annotation>
<xsd:documentation>
Schema that defines data types used in XML version of midPoint APIs.
Version: 3.7
Recommended namespace prefix: apit
</xsd:documentation>
</xsd:annotation>
<xsd:import namespace="http://midpoint.evolveum.com/xml/ns/public/common/common-3"
schemaLocation="http://midpoint.evolveum.com/xml/ns/public/common/common-3">
<xsd:annotation>
<xsd:documentation>
Common midPoint schema.
</xsd:documentation>
</xsd:annotation>
</xsd:import>
<xsd:import namespace="http://midpoint.evolveum.com/xml/ns/public/model/scripting-3"
schemaLocation="http://midpoint.evolveum.com/xml/ns/public/model/scripting-3">
<xsd:annotation>
<xsd:documentation>
Scripting language.
</xsd:documentation>
</xsd:annotation>
</xsd:import>
<xsd:import namespace="http://prism.evolveum.com/xml/ns/public/annotation-3"
schemaLocation="http://prism.evolveum.com/xml/ns/public/annotation-3">
<xsd:annotation>
<xsd:documentation>
Common midPoint annotations used in various XSD schemas.
</xsd:documentation>
</xsd:annotation>
</xsd:import>
<xsd:import namespace="http://prism.evolveum.com/xml/ns/public/types-3"
schemaLocation="http://prism.evolveum.com/xml/ns/public/types-3">
<xsd:annotation>
<xsd:documentation>
Prism data types.
</xsd:documentation>
</xsd:annotation>
</xsd:import>
<xsd:complexType name="ImportOptionsType">
<xsd:annotation>
<xsd:documentation>
The options for import tasks. It specifies optional settings for import such as "overwrite" and "stop on
error".
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="overwrite" type="xsd:boolean" minOccurs="0">
<xsd:annotation>
<xsd:documentation>
If set to a true value it will cause that objects that are already in the repository will be
overwritten by the imported objects.
It may not be applicable to all import types. E.g. it makes no sense for import from resource,
as this
is not storing objects in the repository directly.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="keepOid" type="xsd:boolean" minOccurs="0">
<xsd:annotation>
<xsd:documentation>
If set to a true value it will cause that objects that overwritten objects will reuse the same
OID
as previous objects.
May be potentially dangerous. USE WITH CARE.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="stopAfterErrors" type="xsd:int" minOccurs="0">
<xsd:annotation>
<xsd:documentation>
Number of errors that will cause import to stop. If set to one the import will stop on first
error.
If set to zero or negative value the import will not stop on any error.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="summarizeSucceses" type="xsd:boolean" minOccurs="0" default="true">
<xsd:annotation>
<xsd:documentation>
If set to true the successfully imported items will be summarized in the result.
WARNING: setting this to false may result in a very large result structure and may cause
overflow of
the system memory.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="summarizeErrors" type="xsd:boolean" minOccurs="0" default="false">
<xsd:annotation>
<xsd:documentation>
If set to true the import errors will be summarized in the result.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="referentialIntegrity" type="xsd:boolean" minOccurs="0" default="false">
<xsd:annotation>
<xsd:documentation>
TODO
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="validateStaticSchema" type="xsd:boolean" minOccurs="0" default="true">
<xsd:annotation>
<xsd:documentation>
TODO
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="validateDynamicSchema" type="xsd:boolean" minOccurs="0" default="true">
<xsd:annotation>
<xsd:documentation>
TODO
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="encryptProtectedValues" type="xsd:boolean" minOccurs="0" default="true">
<xsd:annotation>
<xsd:documentation>
TODO
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="fetchResourceSchema" type="xsd:boolean" minOccurs="0" default="false">
<xsd:annotation>
<xsd:documentation>
TODO
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="keepMetadata" type="xsd:boolean" minOccurs="0" default="false">
<xsd:annotation>
<xsd:documentation>
If set to true then the importer will keep the metadata from the source file.
If set to false then the imported will re-generate metadata on each object.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="modelExecutionOptions" type="c:ModelExecuteOptionsType" minOccurs="0">
<xsd:annotation>
<xsd:documentation>
If present, these options are used for adding objects into the repository.
Null option values might be overridden by import-related options. In particular, the missing
"raw" option is overridden to "true". So, if you want the operation run in non-raw mode,
set "raw" option to "false".
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="ObjectModificationType">
<xsd:annotation>
<xsd:documentation>
Describes a change of attributes of a specific object.
All changes are expected to happen atomically, but
there may be exceptions. Please check with the
documentation of the interface using this type for
more details.
Used in the interfaces (modifyObject)
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="oid" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
OID of the object to modify.
Due to consistency reasons this should rather be
an attribute. But it is an element because of
OpenESB bug with attributes in message parts.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="itemDelta" type="t:ItemDeltaType" minOccurs="1" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>
Describe a change to a single attribute of an object.
TODO: this should be renamed to "itemModification"
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:element name="objectModification" type="tns:ObjectModificationType"/>
<xsd:complexType name="ObjectListType">
<xsd:sequence>
<xsd:element name="object" type="c:ObjectType" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
<xsd:attribute name="count" type="xsd:int"/>
</xsd:complexType>
<xsd:element name="objectList" type="tns:ObjectListType"/>
<xsd:complexType name="ResourceObjectShadowListType">
<xsd:sequence>
<xsd:element name="object" type="c:ShadowType" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="UserListType">
<xsd:sequence>
<xsd:element name="user" type="c:UserType" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="ResourceObjectType">
<xsd:annotation>
<xsd:appinfo>
<a:container/>
</xsd:appinfo>
</xsd:annotation>
<xsd:sequence>
<xsd:any namespace="##other" minOccurs="1" maxOccurs="unbounded" processContents="lax">
<xsd:annotation>
<xsd:appinfo>
<xjc:dom/>
</xsd:appinfo>
</xsd:annotation>
</xsd:any>
</xsd:sequence>
<xsd:attribute name="id" type="xsd:long" use="optional"/>
</xsd:complexType>
<xsd:complexType name="ResourceObjectIdentificationType">
<xsd:annotation>
<xsd:appinfo>
<a:container/>
</xsd:appinfo>
</xsd:annotation>
<xsd:sequence>
<xsd:any namespace="##other" minOccurs="1" maxOccurs="unbounded" processContents="lax">
<xsd:annotation>
<xsd:appinfo>
<xjc:dom/>
</xsd:appinfo>
</xsd:annotation>
</xsd:any>
</xsd:sequence>
<xsd:attribute name="id" type="xsd:long" use="optional"/>
</xsd:complexType>
<xsd:complexType name="PropertyReferenceListType">
<xsd:annotation>
<xsd:documentation>
DEPRECATED
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="property" type="t:ItemPathType" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
<!-- the following types are related to script execution; these are experimental for now -->
<xsd:complexType name="XmlScriptsType">
<xsd:sequence>
<xsd:any minOccurs="0" maxOccurs="unbounded" /> <!-- objects substituable with s:expression should be put here -->
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="ExecuteScriptResponseType">
<xsd:annotation>
<xsd:documentation>
Result of a single script execution.
</xsd:documentation>
<xsd:appinfo>
<a:since>3.6</a:since>
</xsd:appinfo>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="output" type="s:ExecuteScriptOutputType" minOccurs="0">
<xsd:annotation>
<xsd:documentation>
Data and console output of the execution of the script.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="result" type="c:OperationResultType">
<xsd:annotation>
<xsd:documentation>
Operation result covering the execution of the script.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:element name="executeScriptResponse" type="tns:ExecuteScriptResponseType"/>
<xsd:complexType name="ScriptOutputsType">
<xsd:sequence>
<xsd:element name="output" type="tns:SingleScriptOutputType" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="SingleScriptOutputType">
<xsd:sequence>
<xsd:choice>
<xsd:element name="dataOutput" type="s:PipelineDataType" />
<xsd:element name="mslData" type="xsd:string" />
</xsd:choice>
<xsd:element name="textOutput" type="xsd:string" minOccurs="0" />
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="ExecuteScriptsOptionsType">
<xsd:sequence>
<xsd:element name="outputFormat" type="tns:OutputFormatType" minOccurs="0"/>
<xsd:element name="objectLimit" type="xsd:int" minOccurs="0"/>
<xsd:element name="executeAsynchronously" type="xsd:boolean" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
<xsd:simpleType name="OutputFormatType">
<xsd:annotation>
<xsd:documentation>
TODO
</xsd:documentation>
</xsd:annotation>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="xml">
<xsd:annotation>
<xsd:appinfo>
<jaxb:typesafeEnumMember name="XML"/>
</xsd:appinfo>
</xsd:annotation>
</xsd:enumeration>
<xsd:enumeration value="msl">
<xsd:annotation>
<xsd:appinfo>
<jaxb:typesafeEnumMember name="MSL"/>
</xsd:appinfo>
</xsd:annotation>
</xsd:enumeration>
</xsd:restriction>
</xsd:simpleType>
<xsd:complexType name="ObjectDeltaListType">
<xsd:annotation>
<xsd:documentation>
List of object deltas.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="delta" type="t:ObjectDeltaType" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="ObjectDeltaOperationListType">
<xsd:annotation>
<xsd:documentation>
List of object delta operations (deltas + operation results).
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="deltaOperation" type="c:ObjectDeltaOperationType" minOccurs="0" maxOccurs="unbounded"/>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="CompareResultType">
<xsd:annotation>
<xsd:documentation>
EXPERIMENTAL. TODO.
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="currentToProvided" type="t:ObjectDeltaType" minOccurs="0">
<xsd:annotation>
<xsd:documentation>
Delta that would change the current object (in midPoint) into the client-provided one.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="providedToCurrent" type="t:ObjectDeltaType" minOccurs="0">
<xsd:annotation>
<xsd:documentation>
Delta that would change the client-provided object to the current object (in midPoint).
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="normalizedObject" type="c:ObjectType" minOccurs="0">
<xsd:annotation>
<xsd:documentation>
"Normalized version" of provided object (i.e. the one that is created by parsing and re-serializing the object.)
Items to be ignored are left out from it.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="currentObject" type="c:ObjectType" minOccurs="0">
<xsd:annotation>
<xsd:documentation>
Current version of object, as stored in midPoint.
Items to be ignored are left out from it.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="PolicyItemsDefinitionType">
<xsd:annotation>
<xsd:documentation>
Defined items and rules for generating/validating values
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="policyItemDefinition" type="tns:PolicyItemDefinitionType" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>
Definition for the item to be generated/validated
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:element name="policyItemsDefinition" type="tns:PolicyItemsDefinitionType"/>
<xsd:complexType name="PolicyItemDefinitionType">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="target" type="tns:PolicyItemTargetType" minOccurs="1">
<xsd:annotation>
<xsd:documentation>
Definition of item for which the value will be generated/validated
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="valuePolicyRef" type="c:ObjectReferenceType" minOccurs="0">
<xsd:annotation>
<xsd:documentation>
Reference to the value policy that should be used to generate/validate the value.
If not specified, system defined policy is used
</xsd:documentation>
<xsd:appinfo>
<a:objectReferenceTargetType>c:ValuePolicyType</a:objectReferenceTargetType>
</xsd:appinfo>
</xsd:annotation>
</xsd:element>
<xsd:element name="value" type="xsd:anyType" minOccurs="0">
<xsd:annotation>
<xsd:documentation>
Contains either generated value or value which will be validated
</xsd:documentation>
<xsd:appinfo>
<a:rawType/>
</xsd:appinfo>
</xsd:annotation>
</xsd:element>
<xsd:element name="execute" type="xsd:boolean" minOccurs="0">
<xsd:annotation>
<xsd:documentation>
Specifies if the generated value should be set immediately to the object.
Relevant only for generate operation.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="result" type="c:OperationResultType" minOccurs="0">
<xsd:annotation>
<xsd:documentation>
Specifies if the generated value should be set immediately to the object.
Relevant only for generate operation.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:element name="policyItemDefinition" type="tns:PolicyItemDefinitionType"/>
<xsd:complexType name="PolicyItemTargetType">
<xsd:annotation>
<xsd:documentation>
Defined items and rules for generating/validating values
</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="path" type="t:ItemPathType" minOccurs="1">
<xsd:annotation>
<xsd:documentation>
Definition for the item to be generated/validated
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:element name="policyItemTarget" type="tns:PolicyItemTargetType"/>
<xsd:complexType name="ExecuteCredentialResetRequestType">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
<xsd:appinfo>
<a:container/>
</xsd:appinfo>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="resetMethod" type="xsd:string" minOccurs="0">
</xsd:element>
<xsd:element name="userEntry" type="xsd:string" minOccurs="0">
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:element name="executeCredentialResetRequest" type="tns:ExecuteCredentialResetRequestType"/>
<xsd:complexType name="ExecuteCredentialResetResponseType">
<xsd:annotation>
<xsd:documentation>
</xsd:documentation>
<xsd:appinfo>
<a:container/>
</xsd:appinfo>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="message" type="c:LocalizableMessageType" minOccurs="0">
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:element name="executeCredentialResetResponse" type="tns:ExecuteCredentialResetResponseType"/>
</xsd:schema>