generated from ghga-de/microservice-repository-template
-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
1539 lines (1539 loc) · 42.5 KB
/
openapi.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
components:
schemas:
AcademicTitle:
description: Academic title
enum:
- Dr.
- Prof.
title: AcademicTitle
type: string
AuthorityLevel:
description: Type of asserting authority
enum:
- self
- peer
- system
- so
- dac
title: AuthorityLevel
type: string
Claim:
additionalProperties: false
description: A claim about a user with a claim ID
properties:
asserted_by:
anyOf:
- $ref: '#/components/schemas/AuthorityLevel'
- type: 'null'
description: Authority level
examples:
- so
- dac
- system
assertion_date:
description: Date when the assertion was made
examples:
- '2022-11-30T12:00:00Z'
format: date-time
title: Assertion Date
type: string
conditions:
anyOf:
- items:
items:
$ref: '#/components/schemas/Condition-Output'
type: array
type: array
- type: 'null'
description: Set of conditions
title: Conditions
creation_date:
description: Date of creation of this claim
format: date-time
title: Creation Date
type: string
id:
description: Internal claim ID
title: Id
type: string
iva_id:
anyOf:
- type: string
- type: 'null'
description: ID of an IVA associated with this claim
title: Iva Id
revocation_date:
anyOf:
- format: date-time
type: string
- type: 'null'
description: If revoked, date of revocation
title: Revocation Date
source:
description: Asserting organization
examples:
- https://home.org
format: uri
maxLength: 2083
minLength: 1
title: Source
type: string
sub_source:
anyOf:
- type: string
- type: 'null'
description: Asserting sub-organization
examples:
- https://dac.home.org
title: Sub Source
user_id:
description: Internal user ID
title: User Id
type: string
valid_from:
description: Start date of validity
examples:
- '2023-01-01T00:00:00Z'
format: date-time
title: Valid From
type: string
valid_until:
description: End date of validity
examples:
- '2023-12-31T23:59:59Z'
format: date-time
title: Valid Until
type: string
visa_type:
$ref: '#/components/schemas/VisaType'
examples:
- AffiliationAndRole
visa_value:
anyOf:
- type: string
- type: 'null'
description: Scope of the claim depending of the visa type
examples:
title: Visa Value
required:
- valid_from
- valid_until
- visa_type
- visa_value
- assertion_date
- source
- user_id
- creation_date
- id
title: Claim
type: object
ClaimCreation:
additionalProperties: false
description: A claim made about a user with a user ID
properties:
asserted_by:
anyOf:
- $ref: '#/components/schemas/AuthorityLevel'
- type: 'null'
description: Authority level
examples:
- so
- dac
- system
assertion_date:
description: Date when the assertion was made
examples:
- '2022-11-30T12:00:00Z'
format: date-time
title: Assertion Date
type: string
conditions:
anyOf:
- items:
items:
$ref: '#/components/schemas/Condition-Input'
type: array
type: array
- type: 'null'
description: Set of conditions
title: Conditions
iva_id:
anyOf:
- type: string
- type: 'null'
description: ID of an IVA associated with this claim
title: Iva Id
source:
description: Asserting organization
examples:
- https://home.org
format: uri
maxLength: 2083
minLength: 1
title: Source
type: string
sub_source:
anyOf:
- format: uri
maxLength: 2083
minLength: 1
type: string
- type: 'null'
description: Asserting sub-organization
examples:
- https://dac.home.org
title: Sub Source
valid_from:
description: Start date of validity
examples:
- '2023-01-01T00:00:00Z'
format: date-time
title: Valid From
type: string
valid_until:
description: End date of validity
examples:
- '2023-12-31T23:59:59Z'
format: date-time
title: Valid Until
type: string
visa_type:
$ref: '#/components/schemas/VisaType'
examples:
- AffiliationAndRole
visa_value:
anyOf:
- format: email
type: string
- format: uri
maxLength: 2083
minLength: 1
type: string
- items:
$ref: '#/components/schemas/Identity'
type: array
description: Scope of the claim depending of the visa type
examples:
title: Visa Value
required:
- valid_from
- valid_until
- visa_type
- visa_value
- assertion_date
- source
title: ClaimCreation
type: object
ClaimMatch:
additionalProperties: false
description: A pair of a claim name and a match value with type
properties:
claim:
$ref: '#/components/schemas/MatchClaim'
match_type:
$ref: '#/components/schemas/MatchType'
match_value:
title: Match Value
type: string
required:
- claim
- match_type
- match_value
title: ClaimMatch
type: object
ClaimUpdate:
additionalProperties: false
description: A set of attributes that shall be updated in a claim.
properties:
revocation_date:
description: Date of revocation
format: date-time
title: Revocation Date
type: string
required:
- revocation_date
title: ClaimUpdate
type: object
ClaimValidity:
additionalProperties: false
description: Start and end dates for validating claims.
properties:
valid_from:
description: Start date of validity
examples:
- '2023-01-01T00:00:00Z'
format: date-time
title: Valid From
type: string
valid_until:
description: End date of validity
examples:
- '2023-12-31T23:59:59Z'
format: date-time
title: Valid Until
type: string
required:
- valid_from
- valid_until
title: ClaimValidity
type: object
Condition-Input:
additionalProperties: false
description: A single condition to check a type and a set of claims
properties:
matches:
items:
$ref: '#/components/schemas/ClaimMatch'
title: Matches
type: array
type:
$ref: '#/components/schemas/VisaType'
required:
- type
- matches
title: Condition
type: object
Condition-Output:
additionalProperties: false
description: A single condition to check a type and a set of claims
properties:
matches:
items:
$ref: '#/components/schemas/ClaimMatch'
title: Matches
type: array
type:
$ref: '#/components/schemas/VisaType'
required:
- type
- matches
title: Condition
type: object
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
title: Detail
type: array
title: HTTPValidationError
type: object
Identity:
additionalProperties: false
description: A user identity based on an iss/sub pair
properties:
iss:
description: OpenID Issuer
format: uri
maxLength: 2083
minLength: 1
title: Issuer
type: string
sub:
description: OpenID Subject
title: Subject
type: string
required:
- iss
- sub
title: Identity
type: object
IvaAndUserData:
additionalProperties: false
description: Independent Verification Address (IVA)
properties:
changed:
description: The date and time when the IVA was last changed
format: date-time
title: Changed
type: string
created:
description: The date and time when the IVA was created
format: date-time
title: Created
type: string
id:
description: Internal IVA ID
title: Id
type: string
state:
$ref: '#/components/schemas/IvaState'
default: Unverified
description: The state of the IVA
type:
$ref: '#/components/schemas/IvaType'
description: The type of the IVA
user_email:
description: The email address of the user
title: User Email
type: string
user_id:
description: The internal ID of the associated user
title: User Id
type: string
user_name:
description: The full name of the user
title: User Name
type: string
user_title:
anyOf:
- type: string
- type: 'null'
description: The academic title of the user
title: User Title
value:
description: The actual validation address
title: Value
type: string
required:
- created
- changed
- type
- value
- user_id
- user_name
- user_email
title: IVA
type: object
IvaBasicData:
additionalProperties: false
description: Basic IVA data
properties:
type:
$ref: '#/components/schemas/IvaType'
description: The type of the IVA
value:
description: The actual validation address
title: Value
type: string
required:
- type
- value
title: IvaBasicData
type: object
IvaData:
additionalProperties: false
description: Independent Verification Address (IVA)
properties:
changed:
description: The date and time when the IVA was last changed
format: date-time
title: Changed
type: string
created:
description: The date and time when the IVA was created
format: date-time
title: Created
type: string
id:
description: Internal IVA ID
title: Id
type: string
state:
$ref: '#/components/schemas/IvaState'
default: Unverified
description: The state of the IVA
type:
$ref: '#/components/schemas/IvaType'
description: The type of the IVA
value:
description: The actual validation address
title: Value
type: string
required:
- created
- changed
- type
- value
title: IVA
type: object
IvaId:
additionalProperties: false
description: The ID of an IVA
properties:
id:
description: Internal IVA ID
title: Id
type: string
title: IvaId
type: object
IvaState:
description: The state of an IVA
enum:
- Unverified
- CodeRequested
- CodeCreated
- CodeTransmitted
- Verified
title: IvaState
type: string
IvaType:
description: The type of IVA
enum:
- Phone
- Fax
- PostalAddress
- InPerson
title: IvaType
type: string
IvaVerificationCode:
additionalProperties: false
description: Request and response model containing the verification code for
an IVA.
properties:
verification_code:
description: The verification code for the IVA
title: Verification Code
type: string
required:
- verification_code
title: IvaVerificationCode
type: object
MatchClaim:
description: Possible visa claim names for conditions
enum:
- by
- source
- value
title: MatchClaim
type: string
MatchType:
description: Type of matching a claim value
enum:
- const
- pattern
- split_pattern
title: MatchType
type: string
StatusChange:
additionalProperties: false
description: Details of a status change
properties:
by:
anyOf:
- type: string
- type: 'null'
description: ID of the user who changed the status
title: Changed by
change_date:
anyOf:
- format: date-time
type: string
- type: 'null'
description: Date of last change
title: Change Date
context:
anyOf:
- type: string
- type: 'null'
description: Status change context
title: Context
previous:
anyOf:
- $ref: '#/components/schemas/UserStatus'
- type: 'null'
description: Previous user status
title: StatusChange
type: object
User:
additionalProperties: false
description: Complete user model with ID
properties:
active_access_requests:
default: []
description: List of IDs of all active data access requests created by the
user
items:
type: string
title: Active Access Requests
type: array
active_submissions:
default: []
description: List of IDs of all active submissions created by the user
items:
type: string
title: Active Submissions
type: array
email:
description: Preferred e-mail address of the user
examples:
format: email
title: Email
type: string
ext_id:
description: External (Life Science) ID
examples:
format: email
title: External ID
type: string
id:
description: Internal user ID
title: Id
type: string
name:
description: Full name of the user
examples:
- Rosalind Franklin
title: Name
type: string
registration_date:
description: Date when the user was registered
format: date-time
title: Registration Date
type: string
status:
$ref: '#/components/schemas/UserStatus'
description: Registration status of the user
status_change:
anyOf:
- $ref: '#/components/schemas/StatusChange'
- type: 'null'
description: Last status change
title:
anyOf:
- $ref: '#/components/schemas/AcademicTitle'
- type: 'null'
description: Academic title of the user
title: Academic title
required:
- registration_date
- name
- email
- ext_id
- status
title: User
type: object
UserBasicData:
additionalProperties: false
description: Basic data of a user
properties:
email:
description: Preferred e-mail address of the user
examples:
format: email
title: Email
type: string
name:
description: Full name of the user
examples:
- Rosalind Franklin
title: Name
type: string
title:
anyOf:
- $ref: '#/components/schemas/AcademicTitle'
- type: 'null'
description: Academic title of the user
title: Academic title
required:
- name
- email
title: UserBasicData
type: object
UserModifiableData:
additionalProperties: false
description: User data that can be modified
properties:
status:
anyOf:
- $ref: '#/components/schemas/UserStatus'
- type: 'null'
description: Registration status of the user
title:
anyOf:
- $ref: '#/components/schemas/AcademicTitle'
- type: 'null'
description: Academic title of the user
title: Academic title
title: UserModifiableData
type: object
UserRegisteredData:
additionalProperties: false
description: Basic data of a registered user
properties:
email:
description: Preferred e-mail address of the user
examples:
format: email
title: Email
type: string
ext_id:
description: External (Life Science) ID
examples:
format: email
title: External ID
type: string
name:
description: Full name of the user
examples:
- Rosalind Franklin
title: Name
type: string
title:
anyOf:
- $ref: '#/components/schemas/AcademicTitle'
- type: 'null'
description: Academic title of the user
title: Academic title
required:
- name
- email
- ext_id
title: UserRegisteredData
type: object
UserStatus:
description: User status enum
enum:
- active
- inactive
title: UserStatus
type: string
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
title: Location
type: array
msg:
title: Message
type: string
type:
title: Error Type
type: string
required:
- loc
- msg
- type
title: ValidationError
type: object
VisaType:
description: Type of a visa
enum:
- AffiliationAndRole
- AcceptedTermsAndPolicies
- ResearcherStatus
- ControlledAccessGrants
- LinkedIdentities
- https://www.ghga.de/GA4GH/VisaTypes/Role/v1.0
title: VisaType
type: string
securitySchemes:
HTTPBearer:
scheme: bearer
type: http
info:
contact:
email: [email protected]
name: GHGA
description: REST API for managing the GHGA users and user claims
license:
name: Apache 2.0
title: User Management API
version: 2.7.0
openapi: 3.1.0
paths:
/download-access/users/{user_id}/datasets:
get:
description: Endpoint to get a list of the IDs of all datasets that can be downloaded
by the given user. For internal use only.
operationId: get_download_access_list
parameters:
- description: Internal ID of the user
in: path
name: user_id
required: true
schema:
description: Internal ID of the user
title: User Id
type: string
responses:
'200':
content:
application/json:
schema:
items:
type: string
title: Response Get Download Access List
type: array
description: Dataset IDs with download access have been retrieved.
'404':
description: The user was not found or is inactive.
'422':
description: Validation error in submitted user IDs.
summary: Get list of all dataset IDs with download access permission
tags:
- datasets
/download-access/users/{user_id}/datasets/{dataset_id}:
get:
description: Endpoint to check whether the given dataset can be downloaded by
the given user. For internal use only.
operationId: check_download_access
parameters:
- description: Internal ID of the user
in: path
name: user_id
required: true
schema:
description: Internal ID of the user
title: User Id
type: string
- description: Internal ID of the dataset
in: path
name: dataset_id
required: true
schema:
description: Internal ID of the dataset
pattern: ^[A-Z]{1,6}[0-9]{3,18}$
title: Dataset Id
type: string
responses:
'200':
content:
application/json:
schema:
title: Response Check Download Access
type: boolean
description: Download access has been checked.
'404':
description: The user was not found or is inactive.
'422':
description: Validation error in submitted user IDs.
summary: Check download access permission for a dataset
tags:
- datasets
/download-access/users/{user_id}/ivas/{iva_id}/datasets/{dataset_id}:
post:
description: Endpoint to add a controlled access grant for a given dataset so
that it can be downloaded by the given user with the given IVA. For internal
use only.
operationId: grant_download_access
parameters:
- description: The internal ID of the user
in: path
name: user_id
required: true
schema:
description: The internal ID of the user
title: User Id
type: string
- description: The ID of the IVA
in: path
name: iva_id
required: true
schema:
description: The ID of the IVA
title: Iva Id
type: string
- description: The ID of the dataset
in: path
name: dataset_id
required: true
schema:
description: The ID of the dataset
pattern: ^[A-Z]{1,6}[0-9]{3,18}$
title: Dataset Id
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ClaimValidity'
required: true
responses:
'204':
description: Download access has been granted.
'404':
description: The user or the IVA was not found.
'422':
description: Validation error in submitted user IDs.
summary: Grant download access permission for a dataset
tags:
- datasets
/health:
get:
description: Used to check that this service is alive
operationId: health_health_get
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
summary: health
tags:
- health
/ivas:
get:
description: Endpoint used to get all IVAs and their corresponding users. Can
only be performed by a data steward.
operationId: get_all_ivas
parameters:
- description: Filter for the internal user ID
in: query
name: user_id
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Filter for the internal user ID
title: User Id
- description: Filter for the state of the IVA
in: query
name: state
required: false
schema:
anyOf:
- $ref: '#/components/schemas/IvaState'
- type: 'null'
description: Filter for the state of the IVA
title: State
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/IvaData'
title: Response 200 Get All Ivas
type: array
description: IVAs have been retrieved.
'403':
description: Not authorized to request IVAs.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- HTTPBearer: []
summary: Get all IVAs
tags:
- users
/rpc/ivas/{iva_id}/code-transmitted:
post:
description: Endpoint used to confirm that the verification code for an IVA
has been transmitted.
operationId: code_transmitted_for_iva
parameters:
- description: IVA ID
in: path
name: iva_id
required: true
schema:
description: IVA ID
title: Iva Id
type: string
responses:
'204':
description: The verification code for the IVA has been confirmed as transmitted.
'401':
description: Not authenticated.
'403':
description: Not authorized to confirm the transmission of verification
codes for IVAs.
'404':
description: The IVA was not found.
'409':
description: The IVA does not have the proper state.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- HTTPBearer: []
summary: Confirm verification code transmission for an IVA
tags:
- users
/rpc/ivas/{iva_id}/create-code:
post:
description: Endpoint used to create a verification code for a given IVA.
operationId: create_code_for_iva
parameters:
- description: IVA ID
in: path
name: iva_id
required: true
schema:
description: IVA ID
title: Iva Id
type: string
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/IvaVerificationCode'
description: A verification code for the IVA has been created.
'401':
description: Not authenticated.
'403':
description: Not authorized to create verification codes for IVAs.
'404':
description: The IVA was not found.
'409':
description: The IVA does not have the proper state.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- HTTPBearer: []
summary: Create verification code for an IVA
tags:
- users
/rpc/ivas/{iva_id}/request-code: