-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathopenapi-kratos.json
7272 lines (7272 loc) · 294 KB
/
openapi-kratos.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 typically 201."
},
"identitySchemas": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/identitySchemas"
}
}
},
"description": "List Identity JSON Schemas Response"
},
"listCourierMessages": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/message"
},
"type": "array"
}
}
},
"description": "Paginated Courier Message List Response"
},
"listIdentities": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/identity"
},
"type": "array"
}
}
},
"description": "Paginated Identity List Response"
},
"listIdentitySessions": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/session"
},
"type": "array"
}
}
},
"description": "List Identity Sessions Response"
},
"listMySessions": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/session"
},
"type": "array"
}
}
},
"description": "List My Session Response"
},
"listSessions": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/session"
},
"type": "array"
}
}
},
"description": "Session List Response\n\nThe response given when listing sessions in an administrative context."
}
},
"schemas": {
"DefaultError": {},
"Duration": {
"description": "A Duration represents the elapsed time between two instants\nas an int64 nanosecond count. The representation limits the\nlargest representable duration to approximately 290 years.",
"format": "int64",
"type": "integer"
},
"ID": {
"format": "int64",
"type": "integer"
},
"JSONRawMessage": {
"title": "JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.",
"type": "object"
},
"NullBool": {
"nullable": true,
"type": "boolean"
},
"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"
},
"OAuth2Client": {
"properties": {
"access_token_strategy": {
"description": "OAuth 2.0 Access Token Strategy AccessTokenStrategy is the strategy used to generate access tokens. Valid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.sh/docs/hydra/advanced#json-web-tokens Setting the stragegy here overrides the global setting in `strategies.access_token`.",
"type": "string"
},
"allowed_cors_origins": {
"items": {
"type": "string"
},
"type": "array"
},
"audience": {
"items": {
"type": "string"
},
"type": "array"
},
"authorization_code_grant_access_token_lifespan": {
"description": "Specify a time duration in milliseconds, seconds, minutes, hours.",
"type": "string"
},
"authorization_code_grant_id_token_lifespan": {
"description": "Specify a time duration in milliseconds, seconds, minutes, hours.",
"type": "string"
},
"authorization_code_grant_refresh_token_lifespan": {
"description": "Specify a time duration in milliseconds, seconds, minutes, hours.",
"type": "string"
},
"backchannel_logout_session_required": {
"description": "OpenID Connect Back-Channel Logout Session Required Boolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout Token to identify the RP session with the OP when the backchannel_logout_uri is used. If omitted, the default value is false.",
"type": "boolean"
},
"backchannel_logout_uri": {
"description": "OpenID Connect Back-Channel Logout URI RP 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": {
"description": "Specify a time duration in milliseconds, seconds, minutes, hours.",
"type": "string"
},
"client_id": {
"description": "OAuth 2.0 Client ID The ID is immutable. If no ID is provided, a UUID4 will be generated.",
"type": "string"
},
"client_name": {
"description": "OAuth 2.0 Client Name The human-readable name of the client to be presented to the end-user during authorization.",
"type": "string"
},
"client_secret": {
"description": "OAuth 2.0 Client Secret The secret will be included in the create request as cleartext, and then never 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 The field is currently not supported and its value is always 0.",
"format": "int64",
"type": "integer"
},
"client_uri": {
"description": "OAuth 2.0 Client URI ClientURI is a URL string of a web page providing information about the client. If present, the server SHOULD display this URL to the end-user in a clickable fashion.",
"type": "string"
},
"contacts": {
"items": {
"type": "string"
},
"type": "array"
},
"created_at": {
"description": "OAuth 2.0 Client Creation Date CreatedAt 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 Boolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be included to identify the RP session with the OP when the frontchannel_logout_uri is used. If omitted, the default value is false.",
"type": "boolean"
},
"frontchannel_logout_uri": {
"description": "OpenID Connect Front-Channel Logout URI RP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query parameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the request and to determine which of the potentially multiple sessions is to be logged out; if either is included, both MUST be.",
"type": "string"
},
"grant_types": {
"items": {
"type": "string"
},
"type": "array"
},
"implicit_grant_access_token_lifespan": {
"description": "Specify a time duration in milliseconds, seconds, minutes, hours.",
"type": "string"
},
"implicit_grant_id_token_lifespan": {
"description": "Specify a time duration in milliseconds, seconds, minutes, hours.",
"type": "string"
},
"jwks": {
"description": "OAuth 2.0 Client JSON Web Key Set Client's JSON Web Key Set [JWK] document, passed by value. The semantics of the jwks parameter are the same as the jwks_uri parameter, other than that the JWK Set is passed by value, rather than by reference. This parameter is intended only to be used by Clients that, for some reason, are unable to use the jwks_uri parameter, for instance, by native applications that might not have a location to host the contents of the JWK Set. If a Client can use jwks_uri, it MUST NOT use jwks. One significant downside of jwks is that it does not enable key rotation (which jwks_uri does, as described in Section 10 of OpenID Connect Core 1.0 [OpenID.Core]). The jwks_uri and jwks parameters MUST NOT be used together."
},
"jwks_uri": {
"description": "OAuth 2.0 Client JSON Web Key Set URL URL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains the signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the Client's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate.",
"type": "string"
},
"jwt_bearer_grant_access_token_lifespan": {
"description": "Specify a time duration in milliseconds, seconds, minutes, hours.",
"type": "string"
},
"logo_uri": {
"description": "OAuth 2.0 Client Logo URI A URL string referencing the client's logo.",
"type": "string"
},
"metadata": {},
"owner": {
"description": "OAuth 2.0 Client Owner Owner is a string identifying the owner of the OAuth 2.0 Client.",
"type": "string"
},
"policy_uri": {
"description": "OAuth 2.0 Client Policy URI PolicyURI is a URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data.",
"type": "string"
},
"post_logout_redirect_uris": {
"items": {
"type": "string"
},
"type": "array"
},
"redirect_uris": {
"items": {
"type": "string"
},
"type": "array"
},
"refresh_token_grant_access_token_lifespan": {
"description": "Specify a time duration in milliseconds, seconds, minutes, hours.",
"type": "string"
},
"refresh_token_grant_id_token_lifespan": {
"description": "Specify a time duration in milliseconds, seconds, minutes, hours.",
"type": "string"
},
"refresh_token_grant_refresh_token_lifespan": {
"description": "Specify a time duration in milliseconds, seconds, minutes, hours.",
"type": "string"
},
"registration_access_token": {
"description": "OpenID Connect Dynamic Client Registration Access Token RegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client using Dynamic Client Registration.",
"type": "string"
},
"registration_client_uri": {
"description": "OpenID Connect Dynamic Client Registration URL RegistrationClientURI 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 JWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects from this Client MUST be rejected, if not signed with this algorithm.",
"type": "string"
},
"request_uris": {
"items": {
"type": "string"
},
"type": "array"
},
"response_types": {
"items": {
"type": "string"
},
"type": "array"
},
"scope": {
"description": "OAuth 2.0 Client Scope Scope is a string containing a space-separated list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) that the client can use when requesting access tokens.",
"type": "string"
},
"sector_identifier_uri": {
"description": "OpenID Connect Sector Identifier URI URL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a file 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 be set from the admin API.",
"type": "boolean"
},
"skip_logout_consent": {
"description": "SkipLogoutConsent skips the logout consent screen for this client. This field can only be set from the admin API.",
"type": "boolean"
},
"subject_type": {
"description": "OpenID Connect Subject Type The `subject_types_supported` Discovery parameter contains a list of the supported subject_type values for this server. Valid types include `pairwise` and `public`.",
"type": "string"
},
"token_endpoint_auth_method": {
"description": "OAuth 2.0 Token Endpoint Authentication Method Requested Client Authentication method for the Token Endpoint. The options are: `client_secret_basic`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header. `client_secret_post`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body. `private_key_jwt`: Use JSON Web Tokens to authenticate the client. `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 Requested Client Authentication signing algorithm for the Token Endpoint.",
"type": "string"
},
"tos_uri": {
"description": "OAuth 2.0 Client Terms of Service URI A URL string pointing to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client.",
"type": "string"
},
"updated_at": {
"description": "OAuth 2.0 Client Last Update Date UpdatedAt returns the timestamp of the last update.",
"format": "date-time",
"type": "string"
},
"userinfo_signed_response_alg": {
"description": "OpenID Connect Request Userinfo Signed Response Algorithm JWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT [JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims as a UTF-8 encoded JSON object using the application/json content-type.",
"type": "string"
}
},
"title": "OAuth2Client OAuth 2.0 Clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities.",
"type": "object"
},
"OAuth2ConsentRequestOpenIDConnectContext": {
"description": "OAuth2ConsentRequestOpenIDConnectContext struct for OAuth2ConsentRequestOpenIDConnectContext",
"properties": {
"acr_values": {
"description": "ACRValues is the Authentication AuthorizationContext Class Reference requested in the OAuth 2.0 Authorization request. It is a parameter defined by OpenID Connect and expresses which level of authentication (e.g. 2FA) is required. OpenID Connect defines it as follows: > Requested Authentication AuthorizationContext Class Reference values. Space-separated string that specifies the acr values that the Authorization Server is being requested to use for processing this Authentication Request, with the values appearing in order of preference. The Authentication AuthorizationContext Class satisfied by the authentication performed is returned as the acr Claim Value, as specified in Section 2. The acr Claim is requested as a Voluntary 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. The defined values are: page: 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. popup: 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. touch: The Authorization Server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface. wap: The Authorization Server SHOULD display the authentication and consent UI consistent with a \\\"feature phone\\\" type display. The 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 End-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). This hint can be used by an RP if it first asks the End-User for their e-mail address (or other identifier) and then wants to pass that value as a hint to the discovered authorization service. This value MAY also be a phone 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 space-separated list of BCP47 [RFC5646] language tag values, ordered by preference. For instance, the value \\\"fr-CA fr en\\\" represents a preference for French as spoken in Canada, then French (without a region designation), followed by English (without a region designation). An error SHOULD NOT result if some or all of the requested locales are not supported by the OpenID Provider.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"OAuth2LoginChallengeParams": {
"type": "object"
},
"OAuth2LoginRequest": {
"description": "OAuth2LoginRequest struct for OAuth2LoginRequest",
"properties": {
"challenge": {
"description": "ID is the identifier (\\\"login challenge\\\") of the login request. It is used to identify 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 initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but might come in handy if you want to deal with additional request parameters.",
"type": "string"
},
"requested_access_token_audience": {
"items": {
"type": "string"
},
"type": "array"
},
"requested_scope": {
"items": {
"type": "string"
},
"type": "array"
},
"session_id": {
"description": "SessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag) this ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false) this will be a new random value. This value is used as the \\\"sid\\\" parameter in the ID Token and in OIDC Front-/Back- channel logout. It's value can generally be used to associate consecutive login requests by a certain user.",
"type": "string"
},
"skip": {
"description": "Skip, if true, implies that the client has requested the same scopes from the same user previously. If true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect URL. This feature allows you to update / set session information.",
"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 requested by the OAuth 2.0 client. If this value is set and `skip` is true, you MUST include this subject type when accepting the login request, or the request will fail.",
"type": "string"
}
},
"type": "object"
},
"RecoveryAddressType": {
"title": "RecoveryAddressType must not exceed 16 characters as that is the limitation in the SQL Schema.",
"type": "string"
},
"Time": {
"format": "date-time",
"type": "string"
},
"UUID": {
"format": "uuid4",
"type": "string"
},
"authenticatorAssuranceLevel": {
"description": "The authenticator assurance level can be one of \"aal1\", \"aal2\", or \"aal3\". A higher number means that it is harder\nfor an attacker to compromise the account.\n\nGenerally, \"aal1\" implies that one authentication factor was used while AAL2 implies that two factors (e.g.\npassword + TOTP) have been used.\n\nTo learn more about these levels please head over to: https://www.ory.sh/kratos/docs/concepts/credentials",
"enum": [
"aal0",
"aal1",
"aal2",
"aal3"
],
"title": "Authenticator Assurance Level (AAL)",
"type": "string"
},
"batchPatchIdentitiesResponse": {
"description": "Patch identities response",
"properties": {
"identities": {
"description": "The patch responses for the individual identities.",
"items": {
"$ref": "#/components/schemas/identityPatchResponse"
},
"type": "array"
}
},
"type": "object"
},
"consistencyRequestParameters": {
"description": "Control API consistency guarantees",
"properties": {
"consistency": {
"description": "Read Consistency Level (preview)\n\nThe read consistency level determines the consistency guarantee for reads:\n\nstrong (slow): The read is guaranteed to return the most recent data committed at the start of the read.\neventual (very fast): The result will return data that is about 4.8 seconds old.\n\nThe default consistency guarantee can be changed in the Ory Network Console or using the Ory CLI with\n`ory patch project --replace '/previews/default_read_consistency_level=\"strong\"'`.\n\nSetting the default consistency level to `eventual` may cause regressions in the future as we add consistency\ncontrols to more APIs. Currently, the following APIs will be affected by this setting:\n\n`GET /admin/identities`\n\nThis feature is in preview and only available in Ory Network.\n ConsistencyLevelUnset ConsistencyLevelUnset is the unset / default consistency level.\nstrong ConsistencyLevelStrong ConsistencyLevelStrong is the strong consistency level.\neventual ConsistencyLevelEventual ConsistencyLevelEventual is the eventual consistency level using follower read timestamps.",
"enum": [
"",
"strong",
"eventual"
],
"type": "string",
"x-go-enum-desc": " ConsistencyLevelUnset ConsistencyLevelUnset is the unset / default consistency level.\nstrong ConsistencyLevelStrong ConsistencyLevelStrong is the strong consistency level.\neventual ConsistencyLevelEventual ConsistencyLevelEventual is the eventual consistency level using follower read timestamps."
}
},
"type": "object"
},
"continueWith": {
"discriminator": {
"mapping": {
"set_ory_session_token": "#/components/schemas/continueWithSetOrySessionToken",
"show_recovery_ui": "#/components/schemas/continueWithRecoveryUi",
"show_settings_ui": "#/components/schemas/continueWithSettingsUi",
"show_verification_ui": "#/components/schemas/continueWithVerificationUi"
},
"propertyName": "action"
},
"oneOf": [
{
"$ref": "#/components/schemas/continueWithVerificationUi"
},
{
"$ref": "#/components/schemas/continueWithSetOrySessionToken"
},
{
"$ref": "#/components/schemas/continueWithSettingsUi"
},
{
"$ref": "#/components/schemas/continueWithRecoveryUi"
}
]
},
"continueWithRecoveryUi": {
"description": "Indicates, that the UI flow could be continued by showing a recovery ui",
"properties": {
"action": {
"description": "Action will always be `show_recovery_ui`\nshow_recovery_ui ContinueWithActionShowRecoveryUIString",
"enum": [
"show_recovery_ui"
],
"type": "string",
"x-go-enum-desc": "show_recovery_ui ContinueWithActionShowRecoveryUIString"
},
"flow": {
"$ref": "#/components/schemas/continueWithRecoveryUiFlow"
}
},
"required": [
"action",
"flow"
],
"type": "object"
},
"continueWithRecoveryUiFlow": {
"properties": {
"id": {
"description": "The ID of the recovery flow",
"format": "uuid",
"type": "string"
},
"url": {
"description": "The URL of the recovery flow",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"continueWithSetOrySessionToken": {
"description": "Indicates that a session was issued, and the application should use this token for authenticated requests",
"properties": {
"action": {
"description": "Action will always be `set_ory_session_token`\nset_ory_session_token ContinueWithActionSetOrySessionTokenString",
"enum": [
"set_ory_session_token"
],
"type": "string",
"x-go-enum-desc": "set_ory_session_token ContinueWithActionSetOrySessionTokenString"
},
"ory_session_token": {
"description": "Token is the token of the session",
"type": "string"
}
},
"required": [
"action",
"ory_session_token"
],
"type": "object"
},
"continueWithSettingsUi": {
"description": "Indicates, that the UI flow could be continued by showing a settings ui",
"properties": {
"action": {
"description": "Action will always be `show_settings_ui`\nshow_settings_ui ContinueWithActionShowSettingsUIString",
"enum": [
"show_settings_ui"
],
"type": "string",
"x-go-enum-desc": "show_settings_ui ContinueWithActionShowSettingsUIString"
},
"flow": {
"$ref": "#/components/schemas/continueWithSettingsUiFlow"
}
},
"required": [
"action",
"flow"
],
"type": "object"
},
"continueWithSettingsUiFlow": {
"properties": {
"id": {
"description": "The ID of the settings flow",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"continueWithVerificationUi": {
"description": "Indicates, that the UI flow could be continued by showing a verification ui",
"properties": {
"action": {
"description": "Action will always be `show_verification_ui`\nshow_verification_ui ContinueWithActionShowVerificationUIString",
"enum": [
"show_verification_ui"
],
"type": "string",
"x-go-enum-desc": "show_verification_ui ContinueWithActionShowVerificationUIString"
},
"flow": {
"$ref": "#/components/schemas/continueWithVerificationUiFlow"
}
},
"required": [
"action",
"flow"
],
"type": "object"
},
"continueWithVerificationUiFlow": {
"properties": {
"id": {
"description": "The ID of the verification flow",
"format": "uuid",
"type": "string"
},
"url": {
"description": "The URL of the verification flow",
"type": "string"
},
"verifiable_address": {
"description": "The address that should be verified in this flow",
"type": "string"
}
},
"required": [
"id",
"verifiable_address"
],
"type": "object"
},
"courierMessageStatus": {
"description": "A Message's Status",
"enum": [
"queued",
"sent",
"processing",
"abandoned"
],
"type": "string"
},
"courierMessageType": {
"description": "It can either be `email` or `phone`",
"enum": [
"email",
"phone"
],
"title": "A Message's Type",
"type": "string"
},
"createIdentityBody": {
"description": "Create Identity Body",
"properties": {
"credentials": {
"$ref": "#/components/schemas/identityWithCredentials"
},
"metadata_admin": {
"description": "Store metadata about the user which is only accessible through admin APIs such as `GET /admin/identities/<id>`."
},
"metadata_public": {
"description": "Store metadata about the identity which the identity itself can see when calling for example the\nsession endpoint. Do not store sensitive information (e.g. credit score) about the identity in this field."
},
"recovery_addresses": {
"description": "RecoveryAddresses contains all the addresses that can be used to recover an identity.\n\nUse this structure to import recovery addresses for an identity. Please keep in mind\nthat the address needs to be represented in the Identity Schema or this field will be overwritten\non the next identity update.",
"items": {
"$ref": "#/components/schemas/recoveryIdentityAddress"
},
"type": "array"
},
"schema_id": {
"description": "SchemaID is the ID of the JSON Schema to be used for validating the identity's traits.",
"type": "string"
},
"state": {
"description": "State is the identity's state.\nactive StateActive\ninactive StateInactive",
"enum": [
"active",
"inactive"
],
"type": "string",
"x-go-enum-desc": "active StateActive\ninactive StateInactive"
},
"traits": {
"description": "Traits represent an identity's traits. The identity is able to create, modify, and delete traits\nin a self-service manner. The input will always be validated against the JSON Schema defined\nin `schema_url`.",
"type": "object"
},
"verifiable_addresses": {
"description": "VerifiableAddresses contains all the addresses that can be verified by the user.\n\nUse this structure to import verified addresses for an identity. Please keep in mind\nthat the address needs to be represented in the Identity Schema or this field will be overwritten\non the next identity update.",
"items": {
"$ref": "#/components/schemas/verifiableIdentityAddress"
},
"type": "array"
}
},
"required": [
"schema_id",
"traits"
],
"type": "object"
},
"createRecoveryCodeForIdentityBody": {
"description": "Create Recovery Code for Identity Request Body",
"properties": {
"expires_in": {
"description": "Code Expires In\n\nThe recovery code will expire after that amount of time has passed. Defaults to the configuration value of\n`selfservice.methods.code.config.lifespan`.",
"pattern": "^([0-9]+(ns|us|ms|s|m|h))*$",
"type": "string"
},
"identity_id": {
"description": "Identity to Recover\n\nThe identity's ID you wish to recover.",
"format": "uuid",
"type": "string"
}
},
"required": [
"identity_id"
],
"type": "object"
},
"createRecoveryLinkForIdentityBody": {
"description": "Create Recovery Link for Identity Request Body",
"properties": {
"expires_in": {
"description": "Link Expires In\n\nThe recovery link will expire after that amount of time has passed. Defaults to the configuration value of\n`selfservice.methods.code.config.lifespan`.",
"pattern": "^[0-9]+(ns|us|ms|s|m|h)$",
"type": "string"
},
"identity_id": {
"description": "Identity to Recover\n\nThe identity's ID you wish to recover.",
"format": "uuid",
"type": "string"
}
},
"required": [
"identity_id"
],
"type": "object"
},
"deleteMySessionsCount": {
"description": "Deleted Session Count",
"properties": {
"count": {
"description": "The number of sessions that were revoked.",
"format": "int64",
"type": "integer"
}
},
"type": "object"
},
"errorAuthenticatorAssuranceLevelNotSatisfied": {
"properties": {
"error": {
"$ref": "#/components/schemas/genericError"
},
"redirect_browser_to": {
"description": "Points to where to redirect the user to next.",
"type": "string"
}
},
"title": "Is returned when an active session was found but the requested AAL is not satisfied.",
"type": "object"
},
"errorBrowserLocationChangeRequired": {
"properties": {
"error": {
"$ref": "#/components/schemas/errorGeneric"
},
"redirect_browser_to": {
"description": "Points to where to redirect the user to next.",
"type": "string"
}
},
"title": "Is sent when a flow requires a browser to change its location.",
"type": "object"
},
"errorFlowReplaced": {
"description": "Is sent when a flow is replaced by a different flow of the same class",
"properties": {
"error": {
"$ref": "#/components/schemas/genericError"
},
"use_flow_id": {
"description": "The flow ID that should be used for the new flow as it contains the correct messages.",
"format": "uuid",
"type": "string"
}
},
"type": "object"
},
"errorGeneric": {
"description": "The standard Ory JSON API error format.",
"properties": {
"error": {
"$ref": "#/components/schemas/genericError"
}
},
"required": [
"error"
],
"title": "JSON API Error Response",
"type": "object"
},
"flowError": {
"properties": {
"created_at": {
"description": "CreatedAt is a helper struct field for gobuffalo.pop.",
"format": "date-time",
"type": "string"
},
"error": {
"type": "object"
},
"id": {
"description": "ID of the error container.",
"format": "uuid",
"type": "string"
},
"updated_at": {
"description": "UpdatedAt is a helper struct field for gobuffalo.pop.",
"format": "date-time",
"type": "string"
}
},
"required": [
"id"
],
"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": {
"additionalProperties": false,
"description": "Further error details",
"type": "object"
},
"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"
},
"identity": {
"description": "An [identity](https://www.ory.sh/docs/kratos/concepts/identity-user-model) represents a (human) user in Ory.",
"properties": {
"created_at": {
"description": "CreatedAt is a helper struct field for gobuffalo.pop.",
"format": "date-time",
"type": "string"
},
"credentials": {
"additionalProperties": {
"$ref": "#/components/schemas/identityCredentials"
},
"description": "Credentials represents all credentials that can be used for authenticating this identity.",
"type": "object"
},
"id": {
"description": "ID is the identity's unique identifier.\n\nThe Identity ID can not be changed and can not be chosen. This ensures future\ncompatibility and optimization for distributed stores such as CockroachDB.",
"format": "uuid",
"type": "string"
},
"metadata_admin": {
"$ref": "#/components/schemas/nullJsonRawMessage"
},
"metadata_public": {
"$ref": "#/components/schemas/nullJsonRawMessage"
},
"organization_id": {
"$ref": "#/components/schemas/NullUUID"
},
"recovery_addresses": {
"description": "RecoveryAddresses contains all the addresses that can be used to recover an identity.",
"items": {
"$ref": "#/components/schemas/recoveryIdentityAddress"
},
"type": "array",
"x-omitempty": true
},
"schema_id": {
"description": "SchemaID is the ID of the JSON Schema to be used for validating the identity's traits.",
"type": "string"
},
"schema_url": {
"description": "SchemaURL is the URL of the endpoint where the identity's traits schema can be fetched from.\n\nformat: url",
"type": "string"
},
"state": {
"description": "State is the identity's state.\n\nThis value has currently no effect.\nactive StateActive\ninactive StateInactive",
"enum": [
"active",
"inactive"
],
"type": "string",
"x-go-enum-desc": "active StateActive\ninactive StateInactive"
},
"state_changed_at": {
"$ref": "#/components/schemas/nullTime"
},
"traits": {
"$ref": "#/components/schemas/identityTraits"
},
"updated_at": {
"description": "UpdatedAt is a helper struct field for gobuffalo.pop.",
"format": "date-time",
"type": "string"
},
"verifiable_addresses": {
"description": "VerifiableAddresses contains all the addresses that can be verified by the user.",
"items": {
"$ref": "#/components/schemas/verifiableIdentityAddress"
},
"type": "array",
"x-omitempty": true
}
},
"required": [
"id",
"schema_id",
"schema_url",
"traits"
],
"title": "Identity represents an Ory Kratos identity",
"type": "object"
},
"identityCredentials": {
"description": "Credentials represents a specific credential type",
"properties": {
"config": {
"$ref": "#/components/schemas/JSONRawMessage"
},
"created_at": {
"description": "CreatedAt is a helper struct field for gobuffalo.pop.",
"format": "date-time",
"type": "string"
},
"identifiers": {
"description": "Identifiers represents a list of unique identifiers this credential type matches.",
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"description": "Type discriminates between different types of credentials.\npassword CredentialsTypePassword\noidc CredentialsTypeOIDC\ntotp CredentialsTypeTOTP\nlookup_secret CredentialsTypeLookup\nwebauthn CredentialsTypeWebAuthn\ncode CredentialsTypeCodeAuth\nlink_recovery CredentialsTypeRecoveryLink CredentialsTypeRecoveryLink is a special credential type linked to the link strategy (recovery flow). It is not used within the credentials object itself.\ncode_recovery CredentialsTypeRecoveryCode",
"enum": [
"password",
"oidc",
"totp",
"lookup_secret",