-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi.json
3891 lines (3891 loc) · 164 KB
/
api.json
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": {
"responses": {
"emptyResponse": {
"description": "Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is\ntypically 201."
},
"errorOAuth2BadRequest": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorOAuth2"
}
}
},
"description": "Bad Request Error Response"
},
"errorOAuth2Default": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorOAuth2"
}
}
},
"description": "Default Error Response"
},
"errorOAuth2NotFound": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/errorOAuth2"
}
}
},
"description": "Not Found Error Response"
},
"listOAuth2Clients": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/oAuth2Client"
},
"type": "array"
}
}
},
"description": "Paginated OAuth2 Client List Response"
}
},
"schemas": {
"CreateVerifiableCredentialRequestBody": {
"properties": {
"format": {
"type": "string"
},
"proof": {
"$ref": "#/components/schemas/VerifiableCredentialProof"
},
"types": {
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "CreateVerifiableCredentialRequestBody contains the request body to request a verifiable credential.",
"type": "object"
},
"DefaultError": {},
"JSONRawMessage": {
"title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger."
},
"NullBool": {
"nullable": true,
"type": "boolean"
},
"NullDuration": {
"description": "Specify a time duration in milliseconds, seconds, minutes, hours.",
"pattern": "^([0-9]+(ns|us|ms|s|m|h))*$",
"title": "Time duration",
"type": "string"
},
"NullInt": {
"nullable": true,
"type": "integer"
},
"NullString": {
"nullable": true,
"type": "string"
},
"NullTime": {
"format": "date-time",
"nullable": true,
"type": "string"
},
"NullUUID": {
"format": "uuid4",
"nullable": true,
"type": "string"
},
"RFC6749ErrorJson": {
"properties": {
"error": {
"type": "string"
},
"error_debug": {
"type": "string"
},
"error_description": {
"type": "string"
},
"error_hint": {
"type": "string"
},
"status_code": {
"format": "int64",
"type": "integer"
}
},
"title": "RFC6749ErrorJson is a helper struct for JSON encoding/decoding of RFC6749Error.",
"type": "object"
},
"StringSliceJSONFormat": {
"items": {
"type": "string"
},
"title": "StringSliceJSONFormat represents []string{} which is encoded to/from JSON for SQL storage.",
"type": "array"
},
"Time": {
"format": "date-time",
"type": "string"
},
"UUID": {
"format": "uuid4",
"type": "string"
},
"VerifiableCredentialProof": {
"properties": {
"jwt": {
"type": "string"
},
"proof_type": {
"type": "string"
}
},
"title": "VerifiableCredentialProof contains the proof of a verifiable credential.",
"type": "object"
},
"acceptOAuth2ConsentRequest": {
"properties": {
"context": {
"$ref": "#/components/schemas/JSONRawMessage"
},
"grant_access_token_audience": {
"$ref": "#/components/schemas/StringSliceJSONFormat"
},
"grant_scope": {
"$ref": "#/components/schemas/StringSliceJSONFormat"
},
"handled_at": {
"$ref": "#/components/schemas/nullTime"
},
"remember": {
"description": "Remember, if set to true, tells ORY Hydra to remember this consent authorization and reuse it if the same\nclient asks the same user for the same, or a subset of, scope.",
"type": "boolean"
},
"remember_for": {
"description": "RememberFor sets how long the consent authorization should be remembered for in seconds. If set to `0`, the\nauthorization will be remembered indefinitely.",
"format": "int64",
"type": "integer"
},
"session": {
"$ref": "#/components/schemas/acceptOAuth2ConsentRequestSession"
}
},
"title": "The request payload used to accept a consent request.",
"type": "object"
},
"acceptOAuth2ConsentRequestSession": {
"properties": {
"access_token": {
"description": "AccessToken sets session data for the access and refresh token, as well as any future tokens issued by the\nrefresh grant. Keep in mind that this data will be available to anyone performing OAuth 2.0 Challenge Introspection.\nIf only your services can perform OAuth 2.0 Challenge Introspection, this is usually fine. But if third parties\ncan access that endpoint as well, sensitive data from the session might be exposed to them. Use with care!"
},
"id_token": {
"description": "IDToken sets session data for the OpenID Connect ID token. Keep in mind that the session'id payloads are readable\nby anyone that has access to the ID Challenge. Use with care!"
}
},
"title": "Pass session data to a consent request.",
"type": "object"
},
"acceptOAuth2LoginRequest": {
"properties": {
"acr": {
"description": "ACR sets the Authentication AuthorizationContext Class Reference value for this authentication session. You can use it\nto express that, for example, a user authenticated using two factor authentication.",
"type": "string"
},
"amr": {
"$ref": "#/components/schemas/StringSliceJSONFormat"
},
"context": {
"$ref": "#/components/schemas/JSONRawMessage"
},
"extend_session_lifespan": {
"description": "Extend OAuth2 authentication session lifespan\n\nIf set to `true`, the OAuth2 authentication cookie lifespan is extended. This is for example useful if you want the user to be able to use `prompt=none` continuously.\n\nThis value can only be set to `true` if the user has an authentication, which is the case if the `skip` value is `true`.",
"type": "boolean"
},
"force_subject_identifier": {
"description": "ForceSubjectIdentifier forces the \"pairwise\" user ID of the end-user that authenticated. The \"pairwise\" user ID refers to the\n(Pairwise Identifier Algorithm)[http://openid.net/specs/openid-connect-core-1_0.html#PairwiseAlg] of the OpenID\nConnect specification. It allows you to set an obfuscated subject (\"user\") identifier that is unique to the client.\n\nPlease note that this changes the user ID on endpoint /userinfo and sub claim of the ID Token. It does not change the\nsub claim in the OAuth 2.0 Introspection.\n\nPer default, ORY Hydra handles this value with its own algorithm. In case you want to set this yourself\nyou can use this field. Please note that setting this field has no effect if `pairwise` is not configured in\nORY Hydra or the OAuth 2.0 Client does not expect a pairwise identifier (set via `subject_type` key in the client's\nconfiguration).\n\nPlease also be aware that ORY Hydra is unable to properly compute this value during authentication. This implies\nthat you have to compute this value on every authentication process (probably depending on the client ID or some\nother unique value).\n\nIf you fail to compute the proper value, then authentication processes which have id_token_hint set might fail.",
"type": "string"
},
"identity_provider_session_id": {
"description": "IdentityProviderSessionID is the session ID of the end-user that authenticated.\nIf specified, we will use this value to propagate the logout.",
"type": "string"
},
"remember": {
"description": "Remember, if set to true, tells ORY Hydra to remember this user by telling the user agent (browser) to store\na cookie with authentication data. If the same user performs another OAuth 2.0 Authorization Request, he/she\nwill not be asked to log in again.",
"type": "boolean"
},
"remember_for": {
"description": "RememberFor sets how long the authentication should be remembered for in seconds. If set to `0`, the\nauthorization will be remembered for the duration of the browser session (using a session cookie).",
"format": "int64",
"type": "integer"
},
"subject": {
"description": "Subject is the user ID of the end-user that authenticated.",
"type": "string"
}
},
"required": [
"subject"
],
"title": "HandledLoginRequest is the request payload used to accept a login request.",
"type": "object"
},
"createJsonWebKeySet": {
"description": "Create JSON Web Key Set Request Body",
"properties": {
"alg": {
"description": "JSON Web Key Algorithm\n\nThe algorithm to be used for creating the key. Supports `RS256`, `ES256`, `ES512`, `HS512`, and `HS256`.",
"type": "string"
},
"kid": {
"description": "JSON Web Key ID\n\nThe Key ID of the key to be created.",
"type": "string"
},
"use": {
"description": "JSON Web Key Use\n\nThe \"use\" (public key use) parameter identifies the intended use of\nthe public key. The \"use\" parameter is employed to indicate whether\na public key is used for encrypting data or verifying the signature\non data. Valid values are \"enc\" and \"sig\".",
"type": "string"
}
},
"required": [
"alg",
"use",
"kid"
],
"type": "object"
},
"credentialSupportedDraft00": {
"description": "Includes information about the supported verifiable credentials.",
"properties": {
"cryptographic_binding_methods_supported": {
"description": "OpenID Connect Verifiable Credentials Cryptographic Binding Methods Supported\n\nContains a list of cryptographic binding methods supported for signing the proof.",
"items": {
"type": "string"
},
"type": "array"
},
"cryptographic_suites_supported": {
"description": "OpenID Connect Verifiable Credentials Cryptographic Suites Supported\n\nContains a list of cryptographic suites methods supported for signing the proof.",
"items": {
"type": "string"
},
"type": "array"
},
"format": {
"description": "OpenID Connect Verifiable Credentials Format\n\nContains the format that is supported by this authorization server.",
"type": "string"
},
"types": {
"description": "OpenID Connect Verifiable Credentials Types\n\nContains the types of verifiable credentials supported.",
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "Verifiable Credentials Metadata (Draft 00)",
"type": "object"
},
"errorOAuth2": {
"description": "Error",
"properties": {
"error": {
"description": "Error",
"type": "string"
},
"error_debug": {
"description": "Error Debug Information\n\nOnly available in dev mode.",
"type": "string"
},
"error_description": {
"description": "Error Description",
"type": "string"
},
"error_hint": {
"description": "Error Hint\n\nHelps the user identify the error cause.",
"example": "The redirect URL is not allowed.",
"type": "string"
},
"status_code": {
"description": "HTTP Status Code",
"example": 401,
"format": "int64",
"type": "integer"
}
},
"type": "object"
},
"genericError": {
"properties": {
"code": {
"description": "The status code",
"example": 404,
"format": "int64",
"type": "integer"
},
"debug": {
"description": "Debug information\n\nThis field is often not exposed to protect against leaking\nsensitive information.",
"example": "SQL field \"foo\" is not a bool.",
"type": "string"
},
"details": {
"description": "Further error details"
},
"id": {
"description": "The error ID\n\nUseful when trying to identify various errors in application logic.",
"type": "string"
},
"message": {
"description": "Error message\n\nThe error's message.",
"example": "The resource could not be found",
"type": "string"
},
"reason": {
"description": "A human-readable reason for the error",
"example": "User with ID 1234 does not exist.",
"type": "string"
},
"request": {
"description": "The request ID\n\nThe request ID is often exposed internally in order to trace\nerrors across service architectures. This is often a UUID.",
"example": "d7ef54b1-ec15-46e6-bccb-524b82c035e6",
"type": "string"
},
"status": {
"description": "The status description",
"example": "Not Found",
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
},
"healthNotReadyStatus": {
"properties": {
"errors": {
"additionalProperties": {
"type": "string"
},
"description": "Errors contains a list of errors that caused the not ready status.",
"type": "object"
}
},
"type": "object"
},
"healthStatus": {
"properties": {
"status": {
"description": "Status always contains \"ok\".",
"type": "string"
}
},
"type": "object"
},
"introspectedOAuth2Token": {
"description": "Introspection contains an access token's session data as specified by\n[IETF RFC 7662](https://tools.ietf.org/html/rfc7662)",
"properties": {
"active": {
"description": "Active is a boolean indicator of whether or not the presented token\nis currently active. The specifics of a token's \"active\" state\nwill vary depending on the implementation of the authorization\nserver and the information it keeps about its tokens, but a \"true\"\nvalue return for the \"active\" property will generally indicate\nthat a given token has been issued by this authorization server,\nhas not been revoked by the resource owner, and is within its\ngiven time window of validity (e.g., after its issuance time and\nbefore its expiration time).",
"type": "boolean"
},
"aud": {
"description": "Audience contains a list of the token's intended audiences.",
"items": {
"type": "string"
},
"type": "array"
},
"client_id": {
"description": "ID is aclient identifier for the OAuth 2.0 client that\nrequested this token.",
"type": "string"
},
"exp": {
"description": "Expires at is an integer timestamp, measured in the number of seconds\nsince January 1 1970 UTC, indicating when this token will expire.",
"format": "int64",
"type": "integer"
},
"ext": {
"additionalProperties": {},
"description": "Extra is arbitrary data set by the session.",
"type": "object"
},
"iat": {
"description": "Issued at is an integer timestamp, measured in the number of seconds\nsince January 1 1970 UTC, indicating when this token was\noriginally issued.",
"format": "int64",
"type": "integer"
},
"iss": {
"description": "IssuerURL is a string representing the issuer of this token",
"type": "string"
},
"nbf": {
"description": "NotBefore is an integer timestamp, measured in the number of seconds\nsince January 1 1970 UTC, indicating when this token is not to be\nused before.",
"format": "int64",
"type": "integer"
},
"obfuscated_subject": {
"description": "ObfuscatedSubject is set when the subject identifier algorithm was set to \"pairwise\" during authorization.\nIt is the `sub` value of the ID Token that was issued.",
"type": "string"
},
"scope": {
"description": "Scope is a JSON string containing a space-separated list of\nscopes associated with this token.",
"type": "string"
},
"sub": {
"description": "Subject of the token, as defined in JWT [RFC7519].\nUsually a machine-readable identifier of the resource owner who\nauthorized this token.",
"type": "string"
},
"token_type": {
"description": "TokenType is the introspected token's type, typically `Bearer`.",
"type": "string"
},
"token_use": {
"description": "TokenUse is the introspected token's use, for example `access_token` or `refresh_token`.",
"type": "string"
},
"username": {
"description": "Username is a human-readable identifier for the resource owner who\nauthorized this token.",
"type": "string"
}
},
"required": [
"active"
],
"type": "object"
},
"jsonPatch": {
"description": "A JSONPatch document as defined by RFC 6902",
"properties": {
"from": {
"description": "This field is used together with operation \"move\" and uses JSON Pointer notation.\n\nLearn more [about JSON Pointers](https://datatracker.ietf.org/doc/html/rfc6901#section-5).",
"example": "/name",
"type": "string"
},
"op": {
"description": "The operation to be performed. One of \"add\", \"remove\", \"replace\", \"move\", \"copy\", or \"test\".",
"example": "replace",
"type": "string"
},
"path": {
"description": "The path to the target path. Uses JSON pointer notation.\n\nLearn more [about JSON Pointers](https://datatracker.ietf.org/doc/html/rfc6901#section-5).",
"example": "/name",
"type": "string"
},
"value": {
"description": "The value to be used within the operations.\n\nLearn more [about JSON Pointers](https://datatracker.ietf.org/doc/html/rfc6901#section-5).",
"example": "foobar"
}
},
"required": [
"op",
"path"
],
"type": "object"
},
"jsonPatchDocument": {
"description": "A JSONPatchDocument request",
"items": {
"$ref": "#/components/schemas/jsonPatch"
},
"type": "array"
},
"jsonWebKey": {
"properties": {
"alg": {
"description": "The \"alg\" (algorithm) parameter identifies the algorithm intended for\nuse with the key. The values used should either be registered in the\nIANA \"JSON Web Signature and Encryption Algorithms\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name.",
"example": "RS256",
"type": "string"
},
"crv": {
"example": "P-256",
"type": "string"
},
"d": {
"example": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE",
"type": "string"
},
"dp": {
"example": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0",
"type": "string"
},
"dq": {
"example": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk",
"type": "string"
},
"e": {
"example": "AQAB",
"type": "string"
},
"k": {
"example": "GawgguFyGrWKav7AX4VKUg",
"type": "string"
},
"kid": {
"description": "The \"kid\" (key ID) parameter is used to match a specific key. This\nis used, for instance, to choose among a set of keys within a JWK Set\nduring key rollover. The structure of the \"kid\" value is\nunspecified. When \"kid\" values are used within a JWK Set, different\nkeys within the JWK Set SHOULD use distinct \"kid\" values. (One\nexample in which different keys might use the same \"kid\" value is if\nthey have different \"kty\" (key type) values but are considered to be\nequivalent alternatives by the application using them.) The \"kid\"\nvalue is a case-sensitive string.",
"example": "1603dfe0af8f4596",
"type": "string"
},
"kty": {
"description": "The \"kty\" (key type) parameter identifies the cryptographic algorithm\nfamily used with the key, such as \"RSA\" or \"EC\". \"kty\" values should\neither be registered in the IANA \"JSON Web Key Types\" registry\nestablished by [JWA] or be a value that contains a Collision-\nResistant Name. The \"kty\" value is a case-sensitive string.",
"example": "RSA",
"type": "string"
},
"n": {
"example": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0",
"type": "string"
},
"p": {
"example": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ",
"type": "string"
},
"q": {
"example": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ",
"type": "string"
},
"qi": {
"example": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU",
"type": "string"
},
"use": {
"description": "Use (\"public key use\") identifies the intended use of\nthe public key. The \"use\" parameter is employed to indicate whether\na public key is used for encrypting data or verifying the signature\non data. Values are commonly \"sig\" (signature) or \"enc\" (encryption).",
"example": "sig",
"type": "string"
},
"x": {
"example": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU",
"type": "string"
},
"x5c": {
"description": "The \"x5c\" (X.509 certificate chain) parameter contains a chain of one\nor more PKIX certificates [RFC5280]. The certificate chain is\nrepresented as a JSON array of certificate value strings. Each\nstring in the array is a base64-encoded (Section 4 of [RFC4648] --\nnot base64url-encoded) DER [ITU.X690.1994] PKIX certificate value.\nThe PKIX certificate containing the key value MUST be the first\ncertificate.",
"items": {
"type": "string"
},
"type": "array"
},
"y": {
"example": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0",
"type": "string"
}
},
"required": [
"use",
"kty",
"kid",
"alg"
],
"type": "object"
},
"jsonWebKeySet": {
"description": "JSON Web Key Set",
"properties": {
"keys": {
"description": "List of JSON Web Keys\n\nThe value of the \"keys\" parameter is an array of JSON Web Key (JWK)\nvalues. By default, the order of the JWK values within the array does\nnot imply an order of preference among them, although applications\nof JWK Sets can choose to assign a meaning to the order for their\npurposes, if desired.",
"items": {
"$ref": "#/components/schemas/jsonWebKey"
},
"type": "array"
}
},
"type": "object"
},
"nullDuration": {
"nullable": true,
"pattern": "^[0-9]+(ns|us|ms|s|m|h)$",
"type": "string"
},
"nullInt64": {
"nullable": true,
"type": "integer"
},
"nullTime": {
"format": "date-time",
"title": "NullTime implements sql.NullTime functionality.",
"type": "string"
},
"oAuth2Client": {
"description": "OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are\ngenerated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.",
"properties": {
"access_token_strategy": {
"description": "OAuth 2.0 Access Token Strategy\n\nAccessTokenStrategy is the strategy used to generate access tokens.\nValid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.sh/docs/hydra/advanced#json-web-tokens\nSetting the stragegy here overrides the global setting in `strategies.access_token`.",
"type": "string"
},
"allowed_cors_origins": {
"$ref": "#/components/schemas/StringSliceJSONFormat"
},
"audience": {
"$ref": "#/components/schemas/StringSliceJSONFormat"
},
"authorization_code_grant_access_token_lifespan": {
"$ref": "#/components/schemas/NullDuration"
},
"authorization_code_grant_id_token_lifespan": {
"$ref": "#/components/schemas/NullDuration"
},
"authorization_code_grant_refresh_token_lifespan": {
"$ref": "#/components/schemas/NullDuration"
},
"backchannel_logout_session_required": {
"description": "OpenID Connect Back-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout\nToken to identify the RP session with the OP when the backchannel_logout_uri is used.\nIf omitted, the default value is false.",
"type": "boolean"
},
"backchannel_logout_uri": {
"description": "OpenID Connect Back-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when sent a Logout Token by the OP.",
"type": "string"
},
"client_credentials_grant_access_token_lifespan": {
"$ref": "#/components/schemas/NullDuration"
},
"client_id": {
"description": "OAuth 2.0 Client ID\n\nThe ID is immutable. If no ID is provided, a UUID4 will be generated.",
"type": "string"
},
"client_name": {
"description": "OAuth 2.0 Client Name\n\nThe human-readable name of the client to be presented to the\nend-user during authorization.",
"type": "string"
},
"client_secret": {
"description": "OAuth 2.0 Client Secret\n\nThe secret will be included in the create request as cleartext, and then\nnever again. The secret is kept in hashed format and is not recoverable once lost.",
"type": "string"
},
"client_secret_expires_at": {
"description": "OAuth 2.0 Client Secret Expires At\n\nThe field is currently not supported and its value is always 0.",
"format": "int64",
"type": "integer"
},
"client_uri": {
"description": "OAuth 2.0 Client URI\n\nClientURI is a URL string of a web page providing information about the client.\nIf present, the server SHOULD display this URL to the end-user in\na clickable fashion.",
"type": "string"
},
"contacts": {
"$ref": "#/components/schemas/StringSliceJSONFormat"
},
"created_at": {
"description": "OAuth 2.0 Client Creation Date\n\nCreatedAt returns the timestamp of the client's creation.",
"format": "date-time",
"type": "string"
},
"frontchannel_logout_session_required": {
"description": "OpenID Connect Front-Channel Logout Session Required\n\nBoolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be\nincluded to identify the RP session with the OP when the frontchannel_logout_uri is used.\nIf omitted, the default value is false.",
"type": "boolean"
},
"frontchannel_logout_uri": {
"description": "OpenID Connect Front-Channel Logout URI\n\nRP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query\nparameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the\nrequest and to determine which of the potentially multiple sessions is to be logged out; if either is\nincluded, both MUST be.",
"type": "string"
},
"grant_types": {
"$ref": "#/components/schemas/StringSliceJSONFormat"
},
"implicit_grant_access_token_lifespan": {
"$ref": "#/components/schemas/NullDuration"
},
"implicit_grant_id_token_lifespan": {
"$ref": "#/components/schemas/NullDuration"
},
"jwks": {
"description": "OAuth 2.0 Client JSON Web Key Set\n\nClient's JSON Web Key Set [JWK] document, passed by value. The semantics of the jwks parameter are the same as\nthe jwks_uri parameter, other than that the JWK Set is passed by value, rather than by reference. This parameter\nis intended only to be used by Clients that, for some reason, are unable to use the jwks_uri parameter, for\ninstance, by native applications that might not have a location to host the contents of the JWK Set. If a Client\ncan use jwks_uri, it MUST NOT use jwks. One significant downside of jwks is that it does not enable key rotation\n(which jwks_uri does, as described in Section 10 of OpenID Connect Core 1.0 [OpenID.Core]). The jwks_uri and jwks\nparameters MUST NOT be used together."
},
"jwks_uri": {
"description": "OAuth 2.0 Client JSON Web Key Set URL\n\nURL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains\nthe signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the\nClient's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing\nand encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced\nJWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both\nsignatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used\nto provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST\nmatch those in the certificate.",
"type": "string"
},
"jwt_bearer_grant_access_token_lifespan": {
"$ref": "#/components/schemas/NullDuration"
},
"logo_uri": {
"description": "OAuth 2.0 Client Logo URI\n\nA URL string referencing the client's logo.",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/JSONRawMessage"
},
"owner": {
"description": "OAuth 2.0 Client Owner\n\nOwner is a string identifying the owner of the OAuth 2.0 Client.",
"type": "string"
},
"policy_uri": {
"description": "OAuth 2.0 Client Policy URI\n\nPolicyURI is a URL string that points to a human-readable privacy policy document\nthat describes how the deployment organization collects, uses,\nretains, and discloses personal data.",
"type": "string"
},
"post_logout_redirect_uris": {
"$ref": "#/components/schemas/StringSliceJSONFormat"
},
"redirect_uris": {
"$ref": "#/components/schemas/StringSliceJSONFormat"
},
"refresh_token_grant_access_token_lifespan": {
"$ref": "#/components/schemas/NullDuration"
},
"refresh_token_grant_id_token_lifespan": {
"$ref": "#/components/schemas/NullDuration"
},
"refresh_token_grant_refresh_token_lifespan": {
"$ref": "#/components/schemas/NullDuration"
},
"registration_access_token": {
"description": "OpenID Connect Dynamic Client Registration Access Token\n\nRegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client\nusing Dynamic Client Registration.",
"type": "string"
},
"registration_client_uri": {
"description": "OpenID Connect Dynamic Client Registration URL\n\nRegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client.",
"type": "string"
},
"request_object_signing_alg": {
"description": "OpenID Connect Request Object Signing Algorithm\n\nJWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects\nfrom this Client MUST be rejected, if not signed with this algorithm.",
"type": "string"
},
"request_uris": {
"$ref": "#/components/schemas/StringSliceJSONFormat"
},
"response_types": {
"$ref": "#/components/schemas/StringSliceJSONFormat"
},
"scope": {
"description": "OAuth 2.0 Client Scope\n\nScope is a string containing a space-separated list of scope values (as\ndescribed in Section 3.3 of OAuth 2.0 [RFC6749]) that the client\ncan use when requesting access tokens.",
"example": "scope1 scope-2 scope.3 scope:4",
"type": "string"
},
"sector_identifier_uri": {
"description": "OpenID Connect Sector Identifier URI\n\nURL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a\nfile with a single JSON array of redirect_uri values.",
"type": "string"
},
"skip_consent": {
"description": "SkipConsent skips the consent screen for this client. This field can only\nbe set from the admin API.",
"type": "boolean"
},
"skip_logout_consent": {
"description": "SkipLogoutConsent skips the logout consent screen for this client. This field can only\nbe set from the admin API.",
"type": "boolean"
},
"subject_type": {
"description": "OpenID Connect Subject Type\n\nThe `subject_types_supported` Discovery parameter contains a\nlist of the supported subject_type values for this server. Valid types include `pairwise` and `public`.",
"type": "string"
},
"token_endpoint_auth_method": {
"default": "client_secret_basic",
"description": "OAuth 2.0 Token Endpoint Authentication Method\n\nRequested Client Authentication method for the Token Endpoint. The options are:\n\n`client_secret_basic`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header.\n`client_secret_post`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body.\n`private_key_jwt`: Use JSON Web Tokens to authenticate the client.\n`none`: Used for public clients (native apps, mobile apps) which can not have secrets.",
"type": "string"
},
"token_endpoint_auth_signing_alg": {
"description": "OAuth 2.0 Token Endpoint Signing Algorithm\n\nRequested Client Authentication signing algorithm for the Token Endpoint.",
"type": "string"
},
"tos_uri": {
"description": "OAuth 2.0 Client Terms of Service URI\n\nA URL string pointing to a human-readable terms of service\ndocument for the client that describes a contractual relationship\nbetween the end-user and the client that the end-user accepts when\nauthorizing the client.",
"type": "string"
},
"updated_at": {
"description": "OAuth 2.0 Client Last Update Date\n\nUpdatedAt returns the timestamp of the last update.",
"format": "date-time",
"type": "string"
},
"userinfo_signed_response_alg": {
"description": "OpenID Connect Request Userinfo Signed Response Algorithm\n\nJWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT\n[JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims\nas a UTF-8 encoded JSON object using the application/json content-type.",
"type": "string"
}
},
"title": "OAuth 2.0 Client",
"type": "object"
},
"oAuth2ClientTokenLifespans": {
"description": "Lifespans of different token types issued for this OAuth 2.0 Client.",
"properties": {
"authorization_code_grant_access_token_lifespan": {
"$ref": "#/components/schemas/NullDuration"
},
"authorization_code_grant_id_token_lifespan": {
"$ref": "#/components/schemas/NullDuration"
},
"authorization_code_grant_refresh_token_lifespan": {
"$ref": "#/components/schemas/NullDuration"
},
"client_credentials_grant_access_token_lifespan": {
"$ref": "#/components/schemas/NullDuration"
},
"implicit_grant_access_token_lifespan": {
"$ref": "#/components/schemas/NullDuration"
},
"implicit_grant_id_token_lifespan": {
"$ref": "#/components/schemas/NullDuration"
},
"jwt_bearer_grant_access_token_lifespan": {
"$ref": "#/components/schemas/NullDuration"
},
"refresh_token_grant_access_token_lifespan": {
"$ref": "#/components/schemas/NullDuration"
},
"refresh_token_grant_id_token_lifespan": {
"$ref": "#/components/schemas/NullDuration"
},
"refresh_token_grant_refresh_token_lifespan": {
"$ref": "#/components/schemas/NullDuration"
}
},
"title": "OAuth 2.0 Client Token Lifespans",
"type": "object"
},
"oAuth2ConsentRequest": {
"properties": {
"acr": {
"description": "ACR represents the Authentication AuthorizationContext Class Reference value for this authentication session. You can use it\nto express that, for example, a user authenticated using two factor authentication.",
"type": "string"
},
"amr": {
"$ref": "#/components/schemas/StringSliceJSONFormat"
},
"challenge": {
"description": "ID is the identifier (\"authorization challenge\") of the consent authorization request. It is used to\nidentify the session.",
"type": "string"
},
"client": {
"$ref": "#/components/schemas/oAuth2Client"
},
"context": {
"$ref": "#/components/schemas/JSONRawMessage"
},
"login_challenge": {
"description": "LoginChallenge is the login challenge this consent challenge belongs to. It can be used to associate\na login and consent request in the login \u0026 consent app.",
"type": "string"
},
"login_session_id": {
"description": "LoginSessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag)\nthis ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false)\nthis will be a new random value. This value is used as the \"sid\" parameter in the ID Token and in OIDC Front-/Back-\nchannel logout. It's value can generally be used to associate consecutive login requests by a certain user.",
"type": "string"
},
"oidc_context": {
"$ref": "#/components/schemas/oAuth2ConsentRequestOpenIDConnectContext"
},
"request_url": {
"description": "RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which\ninitiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but\nmight come in handy if you want to deal with additional request parameters.",
"type": "string"
},
"requested_access_token_audience": {
"$ref": "#/components/schemas/StringSliceJSONFormat"
},
"requested_scope": {
"$ref": "#/components/schemas/StringSliceJSONFormat"
},
"skip": {
"description": "Skip, if true, implies that the client has requested the same scopes from the same user previously.\nIf true, you must not ask the user to grant the requested scopes. You must however either allow or deny the\nconsent request using the usual API call.",
"type": "boolean"
},
"subject": {
"description": "Subject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope\nrequested by the OAuth 2.0 client.",
"type": "string"
}
},
"required": [
"challenge"
],
"title": "Contains information on an ongoing consent request.",
"type": "object"
},
"oAuth2ConsentRequestOpenIDConnectContext": {
"properties": {
"acr_values": {
"description": "ACRValues is the Authentication AuthorizationContext Class Reference requested in the OAuth 2.0 Authorization request.\nIt is a parameter defined by OpenID Connect and expresses which level of authentication (e.g. 2FA) is required.\n\nOpenID Connect defines it as follows:\n\u003e Requested Authentication AuthorizationContext Class Reference values. Space-separated string that specifies the acr values\nthat the Authorization Server is being requested to use for processing this Authentication Request, with the\nvalues appearing in order of preference. The Authentication AuthorizationContext Class satisfied by the authentication\nperformed is returned as the acr Claim Value, as specified in Section 2. The acr Claim is requested as a\nVoluntary Claim by this parameter.",
"items": {
"type": "string"
},
"type": "array"
},
"display": {
"description": "Display is a string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User.\nThe defined values are:\npage: The Authorization Server SHOULD display the authentication and consent UI consistent with a full User Agent page view. If the display parameter is not specified, this is the default display mode.\npopup: The Authorization Server SHOULD display the authentication and consent UI consistent with a popup User Agent window. The popup User Agent window should be of an appropriate size for a login-focused dialog and should not obscure the entire window that it is popping up over.\ntouch: The Authorization Server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface.\nwap: The Authorization Server SHOULD display the authentication and consent UI consistent with a \"feature phone\" type display.\n\nThe Authorization Server MAY also attempt to detect the capabilities of the User Agent and present an appropriate display.",
"type": "string"
},
"id_token_hint_claims": {
"additionalProperties": {},
"description": "IDTokenHintClaims are the claims of the ID Token previously issued by the Authorization Server being passed as a hint about the\nEnd-User's current or past authenticated session with the Client.",
"type": "object"
},
"login_hint": {
"description": "LoginHint hints about the login identifier the End-User might use to log in (if necessary).\nThis hint can be used by an RP if it first asks the End-User for their e-mail address (or other identifier)\nand then wants to pass that value as a hint to the discovered authorization service. This value MAY also be a\nphone number in the format specified for the phone_number Claim. The use of this parameter is optional.",
"type": "string"
},
"ui_locales": {
"description": "UILocales is the End-User'id preferred languages and scripts for the user interface, represented as a\nspace-separated list of BCP47 [RFC5646] language tag values, ordered by preference. For instance, the value\n\"fr-CA fr en\" represents a preference for French as spoken in Canada, then French (without a region designation),\nfollowed by English (without a region designation). An error SHOULD NOT result if some or all of the requested\nlocales are not supported by the OpenID Provider.",
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "Contains optional information about the OpenID Connect request.",
"type": "object"
},
"oAuth2ConsentSession": {
"description": "A completed OAuth 2.0 Consent Session.",
"properties": {
"consent_request": {
"$ref": "#/components/schemas/oAuth2ConsentRequest"
},
"context": {
"$ref": "#/components/schemas/JSONRawMessage"
},
"expires_at": {
"properties": {
"access_token": {
"format": "date-time",
"type": "string"
},
"authorize_code": {
"format": "date-time",
"type": "string"
},
"id_token": {
"format": "date-time",
"type": "string"
},
"par_context": {
"format": "date-time",
"type": "string"
},
"refresh_token": {
"format": "date-time",
"type": "string"
}
},
"type": "object"
},
"grant_access_token_audience": {
"$ref": "#/components/schemas/StringSliceJSONFormat"
},
"grant_scope": {
"$ref": "#/components/schemas/StringSliceJSONFormat"
},
"handled_at": {
"$ref": "#/components/schemas/nullTime"
},
"remember": {
"description": "Remember Consent\n\nRemember, if set to true, tells ORY Hydra to remember this consent authorization and reuse it if the same\nclient asks the same user for the same, or a subset of, scope.",
"type": "boolean"
},
"remember_for": {
"description": "Remember Consent For\n\nRememberFor sets how long the consent authorization should be remembered for in seconds. If set to `0`, the\nauthorization will be remembered indefinitely.",
"format": "int64",
"type": "integer"
},
"session": {
"$ref": "#/components/schemas/acceptOAuth2ConsentRequestSession"
}
},
"title": "OAuth 2.0 Consent Session",
"type": "object"
},
"oAuth2ConsentSessions": {
"description": "List of OAuth 2.0 Consent Sessions",
"items": {
"$ref": "#/components/schemas/oAuth2ConsentSession"
},
"type": "array"
},
"oAuth2LoginRequest": {
"properties": {
"challenge": {
"description": "ID is the identifier (\"login challenge\") of the login request. It is used to\nidentify the session.",
"type": "string"
},
"client": {
"$ref": "#/components/schemas/oAuth2Client"
},
"oidc_context": {
"$ref": "#/components/schemas/oAuth2ConsentRequestOpenIDConnectContext"
},
"request_url": {
"description": "RequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which\ninitiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but\nmight come in handy if you want to deal with additional request parameters.",
"type": "string"
},
"requested_access_token_audience": {