-
Notifications
You must be signed in to change notification settings - Fork 5
/
DirectoryAdministration.yaml
1768 lines (1708 loc) · 76.7 KB
/
DirectoryAdministration.yaml
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
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: I_Directory_Administration
description: REST Schnittstelle zur Pflege der Verzeichniseinträge.
Über diese Schnittstelle können Verzeichniseinträge inklusive Zertifikaten erzeugt, aktualisiert und gelöscht werden. Die Administration von Fachdaten erfolgt über Schnittstelle I_Directory_Application_Maintenance und wird durch die Fachanwendungen durchgeführt. Lesender Zugriff auf die Fachdaten ist mit Operation getDirectoryEntries in vorliegender Schnittstelle möglich.
version: 1.8.1
# Änderungen in Version 1.8.1
# - Attribute "KOM-LE-Version" in eine Liste geändert
# - Attribut "active" für Zertifikate aufgenommen
# Änderungen in Version 1.8.0
# - Operation read_Directory_Entry_for_Sync: Zur Kompatibilität mit existierenden Clients wurde
# read_Directory_Entry_for_Sync in der Version ohne Paging wieder aufgenommen.
# Die Operation mit Paging Mechanismus wurde in read_Directory_Entry_for_Sync_paging umbenannt.
# - Konkretisierung der Filtermöglichkeiten der Operationen read_Directory_Entry,
# read_Directory_Entry_for_Sync und read_Directory_Entry_for_Sync_paging
# - Schema readDirectoryEntryforSyncResponse: Verschachtelung von directoryEntries reduziert.
# - Schema userCertificate: "required: dn" entfernt, da diese Attribute nicht im Request enthalten sein müssen.
#
# Änderungen in Version 1.7.0
# - Schema baseDirectoryEntry: "required: cn, dn" entfernt, da diese Attribute nicht im Request enthalten sein müssen.
# - Error Struktur angepasst (mehrere Fehlermeldungen ermöglicht)
# - Paging in Operation read_Directory_Entry_for_Sync aufgenommen
# - Filtermöglichkeiten in Leseoperationen read_Directory_Entry und
# read_Directory_Entry_for_Sync (Wildcard "*" & Vorhandensein \00) aufgenommen.
# - Suchparameter in Leseoperationen read_Directory_Entry und
# read_Directory_Entry_for_Sync aufgenommen:
# maxKOMLEadr, changeDateTimeFrom, changeDateTimeTo
# - Fehlercodes aus Version 1.5.2 übernommen:
# - Fehlercode 409 für Operation add_Directory_Entry_Certificate hinzugefügt.
# - Fehlercode 409 für Operation add_Directory_Entry hinzugefügt (Basiseintrag bereits vorhanden).
# - Fehlercode 400 für Operation add_Directory_Entry hinzugefügt (generelle Fehlersituationen).
# - Schema #/components/schemas/Error' korrigiert:
# In der bisherigen Definition war die Angabe von maxItems/minItems wirkungslos.
# Deshalb wird jetzt in dem Error Schema ein 'array' genutzt.
#
# Änderungen in Version 1.6.3
# - Operation "delete_Directory_Entry_Certificate" hinzugefügt.
#
# Änderungen in Version 1.6.2
# - Im Datenmodell für Attribut "changeDateTime" den Format String "date-time" auskommentiert. Mit dieser Format Vorgabe ist kein Code mehr generierbar. Es soll sich aber weiterhin an das Format gehalten werden.
#
# Änderungen in Version 1.6.1
# - modify_Directory_Entry Operation - responses:
# Für Response 200 Header "X-maxKOMLEadr-Limit" hinzugefügt
# Über diesen Header wird dem Client angezeigt, ob die Anzahl der aktuell - in den Fachdaten - hinterlegten mail Adressen den Wert in Attribut maxKOMLEadr übersteigt.
# - KOM-LE_Version in Schema FAD1 hinzugefügt
#
# Änderungen in Version 1.6.0
# - getInfo Operation - inklusive den dazugehörenden Schema Objekten "InfoObject", "Contact" und "License" - hinzugefügt.
# - Attribute professionOID und entryType zusätzlich in die Basisdaten - als Kopie aus den Zertifikatsdaten (userCertificate) aufgenommen. Diese Attribute wurden ebenfalls in die read_Directory_Entry Operation als Suchparameter aufgenommen.
#
# Änderungen in Version 1.5.2
# - Fehlercode 409 für Operation add_Directory_Entry_Certificate hinzugefügt (Zertifikat bereits vorhanden).
# - Fehlercode 409 für Operation add_Directory_Entry hinzugefügt (Basiseintrag bereits vorhanden).
# - Fehlercode 400 für Operation add_Directory_Entry hinzugefügt (generelle Fehlersituationen).
#
# Änderungen in Version 1.5.1
# - Header 'Accept: application/json' wird bei delete_Directory_Entry benötigt.
# Dies wird durch Angabe von "application/json" für den content von dem
# Response mit HTTP Status 200 gewährleistet.
#
# Änderungen in Version 1.5.0
# - Attribut "owner" in "holder" umbenannt ("owner" ist in LDAP vordefiniert und kann deshalb nicht für den vorgesehenen Zweck genutzt werden)
# Änderungen in Version 1.4.0
# - Operation read_Directory_Entry: Einschränkung auf 100 Suchergebnisse wieder eingeführt
# - Operation read_Directory_Entry_for_Sync: Für die Datensynchronisation der Herausgeber mit dem VZD wird diese Suchabfrage ohne Limitierung auf 100 Suchergebnisse ergänzt. Die parallele Ausführung dieser Operation wird vom Server aus Performancegründen eingeschränkt.
# - Attribut "usage" in Datenstruktur "userCertificate": "enum" im Format gestrichen.
#
# Änderungen in Version 1.3.0
# - Die direkte Suche von Verzeichniseinträgen (baseDirectoryEntry) mit dem
# Suchparameter telematikID wird unterstützt.
# o telematikID im baseDirectoryEntry hinzugefügt und in
# add_Directory_Entry, read_Directory_Entry und modify_Directory_Entry ergänzt
# - Paging Parameter entfernt (für eigene Verzeichniseinträge und Verzeichniseinträge
# ohne owner wird die Begrenzung auf 100 Suchergebnisse aufgehoben)
# - Operation read_Directory_Entry: Suchparameter telematikID-SubStr ergänzt
# - Operation read_Directory_Entry: Suchparameter telematikID-SubStr ergänzt
# - Datenmodell: "baseDirectoryEntry"
# o Ländercode "countryCode" ergänzt und in Operationen hinzugefügt
# o Änderungsdatum "changeDateTime" ergänzt
#
# Änderungen in Version 1.2.2
# Übernahme der Änderungen aus f_r313_hotfix_5 (version 1.1.2)
# - /DirectoryEntries
# get - Response Fehlercode 400 gestrichen.
# Bei mehr als 100 gefundenen Einträgen werden nur 100
# gefundenen Einträge zurückgegeben (Response 200), falls kein Paging genutzt wird.
# - /DirectoryEntries/Certificates
# get - Response Fehlercode 400 gestrichen.
# Bei mehr als 100 gefundenen Einträgen werden nur 100
# gefundenen Einträge zurückgegeben (Response 200).
#
# Änderungen in Version 1.2.1
# - /DirectoryEntries
# read_Directory_Entry:
# Suchparameter "baseEntryOnly" ergänzt
# Änderungen in Version 1.2.0
# - /DirectoryEntries
# read_Directory_Entry:
# Suchparameter "owner" ergänzt
# Paging Parameter ergänzt
# - searchControlValue für Paging der Suchergebnisse ergänzt
# - /DirectoryEntries/{uid}/baseDirectoryEntries:
# modify_Directory_Entry: Fehlerkode 422 ergänzt (ungültiger owner im Request Parameter)
# - /DirectoryEntries/{uid}/Certificates/{certificateEntryID}:
# put & delete - Operationen gestrichen
# - schemas:
# baseDirectoryEntry:
# Attribute "owner" und "maxKOMLEadr" mit Beschreibung der Auswirkungen auf die Operationen hinzugefügt
# Änderungen in Version 1.1.1
# - /DirectoryEntries/Certificates
# get - UID ist kein Pflichtparameter mehr um die Suche mit der TelematikID zu ermöglichen
# - Texte der HTTP Fehlercodes angepasst
externalDocs:
description: Schnittstelle zur Pflege der Verzeichniseinträge
url: http://github.com/gematik/api-vzd/
servers:
- url: https://vzdpflege-test.vzd.ti-dienste.de:9543/
description: Testumgebung
- url: https://vzdpflege-ref.vzd.ti-dienste.de:9543/
description: Referenzumgebung
- url: https://vzdpflege.vzd.ti-dienste.de:9543/
description: Produktivumgebung
tags:
- name: getInfo DirectoryEntry Administration
description: Diese Operation liefert Metadaten über diese Schnittstelle
- name: DirectoryEntry Administration
description: Pflege der Verzeichniseinträge (Basiseinträge)
- name: Certificate Administration
description: Pflege der Zertifikatseinträge
- name: DirectoryEntry Synchronization
description: Synchronisation der Verzeichniseinträge (Basiseinträge) mit dem eigenen Datenbestand
paths:
/:
get:
tags:
- getInfo DirectoryEntry Administration
summary: Diese Operation liefert Metadaten über diese Schnittstelle
description: Liefert die Metadaten aus dem Info Object diese OpenAPI Spezifikation und ergänzt sie.
operationId: getInfo
responses:
200:
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/InfoObject'
401:
description: Unauthorized
# Der WWW-Authenticate Header im Response wird auf OAuth gesetzt.
content: {}
403:
description: Forbidden
content: {}
/DirectoryEntries:
post:
tags:
- DirectoryEntry Administration
summary: Einen Eintrag zum Verzeichnisdienst hinzufügen
operationId: add_Directory_Entry
requestBody:
description: Datensatz für den neuen Eintrag. Die Attribute müssen wie folgt belegt sein
dn.* Leer/nicht vorhanden (wird vom Verzeichnisdienst belegt)
givenName Nicht vorhanden (wird vom Verzeichnisdienst belegt)
sn Nicht vorhanden (wird vom Verzeichnisdienst belegt)
cn Nicht vorhanden (wird vom Verzeichnisdienst belegt)
displayName Kann optional belegt werden.
streetAddress Kann optional belegt werden.
postalCode Kann optional belegt werden.
countryCode Kann optional belegt werden.
Falls nicht belegt, ergänzt der VZD den Code für Deutschland (Defaultwert).
localityName Kann optional belegt werden.
stateOrProvinceName Kann optional belegt werden.
title Kann optional belegt werden.
organization Kann optional belegt werden.
otherName Kann optional belegt werden.
telematikID Kann optional belegt werden.
Das ist die telematikID in den Basisdaten (baseDirectoryEntry).
Wird diese telematikID und userCertificate bzw. die telematikID in userCertificate angegeben, dann müssen diese telematikIDs übereinstimmen.
Bei unterschiedlichen telematikID wird die Operation mit Fehlercode 422 abgelehnt.
specialization Kann optional belegt werden.
domainID Kann optional belegt werden.
holder Kann optional belegt werden.
maxKOMLEadr Kann optional belegt werden.
personalEntry Nicht vorhanden (wird vom Verzeichnisdienst belegt)
dataFromAuthority Nicht vorhanden (wird vom Verzeichnisdienst belegt)
userCertificates Kann optional belegt werden.
dn.uid Leer/nicht vorhanden (wird vom Verzeichnisdienst belegt)
dn.dc Leer/nicht vorhanden (wird vom Verzeichnisdienst belegt)
dn.ou Leer/nicht vorhanden (wird vom Verzeichnisdienst belegt)
dn.cn Leer/nicht vorhanden (wird vom Verzeichnisdienst belegt)
telematikID Kann optional belegt werden.
Wird telematikID und userCertificate angegeben, dann muss diese telematikID mit der telematikID im userCertificate übereinstimmen.
Bei unterschiedlichen telematikID wird die Operation mit Fehlercode 422 abgelehnt.
entryType Nicht vorhanden (wird vom Verzeichnisdienst belegt)
professionOID Nicht vorhanden (wird vom Verzeichnisdienst belegt)
usage Kann optional belegt werden.
userCertificate Kann optional belegt werden (Format DER, Base64 kodiert)
description Kann optional belegt werden.
Entsprechend gemSpec_VZD wird ein Teil der Attribute durch den Verzeichnisdienst automatisch mit Werten aus dem Zertifikat gefüllt. Wenn in dieser Operation Attribute - für die dies erlaubt ist - mit einem Wert belegt werden, wird dieser Wert im Verzeichniseintrag gespeichert (auch wenn der Wert durch den Verzeichnisdienst aus dem Zertifikat entnommen werden kann).
content:
application/json:
schema:
$ref: '#/components/schemas/CreateDirectoryEntry'
required: true
responses:
201:
description: Created
# Der Verzeichniseintrag wurde angelegt. Zurückgegeben wird der distinguishedName des erzeugten Eintrags.
content:
application/json:
schema:
$ref: '#/components/schemas/distinguishedName'
400:
description: Bad Request
# Allgemeiner Fehler im Request
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
401:
description: Unauthorized
# Der WWW-Authenticate Header im Response muss auf OAuth gesetzt werden.
content: {}
403:
description: Forbidden
content: {}
405:
description: Method Not Allowed
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
409:
description: Conflict
# Verzeichniseintrag (identifiziert anhand der Telematik-ID) ist schon vorhanden.
# Die 'Error' Parameter werden für diese Fehler so gesetzt:
# "attributeName": "telematikID",
# "attributeError": "DirectoryEntry already exists"
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
422:
description: Unprocessable Entity
# Z.B. Wert aus dem Request Attribut "holder" nicht gültig
# Bei unterschiedlichen telematikIDs (Parameter telematikID und Wert im userCertificate) wird die Operation mit Fehlercode 422 abgelehnt.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
get:
tags:
- DirectoryEntry Administration
summary: Gesamten Verzeichniseintrag lesen
description: Liefert alle zum Filter passenden Verzeichniseinträge (maximal 100 Einträge). Die angegebenen Parameter werden mit logischen UND verknüpft.
#
# Für die Leseoperationen read_Directory_Entry, read_Directory_Entry_for_Sync und
# read_Directory_Entry_for_Sync_paging der Schnittstellen I_Directory_Administration
# und I_Directory_Application_Maintenance
# werden die folgenden Filtermöglichkeiten unterstützt:
# o Suche mit Wildcard "*" in den Parametern
# - givenName
# - sn
# - cn
# - displayName
# - streetAddress
# - postalCode
# - countryCode
# - localityName
# - stateOrProvinceName
# - title
# - organization
# - otherName
# - telematikID
# - specialization
# - domainID
# - holder
# - professionOID
# Wildcard ist am Ende und am Anfang nutzbar:
# - *Mustermann* - "contains"
# - "Dr. Manfred*" - "startsWith"
# - "* MBA" - "endsWith"
# treffen alle "Dr. Manfred Mustermann MBA".
#
# o Suche nach Vorhandensein ODER leerem Inhalt eines Attributs des
# VZD Datensatzes durch Belegung des Attributs im GET Request mit "" in den Parametern
# - givenName
# - sn
# - cn
# - displayName
# - streetAddress
# - postalCode
# - countryCode
# - localityName
# - stateOrProvinceName
# - title
# - organization
# - otherName
# - specialization
# - domainID
# - holder
# - professionOID
# - maxKOMLEadr
# - changeDateTimeFrom
# - changeDateTimeTo
# Diese Suche findet sowohl Datensätze mit nicht vorhandenem Attribut
# wie auch vorhandenem aber leerem Attribut.
# Alle Filterparameter einer Leseoperationen werden mit einem UND (&) verknüpft.
#
operationId: read_Directory_Entry
parameters:
- name: uid
in: query
description: ID von dem Verzeichniseintrag (distinguishedName.uid)
schema:
type: string
- name: givenName
in: query
description: Erlaubt die Suche mit Hilfe des Attributs givenName.
schema:
type: string
- name: sn
in: query
description: Erlaubt die Suche mit Hilfe des Attributs sn.
schema:
type: string
- name: cn
in: query
description: Erlaubt die Suche mit Hilfe des Attributs cn.
schema:
type: string
- name: displayName
in: query
description: Erlaubt die Suche mit Hilfe des Attributs displayName.
schema:
type: string
- name: streetAddress
in: query
description: Erlaubt die Suche mit Hilfe des Attributs streetAddress.
schema:
type: string
- name: postalCode
in: query
description: Erlaubt die Suche mit Hilfe des Attributs postalCode.
schema:
type: string
- name: countryCode
in: query
description: Erlaubt die Suche mit Hilfe des Attributs countryCode.
schema:
type: string
- name: localityName
in: query
description: Erlaubt die Suche mit Hilfe des Attributs localityName.
schema:
type: string
- name: stateOrProvinceName
in: query
description: Erlaubt die Suche mit Hilfe des Attributs stateOrProvinceName.
schema:
type: string
- name: title
in: query
description: Erlaubt die Suche mit Hilfe des Attributs title.
schema:
type: string
- name: organization
in: query
description: Erlaubt die Suche mit Hilfe des Attributs organization.
schema:
type: string
- name: otherName
in: query
description: Erlaubt die Suche mit Hilfe des Attributs otherName.
schema:
type: string
- name: telematikID
in: query
description: Erlaubt die Suche mit Hilfe des Attributs telematikID (die telematikID in den Basisdaten).
schema:
type: string
- name: telematikID-SubStr
in: query
description: Erlaubt die Suche nach einem Substring am Anfang der telematikID (die telematikID in den Basisdaten).
Entspricht der LDAP Filters Substring Assertion vom Typ "subInitial Component".
schema:
type: string
- name: specialization
in: query
description: Erlaubt die Suche mit Hilfe des Attributs specialization.
Der Verzeichniseintrag wird selektiert, wenn die angegebene domainID im Attribut domainID (array) des Verzeichniseintrags enthalten ist.
schema:
type: string
- name: domainID
in: query
description: Erlaubt die Suche mit Hilfe des Attributs domainID.
Der Verzeichniseintrag wird selektiert, wenn die angegebene domainID im Attribut domainID (array) des Verzeichniseintrags enthalten ist.
schema:
type: string
- name: holder
in: query
description: Erlaubt die Suche mit Hilfe des Attributs holder.
Der Verzeichniseintrag wird selektiert, wenn der angegebene holder im Attribut holder (array) des Verzeichniseintrags enthalten ist.
Wenn der Parameter mit dem eigenen Wert des Clients belegt wird, werden alle gefundenen Einträge zurückgegeben (maximal 100 Einträge).
Zur Suche nach Einträge ohne holder ist der Parameter mit dem einem leeren String "" zu belegen. Auch in diesem Fall werden alle gefundenen Einträge zurückgegeben (maximal 100 Einträge).
schema:
type: string
- name: personalEntry
in: query
description: Erlaubt die Suche mit Hilfe des Attributs personalEntry.
schema:
type: string
- name: dataFromAuthority
in: query
description: Erlaubt die Suche mit Hilfe des Attributs dataFromAuthority.
schema:
type: string
- name: professionOID
in: query
description: Erlaubt die Suche mit Hilfe des Attributs professionOID.
Selektiert der Verzeichniseintrag, wenn der angegebene Wert in den professionOID's (array) des Basiseintrags vorhanden ist.
schema:
type: string
- name: entryType
in: query
description: Erlaubt die Suche mit Hilfe des Attributs entryType.
Selektiert der Verzeichniseintrag, wenn der angegebene Wert in den entryType's (array) des Basiseintrags vorhanden ist.
schema:
type: string
- name: maxKOMLEadr
in: query
description: Erlaubt die Suche mit Hilfe des Attributs maxKOMLEadr.
schema:
type: string
- name: changeDateTimeFrom
in: query
description: Erlaubt die Suche mit Hilfe des Attributs changeDateTime.
# Selektiert alle Datensätze mit
# changeDateTime >= changeDateTimeFrom
schema:
type: string
# format: date-time
example: "2017-07-21T17:32:28Z"
- name: changeDateTimeTo
in: query
description: Erlaubt die Suche mit Hilfe des Attributs changeDateTime.
# Selektiert alle Datensätze mit
# changeDateTime <= changeDateTimeTo
schema:
type: string
# format: date-time
example: "2018-07-21T17:32:28Z"
- name: baseEntryOnly
in: query
description: Mit baseEntryOnly = "true" wird nur der Basiseintrag (baseDirectoryEntry) im Response zurückgegeben. Falls nicht angegeben oder mit "false" belegt, wird der gesamte Verzeichniseintrag mit Zertifikaten und Fachdaten im Response zurückgegeben.
schema:
type: boolean
example: true
responses:
200:
description: OK
# Es werden alle zu dem Filter Parametern passenden Verzeichniseinträge - inklusive Zertifikaten und Fachdaten - zurückgegeben.
# Bei mehr als 100 gefundenen Einträgen nur 100 gefundenen Einträge zurückgegeben.
content:
application/json:
schema:
$ref: '#/components/schemas/DirectoryEntries'
401:
description: Unauthorized
# Der WWW-Authenticate Header im Response wird auf OAuth gesetzt.
content: {}
403:
description: Forbidden
content: {}
404:
description: Not Found
content: {}
/DirectoryEntriesSync:
get:
tags:
- DirectoryEntry Synchronization
summary: Synchronisation der Verzeichniseinträge zwischen VZD und Herausgeber
description: Liefert - analog zu read_Directory_Entry - alle zum Filter passenden Verzeichniseinträge. Im Unterschied zu read_Directory_Entry wird die Limitierung auf 100 Suchergebnisse aufgehoben. Die parallele Ausführung dieser Operation wird vom Server aus Performancegründen eingeschränkt.
Diese Operation soll nur genutzt werden, wenn mehr als 100 Suchergebnisse benötigt werden. Für alle anderen Suchanfragen soll Operation read_Directory_Entry genutzt werden.
#
# Für die Leseoperationen read_Directory_Entry, read_Directory_Entry_for_Sync und
# read_Directory_Entry_for_Sync_paging der Schnittstellen I_Directory_Administration
# und I_Directory_Application_Maintenance
# werden die folgenden Filtermöglichkeiten unterstützt:
# o Suche mit Wildcard "*" in den Parametern
# - givenName
# - sn
# - cn
# - displayName
# - streetAddress
# - postalCode
# - countryCode
# - localityName
# - stateOrProvinceName
# - title
# - organization
# - otherName
# - telematikID
# - specialization
# - domainID
# - holder
# - professionOID
# Wildcard ist am Ende und am Anfang nutzbar:
# - *Mustermann* - "contains"
# - "Dr. Manfred*" - "startsWith"
# - "* MBA" - "endsWith"
# treffen alle "Dr. Manfred Mustermann MBA".
#
# o Suche nach Vorhandensein ODER leerem Inhalt eines Attributs des
# VZD Datensatzes durch Belegung des Attributs im GET Request mit "" in den Parametern
# - givenName
# - sn
# - cn
# - displayName
# - streetAddress
# - postalCode
# - countryCode
# - localityName
# - stateOrProvinceName
# - title
# - organization
# - otherName
# - specialization
# - domainID
# - holder
# - professionOID
# - maxKOMLEadr
# - changeDateTimeFrom
# - changeDateTimeTo
# Diese Suche findet sowohl Datensätze mit nicht vorhandenem Attribut
# wie auch vorhandenem aber leerem Attribut.
# Alle Filterparameter einer Leseoperationen werden mit einem UND (&) verknüpft.
#
operationId: read_Directory_Entry_for_Sync
parameters:
- name: uid
in: query
description: ID von dem Verzeichniseintrag (distinguishedName.uid)
schema:
type: string
- name: givenName
in: query
description: Erlaubt die Suche mit Hilfe des Attributs givenName.
schema:
type: string
- name: sn
in: query
description: Erlaubt die Suche mit Hilfe des Attributs sn.
schema:
type: string
- name: cn
in: query
description: Erlaubt die Suche mit Hilfe des Attributs cn.
schema:
type: string
- name: displayName
in: query
description: Erlaubt die Suche mit Hilfe des Attributs displayName.
schema:
type: string
- name: streetAddress
in: query
description: Erlaubt die Suche mit Hilfe des Attributs streetAddress.
schema:
type: string
- name: postalCode
in: query
description: Erlaubt die Suche mit Hilfe des Attributs postalCode.
schema:
type: string
- name: countryCode
in: query
description: Erlaubt die Suche mit Hilfe des Attributs countryCode.
schema:
type: string
- name: localityName
in: query
description: Erlaubt die Suche mit Hilfe des Attributs localityName.
schema:
type: string
- name: stateOrProvinceName
in: query
description: Erlaubt die Suche mit Hilfe des Attributs stateOrProvinceName.
schema:
type: string
- name: title
in: query
description: Erlaubt die Suche mit Hilfe des Attributs title.
schema:
type: string
- name: organization
in: query
description: Erlaubt die Suche mit Hilfe des Attributs organization.
schema:
type: string
- name: otherName
in: query
description: Erlaubt die Suche mit Hilfe des Attributs otherName.
schema:
type: string
- name: telematikID
in: query
description: Erlaubt die Suche mit Hilfe des Attributs telematikID (die telematikID in den Basisdaten).
schema:
type: string
- name: telematikID-SubStr
in: query
description: Erlaubt die Suche nach einem Substring am Anfang der telematikID (die telematikID in den Basisdaten).
Entspricht der LDAP Filters Substring Assertion vom Typ "subInitial Component".
schema:
type: string
- name: specialization
in: query
description: Erlaubt die Suche mit Hilfe des Attributs specialization.
Der Verzeichniseintrag wird selektiert, wenn die angegebene domainID im Attribut domainID (array) des Verzeichniseintrags enthalten ist.
schema:
type: string
- name: domainID
in: query
description: Erlaubt die Suche mit Hilfe des Attributs domainID.
Der Verzeichniseintrag wird selektiert, wenn die angegebene domainID im Attribut domainID (array) des Verzeichniseintrags enthalten ist.
schema:
type: string
- name: holder
in: query
description: Erlaubt die Suche mit Hilfe des Attributs holder.
Der Verzeichniseintrag wird selektiert, wenn der angegebene holder im Attribut holder (array) des Verzeichniseintrags enthalten ist.
Wenn der Parameter mit dem eigenen Wert des Clients belegt wird, werden alle gefundenen Einträge zurückgegeben (für eigene Einträge gilt das Limit von 100 Ergebnissen nicht).
Zur Suche nach Einträge ohne holder ist der Parameter mit dem einem leeren String "" zu belegen. Auch in diesem Fall werden alle gefundenen Einträge zurückgegeben (für Einträge ohne holder gilt das Limit von 100 Ergebnissen nicht).
schema:
type: string
- name: personalEntry
in: query
description: Erlaubt die Suche mit Hilfe des Attributs personalEntry.
schema:
type: string
- name: dataFromAuthority
in: query
description: Erlaubt die Suche mit Hilfe des Attributs dataFromAuthority.
schema:
type: string
- name: maxKOMLEadr
in: query
description: Erlaubt die Suche mit Hilfe des Attributs maxKOMLEadr.
schema:
type: string
- name: changeDateTimeFrom
in: query
description: Erlaubt die Suche mit Hilfe des Attributs changeDateTime.
# Selektiert alle Datensätze mit
# changeDateTime >= changeDateTimeFrom
schema:
type: string
# format: date-time
example: "2017-07-21T17:32:28Z"
- name: changeDateTimeTo
in: query
description: Erlaubt die Suche mit Hilfe des Attributs changeDateTime.
# Selektiert alle Datensätze mit
# changeDateTime <= changeDateTimeTo
schema:
type: string
# format: date-time
example: "2018-07-21T17:32:28Z"
- name: baseEntryOnly
in: query
description: Mit baseEntryOnly = "true" wird nur der Basiseintrag (baseDirectoryEntry) im Response zurückgegeben. Falls nicht angegeben oder mit "false" belegt, wird der gesamte Verzeichniseintrag mit Zertifikaten und Fachdaten im Response zurückgegeben.
schema:
type: boolean
example: true
responses:
200:
description: OK
# Es werden alle zu dem Filter Parametern passenden Verzeichniseinträge - inklusive Zertifikaten und Fachdaten - zurückgegeben.
# Bei mehr als 100 gefundenen Einträgen nur 100 gefundenen Einträge zurückgegeben.
# Wenn der Suchparameter "holder" mit dem eigenen Wert des Clients belegt wird, werden alle gefundenen Einträge zurückgegeben (für eigene Einträge gilt das Limit von 100 Ergebnissen nicht).
content:
application/json:
schema:
$ref: '#/components/schemas/DirectoryEntries'
401:
description: Unauthorized
# Der WWW-Authenticate Header im Response wird auf OAuth gesetzt.
content: {}
403:
description: Forbidden
content: {}
404:
description: Not Found
content: {}
503:
description: Service Unavailable
# Der Server schränkt die parallele Nutzung dieser Operation read_Directory_Entry_WL ein. Der Request kann nach einer angemessenen Zeitspanne wiederholt werden.
content: {}
/v2/DirectoryEntriesSync:
get:
tags:
- DirectoryEntry Synchronization
summary: Synchronisation der Verzeichniseinträge zwischen VZD und Herausgeber
description: Liefert - analog zu read_Directory_Entry - alle zum Filter passenden Verzeichniseinträge. Im Unterschied zu read_Directory_Entry wird die Limitierung auf 100 Suchergebnisse aufgehoben. Die parallele Ausführung dieser Operation wird vom Server aus Performancegründen eingeschränkt.
Diese Operation soll nur genutzt werden, wenn mehr als 100 Suchergebnisse benötigt werden. Für alle anderen Suchanfragen soll Operation read_Directory_Entry genutzt werden.
#
# Für die Leseoperationen read_Directory_Entry, read_Directory_Entry_for_Sync und
# read_Directory_Entry_for_Sync_paging der Schnittstellen I_Directory_Administration
# und I_Directory_Application_Maintenance
# werden die folgenden Filtermöglichkeiten unterstützt:
# o Suche mit Wildcard "*" in den Parametern
# - givenName
# - sn
# - cn
# - displayName
# - streetAddress
# - postalCode
# - countryCode
# - localityName
# - stateOrProvinceName
# - title
# - organization
# - otherName
# - telematikID
# - specialization
# - domainID
# - holder
# - professionOID
# Wildcard ist am Ende und am Anfang nutzbar:
# - *Mustermann* - "contains"
# - "Dr. Manfred*" - "startsWith"
# - "* MBA" - "endsWith"
# treffen alle "Dr. Manfred Mustermann MBA".
#
# o Suche nach Vorhandensein ODER leerem Inhalt eines Attributs des
# VZD Datensatzes durch Belegung des Attributs im GET Request mit "" in den Parametern
# - givenName
# - sn
# - cn
# - displayName
# - streetAddress
# - postalCode
# - countryCode
# - localityName
# - stateOrProvinceName
# - title
# - organization
# - otherName
# - specialization
# - domainID
# - holder
# - professionOID
# - maxKOMLEadr
# - changeDateTimeFrom
# - changeDateTimeTo
# Diese Suche findet sowohl Datensätze mit nicht vorhandenem Attribut
# wie auch vorhandenem aber leerem Attribut.
# Alle Filterparameter einer Leseoperationen werden mit einem UND (&) verknüpft.
#
operationId: read_Directory_Entry_for_Sync_paging
parameters:
- name: uid
in: query
description: ID von dem Verzeichniseintrag (distinguishedName.uid)
schema:
type: string
- name: givenName
in: query
description: Erlaubt die Suche mit Hilfe des Attributs givenName.
schema:
type: string
- name: sn
in: query
description: Erlaubt die Suche mit Hilfe des Attributs sn.
schema:
type: string
- name: cn
in: query
description: Erlaubt die Suche mit Hilfe des Attributs cn.
schema:
type: string
- name: displayName
in: query
description: Erlaubt die Suche mit Hilfe des Attributs displayName.
schema:
type: string
- name: streetAddress
in: query
description: Erlaubt die Suche mit Hilfe des Attributs streetAddress.
schema:
type: string
- name: postalCode
in: query
description: Erlaubt die Suche mit Hilfe des Attributs postalCode.
schema:
type: string
- name: countryCode
in: query
description: Erlaubt die Suche mit Hilfe des Attributs countryCode.
schema:
type: string
- name: localityName
in: query
description: Erlaubt die Suche mit Hilfe des Attributs localityName.
schema:
type: string
- name: stateOrProvinceName
in: query
description: Erlaubt die Suche mit Hilfe des Attributs stateOrProvinceName.
schema:
type: string
- name: title
in: query
description: Erlaubt die Suche mit Hilfe des Attributs title.
schema:
type: string
- name: organization
in: query
description: Erlaubt die Suche mit Hilfe des Attributs organization.
schema:
type: string
- name: otherName
in: query
description: Erlaubt die Suche mit Hilfe des Attributs otherName.
schema:
type: string
- name: telematikID
in: query
description: Erlaubt die Suche mit Hilfe des Attributs telematikID (die telematikID in den Basisdaten).
schema:
type: string
- name: telematikID-SubStr
in: query
description: Erlaubt die Suche nach einem Substring am Anfang der telematikID (die telematikID in den Basisdaten).
Entspricht der LDAP Filters Substring Assertion vom Typ "subInitial Component".
schema:
type: string
- name: specialization
in: query
description: Erlaubt die Suche mit Hilfe des Attributs specialization.
Der Verzeichniseintrag wird selektiert, wenn die angegebene domainID im Attribut domainID (array) des Verzeichniseintrags enthalten ist.
schema:
type: string
- name: domainID
in: query
description: Erlaubt die Suche mit Hilfe des Attributs domainID.
Der Verzeichniseintrag wird selektiert, wenn die angegebene domainID im Attribut domainID (array) des Verzeichniseintrags enthalten ist.
schema:
type: string
- name: holder
in: query
description: Erlaubt die Suche mit Hilfe des Attributs holder.
Der Verzeichniseintrag wird selektiert, wenn der angegebene holder im Attribut holder (array) des Verzeichniseintrags enthalten ist.
Wenn der Parameter mit dem eigenen Wert des Clients belegt wird, werden alle gefundenen Einträge zurückgegeben (für eigene Einträge gilt das Limit von 100 Ergebnissen nicht).
Zur Suche nach Einträge ohne holder ist der Parameter mit dem einem leeren String "" zu belegen. Auch in diesem Fall werden alle gefundenen Einträge zurückgegeben (für Einträge ohne holder gilt das Limit von 100 Ergebnissen nicht).
schema:
type: string
- name: personalEntry
in: query
description: Erlaubt die Suche mit Hilfe des Attributs personalEntry.
schema:
type: string
- name: dataFromAuthority
in: query
description: Erlaubt die Suche mit Hilfe des Attributs dataFromAuthority.
schema:
type: string
- name: maxKOMLEadr
in: query
description: Erlaubt die Suche mit Hilfe des Attributs maxKOMLEadr.
schema:
type: string
- name: changeDateTimeFrom
in: query
description: Erlaubt die Suche mit Hilfe des Attributs changeDateTime.
# Selektiert alle Datensätze mit
# changeDateTime >= changeDateTimeFrom
schema:
type: string
# format: date-time
example: "2017-07-21T17:32:28Z"
- name: changeDateTimeTo
in: query
description: Erlaubt die Suche mit Hilfe des Attributs changeDateTime.
# Selektiert alle Datensätze mit
# changeDateTime <= changeDateTimeTo
schema:
type: string
# format: date-time
example: "2018-07-21T17:32:28Z"
- name: baseEntryOnly
in: query
description: Mit baseEntryOnly = "true" wird nur der Basiseintrag (baseDirectoryEntry) im Response zurückgegeben. Falls nicht angegeben oder mit "false" belegt, wird der gesamte Verzeichniseintrag mit Zertifikaten und Fachdaten im Response zurückgegeben.
schema:
type: boolean
example: true
# Paging Parameter entsprechend https://tools.ietf.org/html/rfc2696
# Paging ist nur für eigene Verzeichniseinträge erlaubt. Deshalb muss bei
# Verwendung des Pagings zwingend der "holder" Suchparameter angegeben werden
# und den eigenen holderID (entsprechend dem Wert im ID_Token claim scope) enthalten.
# Siehe auch #/components/schemas/searchControlValue
- name: size
in: query
description: Paging Größe
# Entspricht realSearchControlValue.size in RFC2696.
# Maximal diese Anzahl von Verzeichniseinträgen sind in einem Response enthalten.
# In dem nächsten Response sind die nächsten Verzeichniseinträge enthalten.
schema:
type: integer
example: 50
- name: cookie
in: query
description: Paging Cookie
# Im ersten Request übergibt der Client einen leeren String in diesem Parameter.
# In den Folgerequests übernimmt der Client dieses Cookie jeweils aus dem letzten Response und erhält die nächsten Verzeichniseinträge.
schema:
type: string
responses:
200:
description: OK
# Es werden alle zu dem Filter Parametern passenden Verzeichniseinträge - inklusive Zertifikaten und Fachdaten - zurückgegeben.
# Bei mehr als 100 gefundenen Einträgen nur 100 gefundenen Einträge zurückgegeben.
# Wenn der Suchparameter "holder" mit dem eigenen Wert des Clients belegt wird, werden alle gefundenen Einträge zurückgegeben (für eigene Einträge gilt das Limit von 100 Ergebnissen nicht).
content:
application/json:
schema:
$ref: '#/components/schemas/readDirectoryEntryforSyncResponse'
401:
description: Unauthorized
# Der WWW-Authenticate Header im Response wird auf OAuth gesetzt.
content: {}
403:
description: Forbidden
content: {}
404:
description: Not Found
content: {}
503:
description: Service Unavailable
# Der Server schränkt die parallele Nutzung dieser Operation read_Directory_Entry_WL ein. Der Request kann nach einer angemessenen Zeitspanne wiederholt werden.
content: {}
/DirectoryEntries/{uid}/baseDirectoryEntries:
put:
tags:
- DirectoryEntry Administration
summary: Der Verzeichniseintrag (ohne Zertifikate und Fachdaten) wird mit den übergebenen Daten aktualisiert.
operationId: modify_Directory_Entry
parameters:
- name: uid
in: path
description: ID von dem Verzeichniseintrag
required: true
schema:
type: string
requestBody:
description: Datensatz für die Aktualisierung des Eintrags
Die Attribute müssen wie folgt belegt sein
dn.* Nicht vorhanden (Adressierung erfolgt über uid in Path).
givenName Nicht vorhanden.
sn Nicht vorhanden.
cn Nicht vorhanden.
displayName Kann optional belegt werden.
streetAddress Kann optional belegt werden.
postalCode Kann optional belegt werden.
countryCode Kann optional belegt werden.
localityName Kann optional belegt werden.
stateOrProvinceName Kann optional belegt werden.
title Kann optional belegt werden.
organization Kann optional belegt werden.
otherName Nicht vorhanden.
telematikID Kann optional belegt werden.
Das ist die telematikID in den Basisdaten (baseDirectoryEntry).
Sind Zertifikateseinträge (userCertificate) vorhanden, dann müssen die telematikIDs übereinstimmen.
Bei unterschiedlichen telematikID wird die Operation mit Fehlercode 422 abgelehnt.
specialization Kann optional belegt werden.
domainID Kann optional belegt werden.