ory-kratos-client 0.1.1.alpha1 → 0.5.0.alpha1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (156) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/README.md +86 -48
  4. data/docs/AdminApi.md +290 -85
  5. data/docs/CommonApi.md +111 -16
  6. data/docs/CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.md +19 -0
  7. data/docs/CompleteSelfServiceLoginFlowWithPasswordMethod.md +21 -0
  8. data/docs/CompleteSelfServiceRecoveryFlowWithLinkMethod.md +19 -0
  9. data/docs/CompleteSelfServiceSettingsFlowWithPasswordMethod.md +19 -0
  10. data/docs/CompleteSelfServiceVerificationFlowWithLinkMethod.md +19 -0
  11. data/docs/CreateIdentity.md +19 -0
  12. data/docs/CreateRecoveryLink.md +19 -0
  13. data/docs/ErrorContainer.md +2 -2
  14. data/docs/Form.md +3 -3
  15. data/docs/FormField.md +8 -8
  16. data/docs/GenericErrorPayload.md +1 -1
  17. data/docs/Identity.md +9 -7
  18. data/docs/LoginFlow.md +33 -0
  19. data/docs/LoginFlowMethod.md +19 -0
  20. data/docs/LoginFlowMethodConfig.md +25 -0
  21. data/docs/LoginRequest.md +4 -0
  22. data/docs/LoginRequestMethodConfig.md +3 -3
  23. data/docs/LoginViaApiResponse.md +19 -0
  24. data/docs/Message.md +23 -0
  25. data/docs/ProviderCredentialsConfig.md +19 -0
  26. data/docs/PublicApi.md +806 -141
  27. data/docs/RecoveryAddress.md +21 -0
  28. data/docs/RecoveryFlow.md +33 -0
  29. data/docs/RecoveryFlowMethod.md +19 -0
  30. data/docs/RecoveryFlowMethodConfig.md +23 -0
  31. data/docs/RecoveryLink.md +19 -0
  32. data/docs/RecoveryRequest.md +31 -0
  33. data/docs/RecoveryRequestMethod.md +19 -0
  34. data/docs/RegistrationFlow.md +31 -0
  35. data/docs/RegistrationFlowMethod.md +19 -0
  36. data/docs/RegistrationFlowMethodConfig.md +25 -0
  37. data/docs/RegistrationRequest.md +3 -1
  38. data/docs/RegistrationRequestMethodConfig.md +3 -3
  39. data/docs/RegistrationViaApiResponse.md +21 -0
  40. data/docs/RequestMethodConfig.md +23 -0
  41. data/docs/RevokeSession.md +17 -0
  42. data/docs/Session.md +6 -4
  43. data/docs/SettingsFlow.md +35 -0
  44. data/docs/SettingsFlowMethod.md +19 -0
  45. data/docs/SettingsFlowMethodConfig.md +23 -0
  46. data/docs/SettingsRequest.md +33 -0
  47. data/docs/SettingsRequestMethod.md +19 -0
  48. data/docs/SettingsViaApiResponse.md +19 -0
  49. data/docs/UpdateIdentity.md +19 -0
  50. data/docs/VerifiableAddress.md +4 -4
  51. data/docs/VerificationFlow.md +33 -0
  52. data/docs/VerificationFlowMethod.md +19 -0
  53. data/docs/VerificationFlowMethodConfig.md +23 -0
  54. data/docs/VerificationRequest.md +3 -1
  55. data/lib/ory-kratos-client.rb +31 -14
  56. data/lib/ory-kratos-client/api/admin_api.rb +379 -128
  57. data/lib/ory-kratos-client/api/common_api.rb +150 -27
  58. data/lib/ory-kratos-client/api/health_api.rb +2 -2
  59. data/lib/ory-kratos-client/api/public_api.rb +1000 -234
  60. data/lib/ory-kratos-client/api/version_api.rb +2 -2
  61. data/lib/ory-kratos-client/api_client.rb +10 -7
  62. data/lib/ory-kratos-client/api_error.rb +2 -2
  63. data/lib/ory-kratos-client/configuration.rb +9 -2
  64. data/lib/ory-kratos-client/models/complete_self_service_browser_settings_strategy_profile_flow_payload.rb +222 -0
  65. data/lib/ory-kratos-client/models/complete_self_service_login_flow_with_password_method.rb +227 -0
  66. data/lib/ory-kratos-client/models/complete_self_service_recovery_flow_with_link_method.rb +217 -0
  67. data/lib/ory-kratos-client/models/complete_self_service_settings_flow_with_password_method.rb +222 -0
  68. data/lib/ory-kratos-client/models/complete_self_service_verification_flow_with_link_method.rb +217 -0
  69. data/lib/ory-kratos-client/models/create_identity.rb +227 -0
  70. data/lib/ory-kratos-client/models/create_recovery_link.rb +238 -0
  71. data/lib/ory-kratos-client/models/error_container.rb +13 -2
  72. data/lib/ory-kratos-client/models/form.rb +15 -16
  73. data/lib/ory-kratos-client/models/form_field.rb +16 -22
  74. data/lib/ory-kratos-client/models/generic_error.rb +2 -2
  75. data/lib/ory-kratos-client/models/generic_error_payload.rb +4 -7
  76. data/lib/ory-kratos-client/models/health_not_ready_status.rb +2 -2
  77. data/lib/ory-kratos-client/models/health_status.rb +2 -2
  78. data/lib/ory-kratos-client/models/identity.rb +53 -35
  79. data/lib/ory-kratos-client/models/login_flow.rb +315 -0
  80. data/lib/ory-kratos-client/models/login_flow_method.rb +226 -0
  81. data/lib/ory-kratos-client/models/login_flow_method_config.rb +267 -0
  82. data/lib/ory-kratos-client/models/login_request.rb +24 -3
  83. data/lib/ory-kratos-client/models/login_request_method.rb +2 -2
  84. data/lib/ory-kratos-client/models/login_request_method_config.rb +15 -16
  85. data/lib/ory-kratos-client/models/login_via_api_response.rb +227 -0
  86. data/lib/ory-kratos-client/models/message.rb +234 -0
  87. data/lib/ory-kratos-client/models/provider_credentials_config.rb +215 -0
  88. data/lib/ory-kratos-client/models/recovery_address.rb +239 -0
  89. data/lib/ory-kratos-client/models/recovery_flow.rb +319 -0
  90. data/lib/ory-kratos-client/models/recovery_flow_method.rb +226 -0
  91. data/lib/ory-kratos-client/models/recovery_flow_method_config.rb +255 -0
  92. data/lib/ory-kratos-client/models/recovery_link.rb +222 -0
  93. data/lib/ory-kratos-client/models/recovery_request.rb +309 -0
  94. data/lib/ory-kratos-client/models/recovery_request_method.rb +216 -0
  95. data/lib/ory-kratos-client/models/registration_flow.rb +304 -0
  96. data/lib/ory-kratos-client/models/registration_flow_method.rb +226 -0
  97. data/lib/ory-kratos-client/models/registration_flow_method_config.rb +267 -0
  98. data/lib/ory-kratos-client/models/registration_request.rb +14 -8
  99. data/lib/ory-kratos-client/models/registration_request_method.rb +2 -2
  100. data/lib/ory-kratos-client/models/registration_request_method_config.rb +15 -16
  101. data/lib/ory-kratos-client/models/registration_via_api_response.rb +236 -0
  102. data/lib/ory-kratos-client/models/request_method_config.rb +255 -0
  103. data/lib/ory-kratos-client/models/revoke_session.rb +212 -0
  104. data/lib/ory-kratos-client/models/session.rb +29 -20
  105. data/lib/ory-kratos-client/models/settings_flow.rb +333 -0
  106. data/lib/ory-kratos-client/models/settings_flow_method.rb +226 -0
  107. data/lib/ory-kratos-client/models/settings_flow_method_config.rb +255 -0
  108. data/lib/ory-kratos-client/models/settings_request.rb +323 -0
  109. data/lib/ory-kratos-client/models/settings_request_method.rb +216 -0
  110. data/lib/ory-kratos-client/models/settings_via_api_response.rb +226 -0
  111. data/lib/ory-kratos-client/models/update_identity.rb +222 -0
  112. data/lib/ory-kratos-client/models/verifiable_address.rb +17 -22
  113. data/lib/ory-kratos-client/models/verification_flow.rb +299 -0
  114. data/lib/ory-kratos-client/models/verification_flow_method.rb +226 -0
  115. data/lib/ory-kratos-client/models/verification_flow_method_config.rb +255 -0
  116. data/lib/ory-kratos-client/models/verification_request.rb +15 -4
  117. data/lib/ory-kratos-client/models/version.rb +2 -2
  118. data/lib/ory-kratos-client/version.rb +3 -3
  119. data/ory-kratos-client.gemspec +2 -2
  120. data/spec/models/complete_self_service_browser_settings_strategy_profile_flow_payload_spec.rb +47 -0
  121. data/spec/models/complete_self_service_login_flow_with_password_method_spec.rb +53 -0
  122. data/spec/models/complete_self_service_recovery_flow_with_link_method_spec.rb +47 -0
  123. data/spec/models/complete_self_service_settings_flow_with_password_method_spec.rb +47 -0
  124. data/spec/models/complete_self_service_verification_flow_with_link_method_spec.rb +47 -0
  125. data/spec/models/create_identity_spec.rb +47 -0
  126. data/spec/models/create_recovery_link_spec.rb +47 -0
  127. data/spec/models/login_flow_method_config_spec.rb +65 -0
  128. data/spec/models/login_flow_method_spec.rb +47 -0
  129. data/spec/models/login_flow_spec.rb +89 -0
  130. data/spec/models/login_via_api_response_spec.rb +47 -0
  131. data/spec/models/message_spec.rb +59 -0
  132. data/spec/models/provider_credentials_config_spec.rb +47 -0
  133. data/spec/models/recovery_address_spec.rb +53 -0
  134. data/spec/models/recovery_flow_method_config_spec.rb +59 -0
  135. data/spec/models/recovery_flow_method_spec.rb +47 -0
  136. data/spec/models/recovery_flow_spec.rb +89 -0
  137. data/spec/models/recovery_link_spec.rb +47 -0
  138. data/spec/models/recovery_request_method_spec.rb +47 -0
  139. data/spec/models/recovery_request_spec.rb +83 -0
  140. data/spec/models/registration_flow_method_config_spec.rb +65 -0
  141. data/spec/models/registration_flow_method_spec.rb +47 -0
  142. data/spec/models/registration_flow_spec.rb +83 -0
  143. data/spec/models/registration_via_api_response_spec.rb +53 -0
  144. data/spec/models/request_method_config_spec.rb +59 -0
  145. data/spec/models/revoke_session_spec.rb +41 -0
  146. data/spec/models/settings_flow_method_config_spec.rb +59 -0
  147. data/spec/models/settings_flow_method_spec.rb +47 -0
  148. data/spec/models/settings_flow_spec.rb +95 -0
  149. data/spec/models/settings_request_method_spec.rb +47 -0
  150. data/spec/models/settings_request_spec.rb +83 -0
  151. data/spec/models/settings_via_api_response_spec.rb +47 -0
  152. data/spec/models/update_identity_spec.rb +47 -0
  153. data/spec/models/verification_flow_method_config_spec.rb +59 -0
  154. data/spec/models/verification_flow_method_spec.rb +47 -0
  155. data/spec/models/verification_flow_spec.rb +89 -0
  156. metadata +161 -17
@@ -3,10 +3,10 @@
3
3
 
4
4
  #Welcome to the ORY Kratos HTTP API documentation!
5
5
 
6
- The version of the OpenAPI document: latest
6
+ The version of the OpenAPI document: v0.4.6-alpha.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.3
9
+ OpenAPI Generator version: 4.3.1
10
10
 
11
11
  =end
12
12
 
@@ -19,8 +19,68 @@ module OryHydraClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+ # Get a traits schema definition
23
+ # @param id [String] ID must be set to the ID of schema you want to get
24
+ # @param [Hash] opts the optional parameters
25
+ # @return [Object]
26
+ def get_schema(id, opts = {})
27
+ data, _status_code, _headers = get_schema_with_http_info(id, opts)
28
+ data
29
+ end
30
+
31
+ # Get a traits schema definition
32
+ # @param id [String] ID must be set to the ID of schema you want to get
33
+ # @param [Hash] opts the optional parameters
34
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
35
+ def get_schema_with_http_info(id, opts = {})
36
+ if @api_client.config.debugging
37
+ @api_client.config.logger.debug 'Calling API: CommonApi.get_schema ...'
38
+ end
39
+ # verify the required parameter 'id' is set
40
+ if @api_client.config.client_side_validation && id.nil?
41
+ fail ArgumentError, "Missing the required parameter 'id' when calling CommonApi.get_schema"
42
+ end
43
+ # resource path
44
+ local_var_path = '/schemas/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
45
+
46
+ # query parameters
47
+ query_params = opts[:query_params] || {}
48
+
49
+ # header parameters
50
+ header_params = opts[:header_params] || {}
51
+ # HTTP header 'Accept' (if needed)
52
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
53
+
54
+ # form parameters
55
+ form_params = opts[:form_params] || {}
56
+
57
+ # http body (model)
58
+ post_body = opts[:body]
59
+
60
+ # return_type
61
+ return_type = opts[:return_type] || 'Object'
62
+
63
+ # auth_names
64
+ auth_names = opts[:auth_names] || []
65
+
66
+ new_options = opts.merge(
67
+ :header_params => header_params,
68
+ :query_params => query_params,
69
+ :form_params => form_params,
70
+ :body => post_body,
71
+ :auth_names => auth_names,
72
+ :return_type => return_type
73
+ )
74
+
75
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
76
+ if @api_client.config.debugging
77
+ @api_client.config.logger.debug "API called: CommonApi#get_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
78
+ end
79
+ return data, status_code, headers
80
+ end
81
+
22
82
  # Get the request context of browser-based login user flows
23
- # This endpoint returns a login request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
83
+ # This endpoint returns a login request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
24
84
  # @param request [String] Request is the Login Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/login?request&#x3D;abcde&#x60;).
25
85
  # @param [Hash] opts the optional parameters
26
86
  # @return [LoginRequest]
@@ -30,7 +90,7 @@ module OryHydraClient
30
90
  end
31
91
 
32
92
  # Get the request context of browser-based login user flows
33
- # This endpoint returns a login request&#39;s context with, for example, error details and other information. When accessing this endpoint through ORY Kratos&#39; Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
93
+ # This endpoint returns a login request&#39;s context with, for example, error details and other information. When accessing this endpoint through ORY Kratos&#39; Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
34
94
  # @param request [String] Request is the Login Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/login?request&#x3D;abcde&#x60;).
35
95
  # @param [Hash] opts the optional parameters
36
96
  # @return [Array<(LoginRequest, Integer, Hash)>] LoginRequest data, response status code and response headers
@@ -82,31 +142,31 @@ module OryHydraClient
82
142
  return data, status_code, headers
83
143
  end
84
144
 
85
- # Get the request context of browser-based profile management flows
86
- # When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos Profile Management Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-profile-management).
87
- # @param request [String] Request is the Login Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/login?request&#x3D;abcde&#x60;).
145
+ # Get the request context of browser-based recovery flows
146
+ # When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos Account Recovery Documentation](../self-service/flows/password-reset-account-recovery).
147
+ # @param request [String] Request is the Login Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/recover?request&#x3D;abcde&#x60;).
88
148
  # @param [Hash] opts the optional parameters
89
- # @return [ProfileManagementRequest]
90
- def get_self_service_browser_profile_management_request(request, opts = {})
91
- data, _status_code, _headers = get_self_service_browser_profile_management_request_with_http_info(request, opts)
149
+ # @return [RecoveryRequest]
150
+ def get_self_service_browser_recovery_request(request, opts = {})
151
+ data, _status_code, _headers = get_self_service_browser_recovery_request_with_http_info(request, opts)
92
152
  data
93
153
  end
94
154
 
95
- # Get the request context of browser-based profile management flows
96
- # When accessing this endpoint through ORY Kratos&#39; Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos Profile Management Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-profile-management).
97
- # @param request [String] Request is the Login Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/login?request&#x3D;abcde&#x60;).
155
+ # Get the request context of browser-based recovery flows
156
+ # When accessing this endpoint through ORY Kratos&#39; Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos Account Recovery Documentation](../self-service/flows/password-reset-account-recovery).
157
+ # @param request [String] Request is the Login Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/recover?request&#x3D;abcde&#x60;).
98
158
  # @param [Hash] opts the optional parameters
99
- # @return [Array<(ProfileManagementRequest, Integer, Hash)>] ProfileManagementRequest data, response status code and response headers
100
- def get_self_service_browser_profile_management_request_with_http_info(request, opts = {})
159
+ # @return [Array<(RecoveryRequest, Integer, Hash)>] RecoveryRequest data, response status code and response headers
160
+ def get_self_service_browser_recovery_request_with_http_info(request, opts = {})
101
161
  if @api_client.config.debugging
102
- @api_client.config.logger.debug 'Calling API: CommonApi.get_self_service_browser_profile_management_request ...'
162
+ @api_client.config.logger.debug 'Calling API: CommonApi.get_self_service_browser_recovery_request ...'
103
163
  end
104
164
  # verify the required parameter 'request' is set
105
165
  if @api_client.config.client_side_validation && request.nil?
106
- fail ArgumentError, "Missing the required parameter 'request' when calling CommonApi.get_self_service_browser_profile_management_request"
166
+ fail ArgumentError, "Missing the required parameter 'request' when calling CommonApi.get_self_service_browser_recovery_request"
107
167
  end
108
168
  # resource path
109
- local_var_path = '/self-service/browser/flows/requests/profile'
169
+ local_var_path = '/self-service/browser/flows/requests/recovery'
110
170
 
111
171
  # query parameters
112
172
  query_params = opts[:query_params] || {}
@@ -124,7 +184,7 @@ module OryHydraClient
124
184
  post_body = opts[:body]
125
185
 
126
186
  # return_type
127
- return_type = opts[:return_type] || 'ProfileManagementRequest'
187
+ return_type = opts[:return_type] || 'RecoveryRequest'
128
188
 
129
189
  # auth_names
130
190
  auth_names = opts[:auth_names] || []
@@ -140,13 +200,13 @@ module OryHydraClient
140
200
 
141
201
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
142
202
  if @api_client.config.debugging
143
- @api_client.config.logger.debug "API called: CommonApi#get_self_service_browser_profile_management_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
203
+ @api_client.config.logger.debug "API called: CommonApi#get_self_service_browser_recovery_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
144
204
  end
145
205
  return data, status_code, headers
146
206
  end
147
207
 
148
208
  # Get the request context of browser-based registration user flows
149
- # This endpoint returns a registration request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
209
+ # This endpoint returns a registration request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
150
210
  # @param request [String] Request is the Registration Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/registration?request&#x3D;abcde&#x60;).
151
211
  # @param [Hash] opts the optional parameters
152
212
  # @return [RegistrationRequest]
@@ -156,7 +216,7 @@ module OryHydraClient
156
216
  end
157
217
 
158
218
  # Get the request context of browser-based registration user flows
159
- # This endpoint returns a registration request&#39;s context with, for example, error details and other information. When accessing this endpoint through ORY Kratos&#39; Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
219
+ # This endpoint returns a registration request&#39;s context with, for example, error details and other information. When accessing this endpoint through ORY Kratos&#39; Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
160
220
  # @param request [String] Request is the Registration Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/registration?request&#x3D;abcde&#x60;).
161
221
  # @param [Hash] opts the optional parameters
162
222
  # @return [Array<(RegistrationRequest, Integer, Hash)>] RegistrationRequest data, response status code and response headers
@@ -208,10 +268,73 @@ module OryHydraClient
208
268
  return data, status_code, headers
209
269
  end
210
270
 
271
+ # Get the request context of browser-based settings flows
272
+ # When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
273
+ # @param request [String] Request is the Login Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/settingss?request&#x3D;abcde&#x60;).
274
+ # @param [Hash] opts the optional parameters
275
+ # @return [SettingsRequest]
276
+ def get_self_service_browser_settings_request(request, opts = {})
277
+ data, _status_code, _headers = get_self_service_browser_settings_request_with_http_info(request, opts)
278
+ data
279
+ end
280
+
281
+ # Get the request context of browser-based settings flows
282
+ # When accessing this endpoint through ORY Kratos&#39; Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
283
+ # @param request [String] Request is the Login Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/settingss?request&#x3D;abcde&#x60;).
284
+ # @param [Hash] opts the optional parameters
285
+ # @return [Array<(SettingsRequest, Integer, Hash)>] SettingsRequest data, response status code and response headers
286
+ def get_self_service_browser_settings_request_with_http_info(request, opts = {})
287
+ if @api_client.config.debugging
288
+ @api_client.config.logger.debug 'Calling API: CommonApi.get_self_service_browser_settings_request ...'
289
+ end
290
+ # verify the required parameter 'request' is set
291
+ if @api_client.config.client_side_validation && request.nil?
292
+ fail ArgumentError, "Missing the required parameter 'request' when calling CommonApi.get_self_service_browser_settings_request"
293
+ end
294
+ # resource path
295
+ local_var_path = '/self-service/browser/flows/requests/settings'
296
+
297
+ # query parameters
298
+ query_params = opts[:query_params] || {}
299
+ query_params[:'request'] = request
300
+
301
+ # header parameters
302
+ header_params = opts[:header_params] || {}
303
+ # HTTP header 'Accept' (if needed)
304
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
305
+
306
+ # form parameters
307
+ form_params = opts[:form_params] || {}
308
+
309
+ # http body (model)
310
+ post_body = opts[:body]
311
+
312
+ # return_type
313
+ return_type = opts[:return_type] || 'SettingsRequest'
314
+
315
+ # auth_names
316
+ auth_names = opts[:auth_names] || []
317
+
318
+ new_options = opts.merge(
319
+ :header_params => header_params,
320
+ :query_params => query_params,
321
+ :form_params => form_params,
322
+ :body => post_body,
323
+ :auth_names => auth_names,
324
+ :return_type => return_type
325
+ )
326
+
327
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
328
+ if @api_client.config.debugging
329
+ @api_client.config.logger.debug "API called: CommonApi#get_self_service_browser_settings_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
330
+ end
331
+ return data, status_code, headers
332
+ end
333
+
211
334
  # Get user-facing self-service errors
212
- # This endpoint returns the error associated with a user-facing self service errors. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
335
+ # This endpoint returns the error associated with a user-facing self service errors. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes. More information can be found at [ORY Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
213
336
  # @param [Hash] opts the optional parameters
214
- # @option opts [String] :id
337
+ # @option opts [String] :error
215
338
  # @return [ErrorContainer]
216
339
  def get_self_service_error(opts = {})
217
340
  data, _status_code, _headers = get_self_service_error_with_http_info(opts)
@@ -219,9 +342,9 @@ module OryHydraClient
219
342
  end
220
343
 
221
344
  # Get user-facing self-service errors
222
- # This endpoint returns the error associated with a user-facing self service errors. When accessing this endpoint through ORY Kratos&#39; Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
345
+ # This endpoint returns the error associated with a user-facing self service errors. When accessing this endpoint through ORY Kratos&#39; Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes. More information can be found at [ORY Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
223
346
  # @param [Hash] opts the optional parameters
224
- # @option opts [String] :id
347
+ # @option opts [String] :error
225
348
  # @return [Array<(ErrorContainer, Integer, Hash)>] ErrorContainer data, response status code and response headers
226
349
  def get_self_service_error_with_http_info(opts = {})
227
350
  if @api_client.config.debugging
@@ -232,7 +355,7 @@ module OryHydraClient
232
355
 
233
356
  # query parameters
234
357
  query_params = opts[:query_params] || {}
235
- query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
358
+ query_params[:'error'] = opts[:'error'] if !opts[:'error'].nil?
236
359
 
237
360
  # header parameters
238
361
  header_params = opts[:header_params] || {}
@@ -3,10 +3,10 @@
3
3
 
4
4
  #Welcome to the ORY Kratos HTTP API documentation!
5
5
 
6
- The version of the OpenAPI document: latest
6
+ The version of the OpenAPI document: v0.5.0-alpha.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.3
9
+ OpenAPI Generator version: 4.3.1
10
10
 
11
11
  =end
12
12
 
@@ -3,10 +3,10 @@
3
3
 
4
4
  #Welcome to the ORY Kratos HTTP API documentation!
5
5
 
6
- The version of the OpenAPI document: latest
6
+ The version of the OpenAPI document: v0.5.0-alpha.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 4.2.3
9
+ OpenAPI Generator version: 4.3.1
10
10
 
11
11
  =end
12
12
 
@@ -19,57 +19,616 @@ module OryHydraClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
- # Complete the browser-based profile management flows
23
- # This endpoint completes a browser-based profile management flow. This is usually achieved by POSTing data to this endpoint. If the provided profile data is valid against the Identity's Traits JSON Schema, the data will be updated and the browser redirected to `url.profile_ui` for further steps. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos Profile Management Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-profile-management).
24
- # @param request [String] Request is the request ID.
25
- # @param body [CompleteSelfServiceBrowserProfileManagementFlowPayload]
22
+ # Complete the Browser-Based Settings Flow for the OpenID Connect Strategy
23
+ # This endpoint completes a browser-based settings flow. This is usually achieved by POSTing data to this endpoint. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
26
24
  # @param [Hash] opts the optional parameters
27
25
  # @return [nil]
28
- def complete_self_service_browser_profile_management_flow(request, body, opts = {})
29
- complete_self_service_browser_profile_management_flow_with_http_info(request, body, opts)
26
+ def complete_self_service_browser_settings_oidc_settings_flow(opts = {})
27
+ complete_self_service_browser_settings_oidc_settings_flow_with_http_info(opts)
30
28
  nil
31
29
  end
32
30
 
33
- # Complete the browser-based profile management flows
34
- # This endpoint completes a browser-based profile management flow. This is usually achieved by POSTing data to this endpoint. If the provided profile data is valid against the Identity&#39;s Traits JSON Schema, the data will be updated and the browser redirected to &#x60;url.profile_ui&#x60; for further steps. &gt; This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos Profile Management Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-profile-management).
35
- # @param request [String] Request is the request ID.
36
- # @param body [CompleteSelfServiceBrowserProfileManagementFlowPayload]
31
+ # Complete the Browser-Based Settings Flow for the OpenID Connect Strategy
32
+ # This endpoint completes a browser-based settings flow. This is usually achieved by POSTing data to this endpoint. &gt; This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
37
33
  # @param [Hash] opts the optional parameters
38
34
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
39
- def complete_self_service_browser_profile_management_flow_with_http_info(request, body, opts = {})
35
+ def complete_self_service_browser_settings_oidc_settings_flow_with_http_info(opts = {})
40
36
  if @api_client.config.debugging
41
- @api_client.config.logger.debug 'Calling API: PublicApi.complete_self_service_browser_profile_management_flow ...'
37
+ @api_client.config.logger.debug 'Calling API: PublicApi.complete_self_service_browser_settings_oidc_settings_flow ...'
42
38
  end
43
- # verify the required parameter 'request' is set
44
- if @api_client.config.client_side_validation && request.nil?
45
- fail ArgumentError, "Missing the required parameter 'request' when calling PublicApi.complete_self_service_browser_profile_management_flow"
39
+ # resource path
40
+ local_var_path = '/self-service/browser/flows/registration/strategies/oidc/settings/connections'
41
+
42
+ # query parameters
43
+ query_params = opts[:query_params] || {}
44
+
45
+ # header parameters
46
+ header_params = opts[:header_params] || {}
47
+ # HTTP header 'Accept' (if needed)
48
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
49
+
50
+ # form parameters
51
+ form_params = opts[:form_params] || {}
52
+
53
+ # http body (model)
54
+ post_body = opts[:body]
55
+
56
+ # return_type
57
+ return_type = opts[:return_type]
58
+
59
+ # auth_names
60
+ auth_names = opts[:auth_names] || []
61
+
62
+ new_options = opts.merge(
63
+ :header_params => header_params,
64
+ :query_params => query_params,
65
+ :form_params => form_params,
66
+ :body => post_body,
67
+ :auth_names => auth_names,
68
+ :return_type => return_type
69
+ )
70
+
71
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
72
+ if @api_client.config.debugging
73
+ @api_client.config.logger.debug "API called: PublicApi#complete_self_service_browser_settings_oidc_settings_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
74
+ end
75
+ return data, status_code, headers
76
+ end
77
+
78
+ # Complete Login Flow with Username/Email Password Method
79
+ # Use this endpoint to complete a login flow by sending an identity's identifier and password. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and responds with HTTP 200 and a application/json body with the session token on success; HTTP 302 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. Browser flows expect `application/x-www-form-urlencoded` to be sent in the body and responds with a HTTP 302 redirect to the post/after login URL or the `return_to` value if it was set and if the login succeeded; a HTTP 302 redirect to the login UI URL with the flow ID containing the validation errors otherwise. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
80
+ # @param flow [String] The Flow ID
81
+ # @param [Hash] opts the optional parameters
82
+ # @option opts [CompleteSelfServiceLoginFlowWithPasswordMethod] :body
83
+ # @return [LoginViaApiResponse]
84
+ def complete_self_service_login_flow_with_password_method(flow, opts = {})
85
+ data, _status_code, _headers = complete_self_service_login_flow_with_password_method_with_http_info(flow, opts)
86
+ data
87
+ end
88
+
89
+ # Complete Login Flow with Username/Email Password Method
90
+ # Use this endpoint to complete a login flow by sending an identity&#39;s identifier and password. This endpoint behaves differently for API and browser flows. API flows expect &#x60;application/json&#x60; to be sent in the body and responds with HTTP 200 and a application/json body with the session token on success; HTTP 302 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. Browser flows expect &#x60;application/x-www-form-urlencoded&#x60; to be sent in the body and responds with a HTTP 302 redirect to the post/after login URL or the &#x60;return_to&#x60; value if it was set and if the login succeeded; a HTTP 302 redirect to the login UI URL with the flow ID containing the validation errors otherwise. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
91
+ # @param flow [String] The Flow ID
92
+ # @param [Hash] opts the optional parameters
93
+ # @option opts [CompleteSelfServiceLoginFlowWithPasswordMethod] :body
94
+ # @return [Array<(LoginViaApiResponse, Integer, Hash)>] LoginViaApiResponse data, response status code and response headers
95
+ def complete_self_service_login_flow_with_password_method_with_http_info(flow, opts = {})
96
+ if @api_client.config.debugging
97
+ @api_client.config.logger.debug 'Calling API: PublicApi.complete_self_service_login_flow_with_password_method ...'
98
+ end
99
+ # verify the required parameter 'flow' is set
100
+ if @api_client.config.client_side_validation && flow.nil?
101
+ fail ArgumentError, "Missing the required parameter 'flow' when calling PublicApi.complete_self_service_login_flow_with_password_method"
102
+ end
103
+ # resource path
104
+ local_var_path = '/self-service/login/methods/password'
105
+
106
+ # query parameters
107
+ query_params = opts[:query_params] || {}
108
+ query_params[:'flow'] = flow
109
+
110
+ # header parameters
111
+ header_params = opts[:header_params] || {}
112
+ # HTTP header 'Accept' (if needed)
113
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
114
+ # HTTP header 'Content-Type'
115
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
116
+
117
+ # form parameters
118
+ form_params = opts[:form_params] || {}
119
+
120
+ # http body (model)
121
+ post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])
122
+
123
+ # return_type
124
+ return_type = opts[:return_type] || 'LoginViaApiResponse'
125
+
126
+ # auth_names
127
+ auth_names = opts[:auth_names] || []
128
+
129
+ new_options = opts.merge(
130
+ :header_params => header_params,
131
+ :query_params => query_params,
132
+ :form_params => form_params,
133
+ :body => post_body,
134
+ :auth_names => auth_names,
135
+ :return_type => return_type
136
+ )
137
+
138
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
139
+ if @api_client.config.debugging
140
+ @api_client.config.logger.debug "API called: PublicApi#complete_self_service_login_flow_with_password_method\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
141
+ end
142
+ return data, status_code, headers
143
+ end
144
+
145
+ # Complete Recovery Flow with Link Method
146
+ # Use this endpoint to complete a recovery flow using the link method. This endpoint behaves differently for API and browser flows and has several states: `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. For API clients it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid and a HTTP 302 Found redirect with a fresh recovery flow if the flow was otherwise invalid (e.g. expired). For Browser clients it returns a HTTP 302 Found redirect to the Recovery UI URL with the Recovery Flow ID appended. `sent_email` is the success state after `choose_method` and allows the user to request another recovery email. It works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state. `passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a recovery link\") does not have any API capabilities. The server responds with a HTTP 302 Found redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Recover UI URL with a new Recovery Flow ID which contains an error message that the recovery link was invalid. More information can be found at [ORY Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
147
+ # @param [Hash] opts the optional parameters
148
+ # @option opts [String] :token Recovery Token The recovery token which completes the recovery request. If the token is invalid (e.g. expired) an error will be shown to the end-user.
149
+ # @option opts [String] :flow The Flow ID format: uuid
150
+ # @option opts [CompleteSelfServiceRecoveryFlowWithLinkMethod] :body
151
+ # @return [nil]
152
+ def complete_self_service_recovery_flow_with_link_method(opts = {})
153
+ complete_self_service_recovery_flow_with_link_method_with_http_info(opts)
154
+ nil
155
+ end
156
+
157
+ # Complete Recovery Flow with Link Method
158
+ # Use this endpoint to complete a recovery flow using the link method. This endpoint behaves differently for API and browser flows and has several states: &#x60;choose_method&#x60; expects &#x60;flow&#x60; (in the URL query) and &#x60;email&#x60; (in the body) to be sent and works with API- and Browser-initiated flows. For API clients it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid and a HTTP 302 Found redirect with a fresh recovery flow if the flow was otherwise invalid (e.g. expired). For Browser clients it returns a HTTP 302 Found redirect to the Recovery UI URL with the Recovery Flow ID appended. &#x60;sent_email&#x60; is the success state after &#x60;choose_method&#x60; and allows the user to request another recovery email. It works for both API and Browser-initiated flows and returns the same responses as the flow in &#x60;choose_method&#x60; state. &#x60;passed_challenge&#x60; expects a &#x60;token&#x60; to be sent in the URL query and given the nature of the flow (\&quot;sending a recovery link\&quot;) does not have any API capabilities. The server responds with a HTTP 302 Found redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Recover UI URL with a new Recovery Flow ID which contains an error message that the recovery link was invalid. More information can be found at [ORY Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
159
+ # @param [Hash] opts the optional parameters
160
+ # @option opts [String] :token Recovery Token The recovery token which completes the recovery request. If the token is invalid (e.g. expired) an error will be shown to the end-user.
161
+ # @option opts [String] :flow The Flow ID format: uuid
162
+ # @option opts [CompleteSelfServiceRecoveryFlowWithLinkMethod] :body
163
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
164
+ def complete_self_service_recovery_flow_with_link_method_with_http_info(opts = {})
165
+ if @api_client.config.debugging
166
+ @api_client.config.logger.debug 'Calling API: PublicApi.complete_self_service_recovery_flow_with_link_method ...'
167
+ end
168
+ # resource path
169
+ local_var_path = '/self-service/recovery/methods/link'
170
+
171
+ # query parameters
172
+ query_params = opts[:query_params] || {}
173
+ query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
174
+ query_params[:'flow'] = opts[:'flow'] if !opts[:'flow'].nil?
175
+
176
+ # header parameters
177
+ header_params = opts[:header_params] || {}
178
+ # HTTP header 'Accept' (if needed)
179
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
180
+ # HTTP header 'Content-Type'
181
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
182
+
183
+ # form parameters
184
+ form_params = opts[:form_params] || {}
185
+
186
+ # http body (model)
187
+ post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])
188
+
189
+ # return_type
190
+ return_type = opts[:return_type]
191
+
192
+ # auth_names
193
+ auth_names = opts[:auth_names] || []
194
+
195
+ new_options = opts.merge(
196
+ :header_params => header_params,
197
+ :query_params => query_params,
198
+ :form_params => form_params,
199
+ :body => post_body,
200
+ :auth_names => auth_names,
201
+ :return_type => return_type
202
+ )
203
+
204
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
205
+ if @api_client.config.debugging
206
+ @api_client.config.logger.debug "API called: PublicApi#complete_self_service_recovery_flow_with_link_method\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
207
+ end
208
+ return data, status_code, headers
209
+ end
210
+
211
+ # Complete Registration Flow with Username/Email Password Method
212
+ # Use this endpoint to complete a registration flow by sending an identity's traits and password. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and respond with HTTP 200 and a application/json body with the created identity success - if the session hook is configured the `session` and `session_token` will also be included; HTTP 302 redirect to a fresh registration flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. Browser flows expect `application/x-www-form-urlencoded` to be sent in the body and responds with a HTTP 302 redirect to the post/after registration URL or the `return_to` value if it was set and if the registration succeeded; a HTTP 302 redirect to the registration UI URL with the flow ID containing the validation errors otherwise. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
213
+ # @param [Hash] opts the optional parameters
214
+ # @option opts [String] :flow Flow is flow ID.
215
+ # @option opts [Object] :payload
216
+ # @return [RegistrationViaApiResponse]
217
+ def complete_self_service_registration_flow_with_password_method(opts = {})
218
+ data, _status_code, _headers = complete_self_service_registration_flow_with_password_method_with_http_info(opts)
219
+ data
220
+ end
221
+
222
+ # Complete Registration Flow with Username/Email Password Method
223
+ # Use this endpoint to complete a registration flow by sending an identity&#39;s traits and password. This endpoint behaves differently for API and browser flows. API flows expect &#x60;application/json&#x60; to be sent in the body and respond with HTTP 200 and a application/json body with the created identity success - if the session hook is configured the &#x60;session&#x60; and &#x60;session_token&#x60; will also be included; HTTP 302 redirect to a fresh registration flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. Browser flows expect &#x60;application/x-www-form-urlencoded&#x60; to be sent in the body and responds with a HTTP 302 redirect to the post/after registration URL or the &#x60;return_to&#x60; value if it was set and if the registration succeeded; a HTTP 302 redirect to the registration UI URL with the flow ID containing the validation errors otherwise. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
224
+ # @param [Hash] opts the optional parameters
225
+ # @option opts [String] :flow Flow is flow ID.
226
+ # @option opts [Object] :payload
227
+ # @return [Array<(RegistrationViaApiResponse, Integer, Hash)>] RegistrationViaApiResponse data, response status code and response headers
228
+ def complete_self_service_registration_flow_with_password_method_with_http_info(opts = {})
229
+ if @api_client.config.debugging
230
+ @api_client.config.logger.debug 'Calling API: PublicApi.complete_self_service_registration_flow_with_password_method ...'
231
+ end
232
+ # resource path
233
+ local_var_path = '/self-service/registration/methods/password'
234
+
235
+ # query parameters
236
+ query_params = opts[:query_params] || {}
237
+ query_params[:'flow'] = opts[:'flow'] if !opts[:'flow'].nil?
238
+
239
+ # header parameters
240
+ header_params = opts[:header_params] || {}
241
+ # HTTP header 'Accept' (if needed)
242
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
243
+ # HTTP header 'Content-Type'
244
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
245
+
246
+ # form parameters
247
+ form_params = opts[:form_params] || {}
248
+
249
+ # http body (model)
250
+ post_body = opts[:body] || @api_client.object_to_http_body(opts[:'payload'])
251
+
252
+ # return_type
253
+ return_type = opts[:return_type] || 'RegistrationViaApiResponse'
254
+
255
+ # auth_names
256
+ auth_names = opts[:auth_names] || []
257
+
258
+ new_options = opts.merge(
259
+ :header_params => header_params,
260
+ :query_params => query_params,
261
+ :form_params => form_params,
262
+ :body => post_body,
263
+ :auth_names => auth_names,
264
+ :return_type => return_type
265
+ )
266
+
267
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
268
+ if @api_client.config.debugging
269
+ @api_client.config.logger.debug "API called: PublicApi#complete_self_service_registration_flow_with_password_method\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
270
+ end
271
+ return data, status_code, headers
272
+ end
273
+
274
+ # Complete Settings Flow with Username/Email Password Method
275
+ # Use this endpoint to complete a settings flow by sending an identity's updated password. This endpoint behaves differently for API and browser flows. API-initiated flows expect `application/json` to be sent in the body and respond with HTTP 200 and an application/json body with the session token on success; HTTP 302 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. HTTP 401 when the endpoint is called without a valid session token. HTTP 403 when `selfservice.flows.settings.privileged_session_max_age` was reached. Implies that the user needs to re-authenticate. Browser flows expect `application/x-www-form-urlencoded` to be sent in the body and responds with a HTTP 302 redirect to the post/after settings URL or the `return_to` value if it was set and if the flow succeeded; a HTTP 302 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise. a HTTP 302 redirect to the login endpoint when `selfservice.flows.settings.privileged_session_max_age` was reached. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
276
+ # @param [Hash] opts the optional parameters
277
+ # @option opts [String] :flow Flow is flow ID.
278
+ # @option opts [CompleteSelfServiceSettingsFlowWithPasswordMethod] :body
279
+ # @return [SettingsViaApiResponse]
280
+ def complete_self_service_settings_flow_with_password_method(opts = {})
281
+ data, _status_code, _headers = complete_self_service_settings_flow_with_password_method_with_http_info(opts)
282
+ data
283
+ end
284
+
285
+ # Complete Settings Flow with Username/Email Password Method
286
+ # Use this endpoint to complete a settings flow by sending an identity&#39;s updated password. This endpoint behaves differently for API and browser flows. API-initiated flows expect &#x60;application/json&#x60; to be sent in the body and respond with HTTP 200 and an application/json body with the session token on success; HTTP 302 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. HTTP 401 when the endpoint is called without a valid session token. HTTP 403 when &#x60;selfservice.flows.settings.privileged_session_max_age&#x60; was reached. Implies that the user needs to re-authenticate. Browser flows expect &#x60;application/x-www-form-urlencoded&#x60; to be sent in the body and responds with a HTTP 302 redirect to the post/after settings URL or the &#x60;return_to&#x60; value if it was set and if the flow succeeded; a HTTP 302 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise. a HTTP 302 redirect to the login endpoint when &#x60;selfservice.flows.settings.privileged_session_max_age&#x60; was reached. More information can be found at [ORY Kratos User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
287
+ # @param [Hash] opts the optional parameters
288
+ # @option opts [String] :flow Flow is flow ID.
289
+ # @option opts [CompleteSelfServiceSettingsFlowWithPasswordMethod] :body
290
+ # @return [Array<(SettingsViaApiResponse, Integer, Hash)>] SettingsViaApiResponse data, response status code and response headers
291
+ def complete_self_service_settings_flow_with_password_method_with_http_info(opts = {})
292
+ if @api_client.config.debugging
293
+ @api_client.config.logger.debug 'Calling API: PublicApi.complete_self_service_settings_flow_with_password_method ...'
294
+ end
295
+ # resource path
296
+ local_var_path = '/self-service/settings/methods/password'
297
+
298
+ # query parameters
299
+ query_params = opts[:query_params] || {}
300
+ query_params[:'flow'] = opts[:'flow'] if !opts[:'flow'].nil?
301
+
302
+ # header parameters
303
+ header_params = opts[:header_params] || {}
304
+ # HTTP header 'Accept' (if needed)
305
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
306
+ # HTTP header 'Content-Type'
307
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
308
+
309
+ # form parameters
310
+ form_params = opts[:form_params] || {}
311
+
312
+ # http body (model)
313
+ post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])
314
+
315
+ # return_type
316
+ return_type = opts[:return_type] || 'SettingsViaApiResponse'
317
+
318
+ # auth_names
319
+ auth_names = opts[:auth_names] || ['sessionToken']
320
+
321
+ new_options = opts.merge(
322
+ :header_params => header_params,
323
+ :query_params => query_params,
324
+ :form_params => form_params,
325
+ :body => post_body,
326
+ :auth_names => auth_names,
327
+ :return_type => return_type
328
+ )
329
+
330
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
331
+ if @api_client.config.debugging
332
+ @api_client.config.logger.debug "API called: PublicApi#complete_self_service_settings_flow_with_password_method\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
333
+ end
334
+ return data, status_code, headers
335
+ end
336
+
337
+ # Complete Settings Flow with Profile Method
338
+ # Use this endpoint to complete a settings flow by sending an identity's updated traits. This endpoint behaves differently for API and browser flows. API-initiated flows expect `application/json` to be sent in the body and respond with HTTP 200 and an application/json body with the session token on success; HTTP 302 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. HTTP 401 when the endpoint is called without a valid session token. HTTP 403 when `selfservice.flows.settings.privileged_session_max_age` was reached and a sensitive field was updated (e.g. recovery email). Implies that the user needs to re-authenticate. Browser flows expect `application/x-www-form-urlencoded` to be sent in the body and responds with a HTTP 302 redirect to the post/after settings URL or the `return_to` value if it was set and if the flow succeeded; a HTTP 302 redirect to the settings UI URL with the flow ID containing the validation errors otherwise. a HTTP 302 redirect to the login endpoint when `selfservice.flows.settings.privileged_session_max_age` was reached. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
339
+ # @param [Hash] opts the optional parameters
340
+ # @option opts [String] :flow Flow is flow ID.
341
+ # @option opts [Object] :payload
342
+ # @return [SettingsFlow]
343
+ def complete_self_service_settings_flow_with_profile_method(opts = {})
344
+ data, _status_code, _headers = complete_self_service_settings_flow_with_profile_method_with_http_info(opts)
345
+ data
346
+ end
347
+
348
+ # Complete Settings Flow with Profile Method
349
+ # Use this endpoint to complete a settings flow by sending an identity&#39;s updated traits. This endpoint behaves differently for API and browser flows. API-initiated flows expect &#x60;application/json&#x60; to be sent in the body and respond with HTTP 200 and an application/json body with the session token on success; HTTP 302 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. HTTP 401 when the endpoint is called without a valid session token. HTTP 403 when &#x60;selfservice.flows.settings.privileged_session_max_age&#x60; was reached and a sensitive field was updated (e.g. recovery email). Implies that the user needs to re-authenticate. Browser flows expect &#x60;application/x-www-form-urlencoded&#x60; to be sent in the body and responds with a HTTP 302 redirect to the post/after settings URL or the &#x60;return_to&#x60; value if it was set and if the flow succeeded; a HTTP 302 redirect to the settings UI URL with the flow ID containing the validation errors otherwise. a HTTP 302 redirect to the login endpoint when &#x60;selfservice.flows.settings.privileged_session_max_age&#x60; was reached. More information can be found at [ORY Kratos User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
350
+ # @param [Hash] opts the optional parameters
351
+ # @option opts [String] :flow Flow is flow ID.
352
+ # @option opts [Object] :payload
353
+ # @return [Array<(SettingsFlow, Integer, Hash)>] SettingsFlow data, response status code and response headers
354
+ def complete_self_service_settings_flow_with_profile_method_with_http_info(opts = {})
355
+ if @api_client.config.debugging
356
+ @api_client.config.logger.debug 'Calling API: PublicApi.complete_self_service_settings_flow_with_profile_method ...'
357
+ end
358
+ # resource path
359
+ local_var_path = '/self-service/settings/methods/profile'
360
+
361
+ # query parameters
362
+ query_params = opts[:query_params] || {}
363
+ query_params[:'flow'] = opts[:'flow'] if !opts[:'flow'].nil?
364
+
365
+ # header parameters
366
+ header_params = opts[:header_params] || {}
367
+ # HTTP header 'Accept' (if needed)
368
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
369
+ # HTTP header 'Content-Type'
370
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
371
+
372
+ # form parameters
373
+ form_params = opts[:form_params] || {}
374
+
375
+ # http body (model)
376
+ post_body = opts[:body] || @api_client.object_to_http_body(opts[:'payload'])
377
+
378
+ # return_type
379
+ return_type = opts[:return_type] || 'SettingsFlow'
380
+
381
+ # auth_names
382
+ auth_names = opts[:auth_names] || ['sessionToken']
383
+
384
+ new_options = opts.merge(
385
+ :header_params => header_params,
386
+ :query_params => query_params,
387
+ :form_params => form_params,
388
+ :body => post_body,
389
+ :auth_names => auth_names,
390
+ :return_type => return_type
391
+ )
392
+
393
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
394
+ if @api_client.config.debugging
395
+ @api_client.config.logger.debug "API called: PublicApi#complete_self_service_settings_flow_with_profile_method\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
396
+ end
397
+ return data, status_code, headers
398
+ end
399
+
400
+ # Complete Verification Flow with Link Method
401
+ # Use this endpoint to complete a verification flow using the link method. This endpoint behaves differently for API and browser flows and has several states: `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. For API clients it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid and a HTTP 302 Found redirect with a fresh verification flow if the flow was otherwise invalid (e.g. expired). For Browser clients it returns a HTTP 302 Found redirect to the Verification UI URL with the Verification Flow ID appended. `sent_email` is the success state after `choose_method` and allows the user to request another verification email. It works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state. `passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a verification link\") does not have any API capabilities. The server responds with a HTTP 302 Found redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Verification UI URL with a new Verification Flow ID which contains an error message that the verification link was invalid. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
402
+ # @param [Hash] opts the optional parameters
403
+ # @option opts [String] :token Verification Token The verification token which completes the verification request. If the token is invalid (e.g. expired) an error will be shown to the end-user.
404
+ # @option opts [String] :flow The Flow ID format: uuid
405
+ # @option opts [CompleteSelfServiceVerificationFlowWithLinkMethod] :body
406
+ # @return [nil]
407
+ def complete_self_service_verification_flow_with_link_method(opts = {})
408
+ complete_self_service_verification_flow_with_link_method_with_http_info(opts)
409
+ nil
410
+ end
411
+
412
+ # Complete Verification Flow with Link Method
413
+ # Use this endpoint to complete a verification flow using the link method. This endpoint behaves differently for API and browser flows and has several states: &#x60;choose_method&#x60; expects &#x60;flow&#x60; (in the URL query) and &#x60;email&#x60; (in the body) to be sent and works with API- and Browser-initiated flows. For API clients it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid and a HTTP 302 Found redirect with a fresh verification flow if the flow was otherwise invalid (e.g. expired). For Browser clients it returns a HTTP 302 Found redirect to the Verification UI URL with the Verification Flow ID appended. &#x60;sent_email&#x60; is the success state after &#x60;choose_method&#x60; and allows the user to request another verification email. It works for both API and Browser-initiated flows and returns the same responses as the flow in &#x60;choose_method&#x60; state. &#x60;passed_challenge&#x60; expects a &#x60;token&#x60; to be sent in the URL query and given the nature of the flow (\&quot;sending a verification link\&quot;) does not have any API capabilities. The server responds with a HTTP 302 Found redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Verification UI URL with a new Verification Flow ID which contains an error message that the verification link was invalid. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
414
+ # @param [Hash] opts the optional parameters
415
+ # @option opts [String] :token Verification Token The verification token which completes the verification request. If the token is invalid (e.g. expired) an error will be shown to the end-user.
416
+ # @option opts [String] :flow The Flow ID format: uuid
417
+ # @option opts [CompleteSelfServiceVerificationFlowWithLinkMethod] :body
418
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
419
+ def complete_self_service_verification_flow_with_link_method_with_http_info(opts = {})
420
+ if @api_client.config.debugging
421
+ @api_client.config.logger.debug 'Calling API: PublicApi.complete_self_service_verification_flow_with_link_method ...'
422
+ end
423
+ # resource path
424
+ local_var_path = '/self-service/verification/methods/link'
425
+
426
+ # query parameters
427
+ query_params = opts[:query_params] || {}
428
+ query_params[:'token'] = opts[:'token'] if !opts[:'token'].nil?
429
+ query_params[:'flow'] = opts[:'flow'] if !opts[:'flow'].nil?
430
+
431
+ # header parameters
432
+ header_params = opts[:header_params] || {}
433
+ # HTTP header 'Accept' (if needed)
434
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
435
+ # HTTP header 'Content-Type'
436
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
437
+
438
+ # form parameters
439
+ form_params = opts[:form_params] || {}
440
+
441
+ # http body (model)
442
+ post_body = opts[:body] || @api_client.object_to_http_body(opts[:'body'])
443
+
444
+ # return_type
445
+ return_type = opts[:return_type]
446
+
447
+ # auth_names
448
+ auth_names = opts[:auth_names] || []
449
+
450
+ new_options = opts.merge(
451
+ :header_params => header_params,
452
+ :query_params => query_params,
453
+ :form_params => form_params,
454
+ :body => post_body,
455
+ :auth_names => auth_names,
456
+ :return_type => return_type
457
+ )
458
+
459
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
460
+ if @api_client.config.debugging
461
+ @api_client.config.logger.debug "API called: PublicApi#complete_self_service_verification_flow_with_link_method\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
462
+ end
463
+ return data, status_code, headers
464
+ end
465
+
466
+ # Get a Traits Schema Definition
467
+ # @param id [String] ID must be set to the ID of schema you want to get
468
+ # @param [Hash] opts the optional parameters
469
+ # @return [Object]
470
+ def get_schema(id, opts = {})
471
+ data, _status_code, _headers = get_schema_with_http_info(id, opts)
472
+ data
473
+ end
474
+
475
+ # Get a Traits Schema Definition
476
+ # @param id [String] ID must be set to the ID of schema you want to get
477
+ # @param [Hash] opts the optional parameters
478
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
479
+ def get_schema_with_http_info(id, opts = {})
480
+ if @api_client.config.debugging
481
+ @api_client.config.logger.debug 'Calling API: PublicApi.get_schema ...'
482
+ end
483
+ # verify the required parameter 'id' is set
484
+ if @api_client.config.client_side_validation && id.nil?
485
+ fail ArgumentError, "Missing the required parameter 'id' when calling PublicApi.get_schema"
486
+ end
487
+ # resource path
488
+ local_var_path = '/schemas/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
489
+
490
+ # query parameters
491
+ query_params = opts[:query_params] || {}
492
+
493
+ # header parameters
494
+ header_params = opts[:header_params] || {}
495
+ # HTTP header 'Accept' (if needed)
496
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
497
+
498
+ # form parameters
499
+ form_params = opts[:form_params] || {}
500
+
501
+ # http body (model)
502
+ post_body = opts[:body]
503
+
504
+ # return_type
505
+ return_type = opts[:return_type] || 'Object'
506
+
507
+ # auth_names
508
+ auth_names = opts[:auth_names] || []
509
+
510
+ new_options = opts.merge(
511
+ :header_params => header_params,
512
+ :query_params => query_params,
513
+ :form_params => form_params,
514
+ :body => post_body,
515
+ :auth_names => auth_names,
516
+ :return_type => return_type
517
+ )
518
+
519
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
520
+ if @api_client.config.debugging
521
+ @api_client.config.logger.debug "API called: PublicApi#get_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
522
+ end
523
+ return data, status_code, headers
524
+ end
525
+
526
+ # Get User-Facing Self-Service Errors
527
+ # This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: `?error=stub:500` - returns a stub 500 (Internal Server Error) error. More information can be found at [ORY Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
528
+ # @param error [String] Error is the container&#39;s ID
529
+ # @param [Hash] opts the optional parameters
530
+ # @return [ErrorContainer]
531
+ def get_self_service_error(error, opts = {})
532
+ data, _status_code, _headers = get_self_service_error_with_http_info(error, opts)
533
+ data
534
+ end
535
+
536
+ # Get User-Facing Self-Service Errors
537
+ # This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: &#x60;?error&#x3D;stub:500&#x60; - returns a stub 500 (Internal Server Error) error. More information can be found at [ORY Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
538
+ # @param error [String] Error is the container&#39;s ID
539
+ # @param [Hash] opts the optional parameters
540
+ # @return [Array<(ErrorContainer, Integer, Hash)>] ErrorContainer data, response status code and response headers
541
+ def get_self_service_error_with_http_info(error, opts = {})
542
+ if @api_client.config.debugging
543
+ @api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_error ...'
544
+ end
545
+ # verify the required parameter 'error' is set
546
+ if @api_client.config.client_side_validation && error.nil?
547
+ fail ArgumentError, "Missing the required parameter 'error' when calling PublicApi.get_self_service_error"
548
+ end
549
+ # resource path
550
+ local_var_path = '/self-service/errors'
551
+
552
+ # query parameters
553
+ query_params = opts[:query_params] || {}
554
+ query_params[:'error'] = error
555
+
556
+ # header parameters
557
+ header_params = opts[:header_params] || {}
558
+ # HTTP header 'Accept' (if needed)
559
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
560
+
561
+ # form parameters
562
+ form_params = opts[:form_params] || {}
563
+
564
+ # http body (model)
565
+ post_body = opts[:body]
566
+
567
+ # return_type
568
+ return_type = opts[:return_type] || 'ErrorContainer'
569
+
570
+ # auth_names
571
+ auth_names = opts[:auth_names] || []
572
+
573
+ new_options = opts.merge(
574
+ :header_params => header_params,
575
+ :query_params => query_params,
576
+ :form_params => form_params,
577
+ :body => post_body,
578
+ :auth_names => auth_names,
579
+ :return_type => return_type
580
+ )
581
+
582
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
583
+ if @api_client.config.debugging
584
+ @api_client.config.logger.debug "API called: PublicApi#get_self_service_error\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
46
585
  end
47
- # verify the required parameter 'body' is set
48
- if @api_client.config.client_side_validation && body.nil?
49
- fail ArgumentError, "Missing the required parameter 'body' when calling PublicApi.complete_self_service_browser_profile_management_flow"
586
+ return data, status_code, headers
587
+ end
588
+
589
+ # Get Login Flow
590
+ # This endpoint returns a login flow's context with, for example, error details and other information. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
591
+ # @param id [String] The Login Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/login?flow&#x3D;abcde&#x60;).
592
+ # @param [Hash] opts the optional parameters
593
+ # @return [LoginFlow]
594
+ def get_self_service_login_flow(id, opts = {})
595
+ data, _status_code, _headers = get_self_service_login_flow_with_http_info(id, opts)
596
+ data
597
+ end
598
+
599
+ # Get Login Flow
600
+ # This endpoint returns a login flow&#39;s context with, for example, error details and other information. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
601
+ # @param id [String] The Login Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/login?flow&#x3D;abcde&#x60;).
602
+ # @param [Hash] opts the optional parameters
603
+ # @return [Array<(LoginFlow, Integer, Hash)>] LoginFlow data, response status code and response headers
604
+ def get_self_service_login_flow_with_http_info(id, opts = {})
605
+ if @api_client.config.debugging
606
+ @api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_login_flow ...'
607
+ end
608
+ # verify the required parameter 'id' is set
609
+ if @api_client.config.client_side_validation && id.nil?
610
+ fail ArgumentError, "Missing the required parameter 'id' when calling PublicApi.get_self_service_login_flow"
50
611
  end
51
612
  # resource path
52
- local_var_path = '/self-service/browser/flows/profile/update'
613
+ local_var_path = '/self-service/login/flows'
53
614
 
54
615
  # query parameters
55
616
  query_params = opts[:query_params] || {}
56
- query_params[:'request'] = request
617
+ query_params[:'id'] = id
57
618
 
58
619
  # header parameters
59
620
  header_params = opts[:header_params] || {}
60
621
  # HTTP header 'Accept' (if needed)
61
622
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
62
- # HTTP header 'Content-Type'
63
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
64
623
 
65
624
  # form parameters
66
625
  form_params = opts[:form_params] || {}
67
626
 
68
627
  # http body (model)
69
- post_body = opts[:body] || @api_client.object_to_http_body(body)
628
+ post_body = opts[:body]
70
629
 
71
630
  # return_type
72
- return_type = opts[:return_type]
631
+ return_type = opts[:return_type] || 'LoginFlow'
73
632
 
74
633
  # auth_names
75
634
  auth_names = opts[:auth_names] || []
@@ -83,48 +642,42 @@ module OryHydraClient
83
642
  :return_type => return_type
84
643
  )
85
644
 
86
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
645
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
87
646
  if @api_client.config.debugging
88
- @api_client.config.logger.debug "API called: PublicApi#complete_self_service_browser_profile_management_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
647
+ @api_client.config.logger.debug "API called: PublicApi#get_self_service_login_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
89
648
  end
90
649
  return data, status_code, headers
91
650
  end
92
651
 
93
- # Complete the browser-based profile management flows
94
- # This endpoint completes a browser-based profile management flow. This is usually achieved by POSTing data to this endpoint. If the provided profile data is valid against the Identity's Traits JSON Schema, the data will be updated and the browser redirected to `url.profile_ui` for further steps. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
95
- # @param request [String] Request is the Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/verify?request&#x3D;abcde&#x60;).
96
- # @param via [String] What to verify Currently only \&quot;email\&quot; is supported.
652
+ # Get information about a recovery flow
653
+ # This endpoint returns a recovery flow's context with, for example, error details and other information. More information can be found at [ORY Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
654
+ # @param id [String] The Flow ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/recovery?flow&#x3D;abcde&#x60;).
97
655
  # @param [Hash] opts the optional parameters
98
- # @return [nil]
99
- def complete_self_service_browser_verification_flow(request, via, opts = {})
100
- complete_self_service_browser_verification_flow_with_http_info(request, via, opts)
101
- nil
656
+ # @return [RecoveryFlow]
657
+ def get_self_service_recovery_flow(id, opts = {})
658
+ data, _status_code, _headers = get_self_service_recovery_flow_with_http_info(id, opts)
659
+ data
102
660
  end
103
661
 
104
- # Complete the browser-based profile management flows
105
- # This endpoint completes a browser-based profile management flow. This is usually achieved by POSTing data to this endpoint. If the provided profile data is valid against the Identity&#39;s Traits JSON Schema, the data will be updated and the browser redirected to &#x60;url.profile_ui&#x60; for further steps. &gt; This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
106
- # @param request [String] Request is the Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/verify?request&#x3D;abcde&#x60;).
107
- # @param via [String] What to verify Currently only \&quot;email\&quot; is supported.
662
+ # Get information about a recovery flow
663
+ # This endpoint returns a recovery flow&#39;s context with, for example, error details and other information. More information can be found at [ORY Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
664
+ # @param id [String] The Flow ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/recovery?flow&#x3D;abcde&#x60;).
108
665
  # @param [Hash] opts the optional parameters
109
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
110
- def complete_self_service_browser_verification_flow_with_http_info(request, via, opts = {})
666
+ # @return [Array<(RecoveryFlow, Integer, Hash)>] RecoveryFlow data, response status code and response headers
667
+ def get_self_service_recovery_flow_with_http_info(id, opts = {})
111
668
  if @api_client.config.debugging
112
- @api_client.config.logger.debug 'Calling API: PublicApi.complete_self_service_browser_verification_flow ...'
669
+ @api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_recovery_flow ...'
113
670
  end
114
- # verify the required parameter 'request' is set
115
- if @api_client.config.client_side_validation && request.nil?
116
- fail ArgumentError, "Missing the required parameter 'request' when calling PublicApi.complete_self_service_browser_verification_flow"
117
- end
118
- # verify the required parameter 'via' is set
119
- if @api_client.config.client_side_validation && via.nil?
120
- fail ArgumentError, "Missing the required parameter 'via' when calling PublicApi.complete_self_service_browser_verification_flow"
671
+ # verify the required parameter 'id' is set
672
+ if @api_client.config.client_side_validation && id.nil?
673
+ fail ArgumentError, "Missing the required parameter 'id' when calling PublicApi.get_self_service_recovery_flow"
121
674
  end
122
675
  # resource path
123
- local_var_path = '/self-service/browser/flows/verification/{via}/complete'.sub('{' + 'via' + '}', CGI.escape(via.to_s))
676
+ local_var_path = '/self-service/recovery/flows'
124
677
 
125
678
  # query parameters
126
679
  query_params = opts[:query_params] || {}
127
- query_params[:'request'] = request
680
+ query_params[:'id'] = id
128
681
 
129
682
  # header parameters
130
683
  header_params = opts[:header_params] || {}
@@ -138,7 +691,7 @@ module OryHydraClient
138
691
  post_body = opts[:body]
139
692
 
140
693
  # return_type
141
- return_type = opts[:return_type]
694
+ return_type = opts[:return_type] || 'RecoveryFlow'
142
695
 
143
696
  # auth_names
144
697
  auth_names = opts[:auth_names] || []
@@ -152,42 +705,42 @@ module OryHydraClient
152
705
  :return_type => return_type
153
706
  )
154
707
 
155
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
708
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
156
709
  if @api_client.config.debugging
157
- @api_client.config.logger.debug "API called: PublicApi#complete_self_service_browser_verification_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
710
+ @api_client.config.logger.debug "API called: PublicApi#get_self_service_recovery_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
158
711
  end
159
712
  return data, status_code, headers
160
713
  end
161
714
 
162
- # Get the request context of browser-based login user flows
163
- # This endpoint returns a login request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
164
- # @param request [String] Request is the Login Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/login?request&#x3D;abcde&#x60;).
715
+ # Get Registration Flow
716
+ # This endpoint returns a registration flow's context with, for example, error details and other information. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
717
+ # @param id [String] The Registration Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/registration?flow&#x3D;abcde&#x60;).
165
718
  # @param [Hash] opts the optional parameters
166
- # @return [LoginRequest]
167
- def get_self_service_browser_login_request(request, opts = {})
168
- data, _status_code, _headers = get_self_service_browser_login_request_with_http_info(request, opts)
719
+ # @return [RegistrationFlow]
720
+ def get_self_service_registration_flow(id, opts = {})
721
+ data, _status_code, _headers = get_self_service_registration_flow_with_http_info(id, opts)
169
722
  data
170
723
  end
171
724
 
172
- # Get the request context of browser-based login user flows
173
- # This endpoint returns a login request&#39;s context with, for example, error details and other information. When accessing this endpoint through ORY Kratos&#39; Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
174
- # @param request [String] Request is the Login Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/login?request&#x3D;abcde&#x60;).
725
+ # Get Registration Flow
726
+ # This endpoint returns a registration flow&#39;s context with, for example, error details and other information. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
727
+ # @param id [String] The Registration Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/registration?flow&#x3D;abcde&#x60;).
175
728
  # @param [Hash] opts the optional parameters
176
- # @return [Array<(LoginRequest, Integer, Hash)>] LoginRequest data, response status code and response headers
177
- def get_self_service_browser_login_request_with_http_info(request, opts = {})
729
+ # @return [Array<(RegistrationFlow, Integer, Hash)>] RegistrationFlow data, response status code and response headers
730
+ def get_self_service_registration_flow_with_http_info(id, opts = {})
178
731
  if @api_client.config.debugging
179
- @api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_browser_login_request ...'
732
+ @api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_registration_flow ...'
180
733
  end
181
- # verify the required parameter 'request' is set
182
- if @api_client.config.client_side_validation && request.nil?
183
- fail ArgumentError, "Missing the required parameter 'request' when calling PublicApi.get_self_service_browser_login_request"
734
+ # verify the required parameter 'id' is set
735
+ if @api_client.config.client_side_validation && id.nil?
736
+ fail ArgumentError, "Missing the required parameter 'id' when calling PublicApi.get_self_service_registration_flow"
184
737
  end
185
738
  # resource path
186
- local_var_path = '/self-service/browser/flows/requests/login'
739
+ local_var_path = '/self-service/registration/flows'
187
740
 
188
741
  # query parameters
189
742
  query_params = opts[:query_params] || {}
190
- query_params[:'request'] = request
743
+ query_params[:'id'] = id
191
744
 
192
745
  # header parameters
193
746
  header_params = opts[:header_params] || {}
@@ -201,7 +754,7 @@ module OryHydraClient
201
754
  post_body = opts[:body]
202
755
 
203
756
  # return_type
204
- return_type = opts[:return_type] || 'LoginRequest'
757
+ return_type = opts[:return_type] || 'RegistrationFlow'
205
758
 
206
759
  # auth_names
207
760
  auth_names = opts[:auth_names] || []
@@ -217,40 +770,40 @@ module OryHydraClient
217
770
 
218
771
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
219
772
  if @api_client.config.debugging
220
- @api_client.config.logger.debug "API called: PublicApi#get_self_service_browser_login_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
773
+ @api_client.config.logger.debug "API called: PublicApi#get_self_service_registration_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
221
774
  end
222
775
  return data, status_code, headers
223
776
  end
224
777
 
225
- # Get the request context of browser-based profile management flows
226
- # When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos Profile Management Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-profile-management).
227
- # @param request [String] Request is the Login Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/login?request&#x3D;abcde&#x60;).
778
+ # Get Settings Flow
779
+ # When accessing this endpoint through ORY Kratos' Public API you must ensure that either the ORY Kratos Session Cookie or the ORY Kratos Session Token are set. The public endpoint does not return 404 status codes but instead 403 or 500 to improve data privacy. You can access this endpoint without credentials when using ORY Kratos' Admin API. More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
780
+ # @param id [String] ID is the Settings Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/settings?flow&#x3D;abcde&#x60;).
228
781
  # @param [Hash] opts the optional parameters
229
- # @return [ProfileManagementRequest]
230
- def get_self_service_browser_profile_management_request(request, opts = {})
231
- data, _status_code, _headers = get_self_service_browser_profile_management_request_with_http_info(request, opts)
782
+ # @return [SettingsFlow]
783
+ def get_self_service_settings_flow(id, opts = {})
784
+ data, _status_code, _headers = get_self_service_settings_flow_with_http_info(id, opts)
232
785
  data
233
786
  end
234
787
 
235
- # Get the request context of browser-based profile management flows
236
- # When accessing this endpoint through ORY Kratos&#39; Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos Profile Management Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-profile-management).
237
- # @param request [String] Request is the Login Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/login?request&#x3D;abcde&#x60;).
788
+ # Get Settings Flow
789
+ # When accessing this endpoint through ORY Kratos&#39; Public API you must ensure that either the ORY Kratos Session Cookie or the ORY Kratos Session Token are set. The public endpoint does not return 404 status codes but instead 403 or 500 to improve data privacy. You can access this endpoint without credentials when using ORY Kratos&#39; Admin API. More information can be found at [ORY Kratos User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
790
+ # @param id [String] ID is the Settings Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/settings?flow&#x3D;abcde&#x60;).
238
791
  # @param [Hash] opts the optional parameters
239
- # @return [Array<(ProfileManagementRequest, Integer, Hash)>] ProfileManagementRequest data, response status code and response headers
240
- def get_self_service_browser_profile_management_request_with_http_info(request, opts = {})
792
+ # @return [Array<(SettingsFlow, Integer, Hash)>] SettingsFlow data, response status code and response headers
793
+ def get_self_service_settings_flow_with_http_info(id, opts = {})
241
794
  if @api_client.config.debugging
242
- @api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_browser_profile_management_request ...'
795
+ @api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_settings_flow ...'
243
796
  end
244
- # verify the required parameter 'request' is set
245
- if @api_client.config.client_side_validation && request.nil?
246
- fail ArgumentError, "Missing the required parameter 'request' when calling PublicApi.get_self_service_browser_profile_management_request"
797
+ # verify the required parameter 'id' is set
798
+ if @api_client.config.client_side_validation && id.nil?
799
+ fail ArgumentError, "Missing the required parameter 'id' when calling PublicApi.get_self_service_settings_flow"
247
800
  end
248
801
  # resource path
249
- local_var_path = '/self-service/browser/flows/requests/profile'
802
+ local_var_path = '/self-service/settings/flows'
250
803
 
251
804
  # query parameters
252
805
  query_params = opts[:query_params] || {}
253
- query_params[:'request'] = request
806
+ query_params[:'id'] = id
254
807
 
255
808
  # header parameters
256
809
  header_params = opts[:header_params] || {}
@@ -264,10 +817,10 @@ module OryHydraClient
264
817
  post_body = opts[:body]
265
818
 
266
819
  # return_type
267
- return_type = opts[:return_type] || 'ProfileManagementRequest'
820
+ return_type = opts[:return_type] || 'SettingsFlow'
268
821
 
269
822
  # auth_names
270
- auth_names = opts[:auth_names] || []
823
+ auth_names = opts[:auth_names] || ['sessionToken']
271
824
 
272
825
  new_options = opts.merge(
273
826
  :header_params => header_params,
@@ -280,40 +833,40 @@ module OryHydraClient
280
833
 
281
834
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
282
835
  if @api_client.config.debugging
283
- @api_client.config.logger.debug "API called: PublicApi#get_self_service_browser_profile_management_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
836
+ @api_client.config.logger.debug "API called: PublicApi#get_self_service_settings_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
284
837
  end
285
838
  return data, status_code, headers
286
839
  end
287
840
 
288
- # Get the request context of browser-based registration user flows
289
- # This endpoint returns a registration request's context with, for example, error details and other information. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
290
- # @param request [String] Request is the Registration Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/registration?request&#x3D;abcde&#x60;).
841
+ # Get Verification Flow
842
+ # This endpoint returns a verification flow's context with, for example, error details and other information. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
843
+ # @param id [String] The Flow ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/verification?flow&#x3D;abcde&#x60;).
291
844
  # @param [Hash] opts the optional parameters
292
- # @return [RegistrationRequest]
293
- def get_self_service_browser_registration_request(request, opts = {})
294
- data, _status_code, _headers = get_self_service_browser_registration_request_with_http_info(request, opts)
845
+ # @return [VerificationFlow]
846
+ def get_self_service_verification_flow(id, opts = {})
847
+ data, _status_code, _headers = get_self_service_verification_flow_with_http_info(id, opts)
295
848
  data
296
849
  end
297
850
 
298
- # Get the request context of browser-based registration user flows
299
- # This endpoint returns a registration request&#39;s context with, for example, error details and other information. When accessing this endpoint through ORY Kratos&#39; Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
300
- # @param request [String] Request is the Registration Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/registration?request&#x3D;abcde&#x60;).
851
+ # Get Verification Flow
852
+ # This endpoint returns a verification flow&#39;s context with, for example, error details and other information. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
853
+ # @param id [String] The Flow ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/verification?flow&#x3D;abcde&#x60;).
301
854
  # @param [Hash] opts the optional parameters
302
- # @return [Array<(RegistrationRequest, Integer, Hash)>] RegistrationRequest data, response status code and response headers
303
- def get_self_service_browser_registration_request_with_http_info(request, opts = {})
855
+ # @return [Array<(VerificationFlow, Integer, Hash)>] VerificationFlow data, response status code and response headers
856
+ def get_self_service_verification_flow_with_http_info(id, opts = {})
304
857
  if @api_client.config.debugging
305
- @api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_browser_registration_request ...'
858
+ @api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_verification_flow ...'
306
859
  end
307
- # verify the required parameter 'request' is set
308
- if @api_client.config.client_side_validation && request.nil?
309
- fail ArgumentError, "Missing the required parameter 'request' when calling PublicApi.get_self_service_browser_registration_request"
860
+ # verify the required parameter 'id' is set
861
+ if @api_client.config.client_side_validation && id.nil?
862
+ fail ArgumentError, "Missing the required parameter 'id' when calling PublicApi.get_self_service_verification_flow"
310
863
  end
311
864
  # resource path
312
- local_var_path = '/self-service/browser/flows/requests/registration'
865
+ local_var_path = '/self-service/verification/flows'
313
866
 
314
867
  # query parameters
315
868
  query_params = opts[:query_params] || {}
316
- query_params[:'request'] = request
869
+ query_params[:'id'] = id
317
870
 
318
871
  # header parameters
319
872
  header_params = opts[:header_params] || {}
@@ -327,7 +880,7 @@ module OryHydraClient
327
880
  post_body = opts[:body]
328
881
 
329
882
  # return_type
330
- return_type = opts[:return_type] || 'RegistrationRequest'
883
+ return_type = opts[:return_type] || 'VerificationFlow'
331
884
 
332
885
  # auth_names
333
886
  auth_names = opts[:auth_names] || []
@@ -343,36 +896,33 @@ module OryHydraClient
343
896
 
344
897
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
345
898
  if @api_client.config.debugging
346
- @api_client.config.logger.debug "API called: PublicApi#get_self_service_browser_registration_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
899
+ @api_client.config.logger.debug "API called: PublicApi#get_self_service_verification_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
347
900
  end
348
901
  return data, status_code, headers
349
902
  end
350
903
 
351
- # Get user-facing self-service errors
352
- # This endpoint returns the error associated with a user-facing self service errors. When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
904
+ # Initialize Browser-Based Logout User Flow
905
+ # This endpoint initializes a logout flow. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). On successful logout, the browser will be redirected (HTTP 302 Found) to `urls.default_return_to`. More information can be found at [ORY Kratos User Logout Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-logout).
353
906
  # @param [Hash] opts the optional parameters
354
- # @option opts [String] :id
355
- # @return [ErrorContainer]
356
- def get_self_service_error(opts = {})
357
- data, _status_code, _headers = get_self_service_error_with_http_info(opts)
358
- data
907
+ # @return [nil]
908
+ def initialize_self_service_browser_logout_flow(opts = {})
909
+ initialize_self_service_browser_logout_flow_with_http_info(opts)
910
+ nil
359
911
  end
360
912
 
361
- # Get user-facing self-service errors
362
- # This endpoint returns the error associated with a user-facing self service errors. When accessing this endpoint through ORY Kratos&#39; Public API, ensure that cookies are set as they are required for CSRF to work. To prevent token scanning attacks, the public endpoint does not return 404 status codes to prevent scanning attacks. More information can be found at [ORY Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
913
+ # Initialize Browser-Based Logout User Flow
914
+ # This endpoint initializes a logout flow. &gt; This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). On successful logout, the browser will be redirected (HTTP 302 Found) to &#x60;urls.default_return_to&#x60;. More information can be found at [ORY Kratos User Logout Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-logout).
363
915
  # @param [Hash] opts the optional parameters
364
- # @option opts [String] :id
365
- # @return [Array<(ErrorContainer, Integer, Hash)>] ErrorContainer data, response status code and response headers
366
- def get_self_service_error_with_http_info(opts = {})
916
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
917
+ def initialize_self_service_browser_logout_flow_with_http_info(opts = {})
367
918
  if @api_client.config.debugging
368
- @api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_error ...'
919
+ @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_browser_logout_flow ...'
369
920
  end
370
921
  # resource path
371
- local_var_path = '/self-service/errors'
922
+ local_var_path = '/self-service/browser/flows/logout'
372
923
 
373
924
  # query parameters
374
925
  query_params = opts[:query_params] || {}
375
- query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
376
926
 
377
927
  # header parameters
378
928
  header_params = opts[:header_params] || {}
@@ -386,7 +936,7 @@ module OryHydraClient
386
936
  post_body = opts[:body]
387
937
 
388
938
  # return_type
389
- return_type = opts[:return_type] || 'ErrorContainer'
939
+ return_type = opts[:return_type]
390
940
 
391
941
  # auth_names
392
942
  auth_names = opts[:auth_names] || []
@@ -402,40 +952,36 @@ module OryHydraClient
402
952
 
403
953
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
404
954
  if @api_client.config.debugging
405
- @api_client.config.logger.debug "API called: PublicApi#get_self_service_error\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
955
+ @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_browser_logout_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
406
956
  end
407
957
  return data, status_code, headers
408
958
  end
409
959
 
410
- # Get the request context of browser-based verification flows
411
- # When accessing this endpoint through ORY Kratos' Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
412
- # @param request [String] Request is the Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/verify?request&#x3D;abcde&#x60;).
960
+ # Initialize Login Flow for API clients
961
+ # This endpoint initiates a login flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing login flow call `/self-service/login/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks, including CSRF login attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
413
962
  # @param [Hash] opts the optional parameters
414
- # @return [VerificationRequest]
415
- def get_self_service_verification_request(request, opts = {})
416
- data, _status_code, _headers = get_self_service_verification_request_with_http_info(request, opts)
963
+ # @option opts [Boolean] :refresh Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session.
964
+ # @return [LoginFlow]
965
+ def initialize_self_service_login_via_api_flow(opts = {})
966
+ data, _status_code, _headers = initialize_self_service_login_via_api_flow_with_http_info(opts)
417
967
  data
418
968
  end
419
969
 
420
- # Get the request context of browser-based verification flows
421
- # When accessing this endpoint through ORY Kratos&#39; Public API, ensure that cookies are set as they are required for checking the auth session. To prevent scanning attacks, the public endpoint does not return 404 status codes but instead 403 or 500. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
422
- # @param request [String] Request is the Request ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/verify?request&#x3D;abcde&#x60;).
970
+ # Initialize Login Flow for API clients
971
+ # This endpoint initiates a login flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter &#x60;?refresh&#x3D;true&#x60; is set. To fetch an existing login flow call &#x60;/self-service/login/flows?flow&#x3D;&lt;flow_id&gt;&#x60;. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks, including CSRF login attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
423
972
  # @param [Hash] opts the optional parameters
424
- # @return [Array<(VerificationRequest, Integer, Hash)>] VerificationRequest data, response status code and response headers
425
- def get_self_service_verification_request_with_http_info(request, opts = {})
973
+ # @option opts [Boolean] :refresh Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session.
974
+ # @return [Array<(LoginFlow, Integer, Hash)>] LoginFlow data, response status code and response headers
975
+ def initialize_self_service_login_via_api_flow_with_http_info(opts = {})
426
976
  if @api_client.config.debugging
427
- @api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_verification_request ...'
428
- end
429
- # verify the required parameter 'request' is set
430
- if @api_client.config.client_side_validation && request.nil?
431
- fail ArgumentError, "Missing the required parameter 'request' when calling PublicApi.get_self_service_verification_request"
977
+ @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_login_via_api_flow ...'
432
978
  end
433
979
  # resource path
434
- local_var_path = '/self-service/browser/flows/requests/verification'
980
+ local_var_path = '/self-service/login/api'
435
981
 
436
982
  # query parameters
437
983
  query_params = opts[:query_params] || {}
438
- query_params[:'request'] = request
984
+ query_params[:'refresh'] = opts[:'refresh'] if !opts[:'refresh'].nil?
439
985
 
440
986
  # header parameters
441
987
  header_params = opts[:header_params] || {}
@@ -449,7 +995,7 @@ module OryHydraClient
449
995
  post_body = opts[:body]
450
996
 
451
997
  # return_type
452
- return_type = opts[:return_type] || 'VerificationRequest'
998
+ return_type = opts[:return_type] || 'LoginFlow'
453
999
 
454
1000
  # auth_names
455
1001
  auth_names = opts[:auth_names] || []
@@ -465,30 +1011,30 @@ module OryHydraClient
465
1011
 
466
1012
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
467
1013
  if @api_client.config.debugging
468
- @api_client.config.logger.debug "API called: PublicApi#get_self_service_verification_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1014
+ @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_login_via_api_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
469
1015
  end
470
1016
  return data, status_code, headers
471
1017
  end
472
1018
 
473
- # Initialize browser-based login user flow
474
- # This endpoint initializes a browser-based user login flow. Once initialized, the browser will be redirected to `urls.login_ui` with the request ID set as a query parameter. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url`. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
1019
+ # Initialize Login Flow for browsers
1020
+ # This endpoint initializes a browser-based user login flow. Once initialized, the browser will be redirected to `selfservice.flows.login.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url` unless the query parameter `?refresh=true` was set. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
475
1021
  # @param [Hash] opts the optional parameters
476
1022
  # @return [nil]
477
- def initialize_self_service_browser_login_flow(opts = {})
478
- initialize_self_service_browser_login_flow_with_http_info(opts)
1023
+ def initialize_self_service_login_via_browser_flow(opts = {})
1024
+ initialize_self_service_login_via_browser_flow_with_http_info(opts)
479
1025
  nil
480
1026
  end
481
1027
 
482
- # Initialize browser-based login user flow
483
- # This endpoint initializes a browser-based user login flow. Once initialized, the browser will be redirected to &#x60;urls.login_ui&#x60; with the request ID set as a query parameter. If a valid user session exists already, the browser will be redirected to &#x60;urls.default_redirect_url&#x60;. &gt; This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
1028
+ # Initialize Login Flow for browsers
1029
+ # This endpoint initializes a browser-based user login flow. Once initialized, the browser will be redirected to &#x60;selfservice.flows.login.ui_url&#x60; with the flow ID set as the query parameter &#x60;?flow&#x3D;&#x60;. If a valid user session exists already, the browser will be redirected to &#x60;urls.default_redirect_url&#x60; unless the query parameter &#x60;?refresh&#x3D;true&#x60; was set. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
484
1030
  # @param [Hash] opts the optional parameters
485
1031
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
486
- def initialize_self_service_browser_login_flow_with_http_info(opts = {})
1032
+ def initialize_self_service_login_via_browser_flow_with_http_info(opts = {})
487
1033
  if @api_client.config.debugging
488
- @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_browser_login_flow ...'
1034
+ @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_login_via_browser_flow ...'
489
1035
  end
490
1036
  # resource path
491
- local_var_path = '/self-service/browser/flows/login'
1037
+ local_var_path = '/self-service/login/browser'
492
1038
 
493
1039
  # query parameters
494
1040
  query_params = opts[:query_params] || {}
@@ -521,30 +1067,86 @@ module OryHydraClient
521
1067
 
522
1068
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
523
1069
  if @api_client.config.debugging
524
- @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_browser_login_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1070
+ @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_login_via_browser_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
525
1071
  end
526
1072
  return data, status_code, headers
527
1073
  end
528
1074
 
529
- # Initialize Browser-Based Logout User Flow
530
- # This endpoint initializes a logout flow. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). On successful logout, the browser will be redirected (HTTP 302 Found) to `urls.default_return_to`. More information can be found at [ORY Kratos User Logout Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-logout).
1075
+ # Initialize Recovery Flow for API Clients
1076
+ # This endpoint initiates a recovery flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error. To fetch an existing recovery flow call `/self-service/recovery/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [ORY Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
1077
+ # @param [Hash] opts the optional parameters
1078
+ # @return [RecoveryFlow]
1079
+ def initialize_self_service_recovery_via_api_flow(opts = {})
1080
+ data, _status_code, _headers = initialize_self_service_recovery_via_api_flow_with_http_info(opts)
1081
+ data
1082
+ end
1083
+
1084
+ # Initialize Recovery Flow for API Clients
1085
+ # This endpoint initiates a recovery flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error. To fetch an existing recovery flow call &#x60;/self-service/recovery/flows?flow&#x3D;&lt;flow_id&gt;&#x60;. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [ORY Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
1086
+ # @param [Hash] opts the optional parameters
1087
+ # @return [Array<(RecoveryFlow, Integer, Hash)>] RecoveryFlow data, response status code and response headers
1088
+ def initialize_self_service_recovery_via_api_flow_with_http_info(opts = {})
1089
+ if @api_client.config.debugging
1090
+ @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_recovery_via_api_flow ...'
1091
+ end
1092
+ # resource path
1093
+ local_var_path = '/self-service/recovery/api'
1094
+
1095
+ # query parameters
1096
+ query_params = opts[:query_params] || {}
1097
+
1098
+ # header parameters
1099
+ header_params = opts[:header_params] || {}
1100
+ # HTTP header 'Accept' (if needed)
1101
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1102
+
1103
+ # form parameters
1104
+ form_params = opts[:form_params] || {}
1105
+
1106
+ # http body (model)
1107
+ post_body = opts[:body]
1108
+
1109
+ # return_type
1110
+ return_type = opts[:return_type] || 'RecoveryFlow'
1111
+
1112
+ # auth_names
1113
+ auth_names = opts[:auth_names] || []
1114
+
1115
+ new_options = opts.merge(
1116
+ :header_params => header_params,
1117
+ :query_params => query_params,
1118
+ :form_params => form_params,
1119
+ :body => post_body,
1120
+ :auth_names => auth_names,
1121
+ :return_type => return_type
1122
+ )
1123
+
1124
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1125
+ if @api_client.config.debugging
1126
+ @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_recovery_via_api_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1127
+ end
1128
+ return data, status_code, headers
1129
+ end
1130
+
1131
+ # Initialize Recovery Flow for Browser Clients
1132
+ # This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to `selfservice.flows.recovery.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists, the browser is returned to the configured return URL. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
531
1133
  # @param [Hash] opts the optional parameters
532
1134
  # @return [nil]
533
- def initialize_self_service_browser_logout_flow(opts = {})
534
- initialize_self_service_browser_logout_flow_with_http_info(opts)
1135
+ def initialize_self_service_recovery_via_browser_flow(opts = {})
1136
+ initialize_self_service_recovery_via_browser_flow_with_http_info(opts)
535
1137
  nil
536
1138
  end
537
1139
 
538
- # Initialize Browser-Based Logout User Flow
539
- # This endpoint initializes a logout flow. &gt; This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). On successful logout, the browser will be redirected (HTTP 302 Found) to &#x60;urls.default_return_to&#x60;. More information can be found at [ORY Kratos User Logout Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-logout).
1140
+ # Initialize Recovery Flow for Browser Clients
1141
+ # This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to &#x60;selfservice.flows.recovery.ui_url&#x60; with the flow ID set as the query parameter &#x60;?flow&#x3D;&#x60;. If a valid user session exists, the browser is returned to the configured return URL. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
540
1142
  # @param [Hash] opts the optional parameters
541
1143
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
542
- def initialize_self_service_browser_logout_flow_with_http_info(opts = {})
1144
+ def initialize_self_service_recovery_via_browser_flow_with_http_info(opts = {})
543
1145
  if @api_client.config.debugging
544
- @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_browser_logout_flow ...'
1146
+ @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_recovery_via_browser_flow ...'
545
1147
  end
546
1148
  # resource path
547
- local_var_path = '/self-service/browser/flows/logout'
1149
+ local_var_path = '/self-service/recovery/browser'
548
1150
 
549
1151
  # query parameters
550
1152
  query_params = opts[:query_params] || {}
@@ -577,30 +1179,86 @@ module OryHydraClient
577
1179
 
578
1180
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
579
1181
  if @api_client.config.debugging
580
- @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_browser_logout_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1182
+ @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_recovery_via_browser_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1183
+ end
1184
+ return data, status_code, headers
1185
+ end
1186
+
1187
+ # Initialize Registration Flow for API clients
1188
+ # This endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing registration flow call `/self-service/registration/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
1189
+ # @param [Hash] opts the optional parameters
1190
+ # @return [RegistrationFlow]
1191
+ def initialize_self_service_registration_via_api_flow(opts = {})
1192
+ data, _status_code, _headers = initialize_self_service_registration_via_api_flow_with_http_info(opts)
1193
+ data
1194
+ end
1195
+
1196
+ # Initialize Registration Flow for API clients
1197
+ # This endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter &#x60;?refresh&#x3D;true&#x60; is set. To fetch an existing registration flow call &#x60;/self-service/registration/flows?flow&#x3D;&lt;flow_id&gt;&#x60;. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
1198
+ # @param [Hash] opts the optional parameters
1199
+ # @return [Array<(RegistrationFlow, Integer, Hash)>] RegistrationFlow data, response status code and response headers
1200
+ def initialize_self_service_registration_via_api_flow_with_http_info(opts = {})
1201
+ if @api_client.config.debugging
1202
+ @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_registration_via_api_flow ...'
1203
+ end
1204
+ # resource path
1205
+ local_var_path = '/self-service/registration/api'
1206
+
1207
+ # query parameters
1208
+ query_params = opts[:query_params] || {}
1209
+
1210
+ # header parameters
1211
+ header_params = opts[:header_params] || {}
1212
+ # HTTP header 'Accept' (if needed)
1213
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1214
+
1215
+ # form parameters
1216
+ form_params = opts[:form_params] || {}
1217
+
1218
+ # http body (model)
1219
+ post_body = opts[:body]
1220
+
1221
+ # return_type
1222
+ return_type = opts[:return_type] || 'RegistrationFlow'
1223
+
1224
+ # auth_names
1225
+ auth_names = opts[:auth_names] || []
1226
+
1227
+ new_options = opts.merge(
1228
+ :header_params => header_params,
1229
+ :query_params => query_params,
1230
+ :form_params => form_params,
1231
+ :body => post_body,
1232
+ :auth_names => auth_names,
1233
+ :return_type => return_type
1234
+ )
1235
+
1236
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1237
+ if @api_client.config.debugging
1238
+ @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_registration_via_api_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
581
1239
  end
582
1240
  return data, status_code, headers
583
1241
  end
584
1242
 
585
- # Initialize browser-based registration user flow
586
- # This endpoint initializes a browser-based user registration flow. Once initialized, the browser will be redirected to `urls.registration_ui` with the request ID set as a query parameter. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url`. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
1243
+ # Initialize Registration Flow for browsers
1244
+ # This endpoint initializes a browser-based user registration flow. Once initialized, the browser will be redirected to `selfservice.flows.registration.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url` unless the query parameter `?refresh=true` was set. :::note This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). ::: More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
587
1245
  # @param [Hash] opts the optional parameters
588
1246
  # @return [nil]
589
- def initialize_self_service_browser_registration_flow(opts = {})
590
- initialize_self_service_browser_registration_flow_with_http_info(opts)
1247
+ def initialize_self_service_registration_via_browser_flow(opts = {})
1248
+ initialize_self_service_registration_via_browser_flow_with_http_info(opts)
591
1249
  nil
592
1250
  end
593
1251
 
594
- # Initialize browser-based registration user flow
595
- # This endpoint initializes a browser-based user registration flow. Once initialized, the browser will be redirected to &#x60;urls.registration_ui&#x60; with the request ID set as a query parameter. If a valid user session exists already, the browser will be redirected to &#x60;urls.default_redirect_url&#x60;. &gt; This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
1252
+ # Initialize Registration Flow for browsers
1253
+ # This endpoint initializes a browser-based user registration flow. Once initialized, the browser will be redirected to &#x60;selfservice.flows.registration.ui_url&#x60; with the flow ID set as the query parameter &#x60;?flow&#x3D;&#x60;. If a valid user session exists already, the browser will be redirected to &#x60;urls.default_redirect_url&#x60; unless the query parameter &#x60;?refresh&#x3D;true&#x60; was set. :::note This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). ::: More information can be found at [ORY Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
596
1254
  # @param [Hash] opts the optional parameters
597
1255
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
598
- def initialize_self_service_browser_registration_flow_with_http_info(opts = {})
1256
+ def initialize_self_service_registration_via_browser_flow_with_http_info(opts = {})
599
1257
  if @api_client.config.debugging
600
- @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_browser_registration_flow ...'
1258
+ @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_registration_via_browser_flow ...'
601
1259
  end
602
1260
  # resource path
603
- local_var_path = '/self-service/browser/flows/registration'
1261
+ local_var_path = '/self-service/registration/browser'
604
1262
 
605
1263
  # query parameters
606
1264
  query_params = opts[:query_params] || {}
@@ -633,36 +1291,86 @@ module OryHydraClient
633
1291
 
634
1292
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
635
1293
  if @api_client.config.debugging
636
- @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_browser_registration_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1294
+ @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_registration_via_browser_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1295
+ end
1296
+ return data, status_code, headers
1297
+ end
1298
+
1299
+ # Initialize Settings Flow for API Clients
1300
+ # This endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on. You must provide a valid ORY Kratos Session Token for this endpoint to respond with HTTP 200 OK. To fetch an existing settings flow call `/self-service/settings/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
1301
+ # @param [Hash] opts the optional parameters
1302
+ # @return [SettingsFlow]
1303
+ def initialize_self_service_settings_via_api_flow(opts = {})
1304
+ data, _status_code, _headers = initialize_self_service_settings_via_api_flow_with_http_info(opts)
1305
+ data
1306
+ end
1307
+
1308
+ # Initialize Settings Flow for API Clients
1309
+ # This endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on. You must provide a valid ORY Kratos Session Token for this endpoint to respond with HTTP 200 OK. To fetch an existing settings flow call &#x60;/self-service/settings/flows?flow&#x3D;&lt;flow_id&gt;&#x60;. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [ORY Kratos User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
1310
+ # @param [Hash] opts the optional parameters
1311
+ # @return [Array<(SettingsFlow, Integer, Hash)>] SettingsFlow data, response status code and response headers
1312
+ def initialize_self_service_settings_via_api_flow_with_http_info(opts = {})
1313
+ if @api_client.config.debugging
1314
+ @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_settings_via_api_flow ...'
1315
+ end
1316
+ # resource path
1317
+ local_var_path = '/self-service/settings/api'
1318
+
1319
+ # query parameters
1320
+ query_params = opts[:query_params] || {}
1321
+
1322
+ # header parameters
1323
+ header_params = opts[:header_params] || {}
1324
+ # HTTP header 'Accept' (if needed)
1325
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1326
+
1327
+ # form parameters
1328
+ form_params = opts[:form_params] || {}
1329
+
1330
+ # http body (model)
1331
+ post_body = opts[:body]
1332
+
1333
+ # return_type
1334
+ return_type = opts[:return_type] || 'SettingsFlow'
1335
+
1336
+ # auth_names
1337
+ auth_names = opts[:auth_names] || ['sessionToken']
1338
+
1339
+ new_options = opts.merge(
1340
+ :header_params => header_params,
1341
+ :query_params => query_params,
1342
+ :form_params => form_params,
1343
+ :body => post_body,
1344
+ :auth_names => auth_names,
1345
+ :return_type => return_type
1346
+ )
1347
+
1348
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1349
+ if @api_client.config.debugging
1350
+ @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_settings_via_api_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
637
1351
  end
638
1352
  return data, status_code, headers
639
1353
  end
640
1354
 
641
- # Initialize browser-based verification flow
642
- # This endpoint initializes a browser-based profile management flow. Once initialized, the browser will be redirected to `urls.profile_ui` with the request ID set as a query parameter. If no valid user session exists, a login flow will be initialized. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
643
- # @param via [String] What to verify Currently only \&quot;email\&quot; is supported.
1355
+ # Initialize Settings Flow for Browsers
1356
+ # This endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid ORY Kratos Session Cookie is included in the request, a login flow will be initialized. :::note This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). ::: More information can be found at [ORY Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
644
1357
  # @param [Hash] opts the optional parameters
645
1358
  # @return [nil]
646
- def initialize_self_service_browser_verification_flow(via, opts = {})
647
- initialize_self_service_browser_verification_flow_with_http_info(via, opts)
1359
+ def initialize_self_service_settings_via_browser_flow(opts = {})
1360
+ initialize_self_service_settings_via_browser_flow_with_http_info(opts)
648
1361
  nil
649
1362
  end
650
1363
 
651
- # Initialize browser-based verification flow
652
- # This endpoint initializes a browser-based profile management flow. Once initialized, the browser will be redirected to &#x60;urls.profile_ui&#x60; with the request ID set as a query parameter. If no valid user session exists, a login flow will be initialized. &gt; This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
653
- # @param via [String] What to verify Currently only \&quot;email\&quot; is supported.
1364
+ # Initialize Settings Flow for Browsers
1365
+ # This endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to &#x60;selfservice.flows.settings.ui_url&#x60; with the flow ID set as the query parameter &#x60;?flow&#x3D;&#x60;. If no valid ORY Kratos Session Cookie is included in the request, a login flow will be initialized. :::note This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). ::: More information can be found at [ORY Kratos User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
654
1366
  # @param [Hash] opts the optional parameters
655
1367
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
656
- def initialize_self_service_browser_verification_flow_with_http_info(via, opts = {})
1368
+ def initialize_self_service_settings_via_browser_flow_with_http_info(opts = {})
657
1369
  if @api_client.config.debugging
658
- @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_browser_verification_flow ...'
659
- end
660
- # verify the required parameter 'via' is set
661
- if @api_client.config.client_side_validation && via.nil?
662
- fail ArgumentError, "Missing the required parameter 'via' when calling PublicApi.initialize_self_service_browser_verification_flow"
1370
+ @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_settings_via_browser_flow ...'
663
1371
  end
664
1372
  # resource path
665
- local_var_path = '/self-service/browser/flows/verification/init/{via}'.sub('{' + 'via' + '}', CGI.escape(via.to_s))
1373
+ local_var_path = '/self-service/settings/browser/flows'
666
1374
 
667
1375
  # query parameters
668
1376
  query_params = opts[:query_params] || {}
@@ -681,6 +1389,62 @@ module OryHydraClient
681
1389
  # return_type
682
1390
  return_type = opts[:return_type]
683
1391
 
1392
+ # auth_names
1393
+ auth_names = opts[:auth_names] || ['sessionToken']
1394
+
1395
+ new_options = opts.merge(
1396
+ :header_params => header_params,
1397
+ :query_params => query_params,
1398
+ :form_params => form_params,
1399
+ :body => post_body,
1400
+ :auth_names => auth_names,
1401
+ :return_type => return_type
1402
+ )
1403
+
1404
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1405
+ if @api_client.config.debugging
1406
+ @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_settings_via_browser_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1407
+ end
1408
+ return data, status_code, headers
1409
+ end
1410
+
1411
+ # Initialize Verification Flow for API Clients
1412
+ # This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. To fetch an existing verification flow call `/self-service/verification/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
1413
+ # @param [Hash] opts the optional parameters
1414
+ # @return [VerificationFlow]
1415
+ def initialize_self_service_verification_via_api_flow(opts = {})
1416
+ data, _status_code, _headers = initialize_self_service_verification_via_api_flow_with_http_info(opts)
1417
+ data
1418
+ end
1419
+
1420
+ # Initialize Verification Flow for API Clients
1421
+ # This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. To fetch an existing verification flow call &#x60;/self-service/verification/flows?flow&#x3D;&lt;flow_id&gt;&#x60;. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
1422
+ # @param [Hash] opts the optional parameters
1423
+ # @return [Array<(VerificationFlow, Integer, Hash)>] VerificationFlow data, response status code and response headers
1424
+ def initialize_self_service_verification_via_api_flow_with_http_info(opts = {})
1425
+ if @api_client.config.debugging
1426
+ @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_verification_via_api_flow ...'
1427
+ end
1428
+ # resource path
1429
+ local_var_path = '/self-service/verification/api'
1430
+
1431
+ # query parameters
1432
+ query_params = opts[:query_params] || {}
1433
+
1434
+ # header parameters
1435
+ header_params = opts[:header_params] || {}
1436
+ # HTTP header 'Accept' (if needed)
1437
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1438
+
1439
+ # form parameters
1440
+ form_params = opts[:form_params] || {}
1441
+
1442
+ # http body (model)
1443
+ post_body = opts[:body]
1444
+
1445
+ # return_type
1446
+ return_type = opts[:return_type] || 'VerificationFlow'
1447
+
684
1448
  # auth_names
685
1449
  auth_names = opts[:auth_names] || []
686
1450
 
@@ -695,30 +1459,30 @@ module OryHydraClient
695
1459
 
696
1460
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
697
1461
  if @api_client.config.debugging
698
- @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_browser_verification_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1462
+ @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_verification_via_api_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
699
1463
  end
700
1464
  return data, status_code, headers
701
1465
  end
702
1466
 
703
- # Initialize browser-based profile management flow
704
- # This endpoint initializes a browser-based profile management flow. Once initialized, the browser will be redirected to `urls.profile_ui` with the request ID set as a query parameter. If no valid user session exists, a login flow will be initialized. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos Profile Management Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-profile-management).
1467
+ # Initialize Verification Flow for Browser Clients
1468
+ # This endpoint initializes a browser-based account verification flow. Once initialized, the browser will be redirected to `selfservice.flows.verification.ui_url` with the flow ID set as the query parameter `?flow=`. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
705
1469
  # @param [Hash] opts the optional parameters
706
1470
  # @return [nil]
707
- def initialize_self_service_profile_management_flow(opts = {})
708
- initialize_self_service_profile_management_flow_with_http_info(opts)
1471
+ def initialize_self_service_verification_via_browser_flow(opts = {})
1472
+ initialize_self_service_verification_via_browser_flow_with_http_info(opts)
709
1473
  nil
710
1474
  end
711
1475
 
712
- # Initialize browser-based profile management flow
713
- # This endpoint initializes a browser-based profile management flow. Once initialized, the browser will be redirected to &#x60;urls.profile_ui&#x60; with the request ID set as a query parameter. If no valid user session exists, a login flow will be initialized. &gt; This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos Profile Management Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-profile-management).
1476
+ # Initialize Verification Flow for Browser Clients
1477
+ # This endpoint initializes a browser-based account verification flow. Once initialized, the browser will be redirected to &#x60;selfservice.flows.verification.ui_url&#x60; with the flow ID set as the query parameter &#x60;?flow&#x3D;&#x60;. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
714
1478
  # @param [Hash] opts the optional parameters
715
1479
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
716
- def initialize_self_service_profile_management_flow_with_http_info(opts = {})
1480
+ def initialize_self_service_verification_via_browser_flow_with_http_info(opts = {})
717
1481
  if @api_client.config.debugging
718
- @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_profile_management_flow ...'
1482
+ @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_verification_via_browser_flow ...'
719
1483
  end
720
1484
  # resource path
721
- local_var_path = '/self-service/browser/flows/profile'
1485
+ local_var_path = '/self-service/verification/browser'
722
1486
 
723
1487
  # query parameters
724
1488
  query_params = opts[:query_params] || {}
@@ -751,42 +1515,36 @@ module OryHydraClient
751
1515
 
752
1516
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
753
1517
  if @api_client.config.debugging
754
- @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_profile_management_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1518
+ @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_verification_via_browser_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
755
1519
  end
756
1520
  return data, status_code, headers
757
1521
  end
758
1522
 
759
- # Complete the browser-based verification flows
760
- # This endpoint completes a browser-based verification flow. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
761
- # @param code [String]
762
- # @param via [String] What to verify Currently only \&quot;email\&quot; is supported.
1523
+ # Revoke and Invalidate a Session
1524
+ # Use this endpoint to revoke a session using its token. This endpoint is particularly useful for API clients such as mobile apps to log the user out of the system and invalidate the session. This endpoint does not remove any HTTP Cookies - use the Self-Service Logout Flow instead.
1525
+ # @param body [RevokeSession]
763
1526
  # @param [Hash] opts the optional parameters
764
1527
  # @return [nil]
765
- def self_service_browser_verify(code, via, opts = {})
766
- self_service_browser_verify_with_http_info(code, via, opts)
1528
+ def revoke_session(body, opts = {})
1529
+ revoke_session_with_http_info(body, opts)
767
1530
  nil
768
1531
  end
769
1532
 
770
- # Complete the browser-based verification flows
771
- # This endpoint completes a browser-based verification flow. &gt; This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...) and HTML Forms. More information can be found at [ORY Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
772
- # @param code [String]
773
- # @param via [String] What to verify Currently only \&quot;email\&quot; is supported.
1533
+ # Revoke and Invalidate a Session
1534
+ # Use this endpoint to revoke a session using its token. This endpoint is particularly useful for API clients such as mobile apps to log the user out of the system and invalidate the session. This endpoint does not remove any HTTP Cookies - use the Self-Service Logout Flow instead.
1535
+ # @param body [RevokeSession]
774
1536
  # @param [Hash] opts the optional parameters
775
1537
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
776
- def self_service_browser_verify_with_http_info(code, via, opts = {})
1538
+ def revoke_session_with_http_info(body, opts = {})
777
1539
  if @api_client.config.debugging
778
- @api_client.config.logger.debug 'Calling API: PublicApi.self_service_browser_verify ...'
1540
+ @api_client.config.logger.debug 'Calling API: PublicApi.revoke_session ...'
779
1541
  end
780
- # verify the required parameter 'code' is set
781
- if @api_client.config.client_side_validation && code.nil?
782
- fail ArgumentError, "Missing the required parameter 'code' when calling PublicApi.self_service_browser_verify"
783
- end
784
- # verify the required parameter 'via' is set
785
- if @api_client.config.client_side_validation && via.nil?
786
- fail ArgumentError, "Missing the required parameter 'via' when calling PublicApi.self_service_browser_verify"
1542
+ # verify the required parameter 'body' is set
1543
+ if @api_client.config.client_side_validation && body.nil?
1544
+ fail ArgumentError, "Missing the required parameter 'body' when calling PublicApi.revoke_session"
787
1545
  end
788
1546
  # resource path
789
- local_var_path = '/self-service/browser/flows/verification/{via}/confirm/{code}'.sub('{' + 'code' + '}', CGI.escape(code.to_s)).sub('{' + 'via' + '}', CGI.escape(via.to_s))
1547
+ local_var_path = '/sessions'
790
1548
 
791
1549
  # query parameters
792
1550
  query_params = opts[:query_params] || {}
@@ -795,12 +1553,14 @@ module OryHydraClient
795
1553
  header_params = opts[:header_params] || {}
796
1554
  # HTTP header 'Accept' (if needed)
797
1555
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1556
+ # HTTP header 'Content-Type'
1557
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
798
1558
 
799
1559
  # form parameters
800
1560
  form_params = opts[:form_params] || {}
801
1561
 
802
1562
  # http body (model)
803
- post_body = opts[:body]
1563
+ post_body = opts[:body] || @api_client.object_to_http_body(body)
804
1564
 
805
1565
  # return_type
806
1566
  return_type = opts[:return_type]
@@ -817,25 +1577,29 @@ module OryHydraClient
817
1577
  :return_type => return_type
818
1578
  )
819
1579
 
820
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1580
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
821
1581
  if @api_client.config.debugging
822
- @api_client.config.logger.debug "API called: PublicApi#self_service_browser_verify\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1582
+ @api_client.config.logger.debug "API called: PublicApi#revoke_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
823
1583
  end
824
1584
  return data, status_code, headers
825
1585
  end
826
1586
 
827
- # Check who the current HTTP session belongs to
828
- # Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object or 401 if the credentials are invalid or no credentials were sent. This endpoint is useful for reverse proxies and API Gateways.
1587
+ # Check Who the Current HTTP Session Belongs To
1588
+ # Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object in the body or 401 if the credentials are invalid or no credentials were sent. Additionally when the request it successful it adds the user ID to the 'X-Kratos-Authenticated-Identity-Id' header in the response. This endpoint is useful for reverse proxies and API Gateways.
829
1589
  # @param [Hash] opts the optional parameters
1590
+ # @option opts [String] :cookie
1591
+ # @option opts [String] :authorization in: authorization
830
1592
  # @return [Session]
831
1593
  def whoami(opts = {})
832
1594
  data, _status_code, _headers = whoami_with_http_info(opts)
833
1595
  data
834
1596
  end
835
1597
 
836
- # Check who the current HTTP session belongs to
837
- # Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object or 401 if the credentials are invalid or no credentials were sent. This endpoint is useful for reverse proxies and API Gateways.
1598
+ # Check Who the Current HTTP Session Belongs To
1599
+ # Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object in the body or 401 if the credentials are invalid or no credentials were sent. Additionally when the request it successful it adds the user ID to the &#39;X-Kratos-Authenticated-Identity-Id&#39; header in the response. This endpoint is useful for reverse proxies and API Gateways.
838
1600
  # @param [Hash] opts the optional parameters
1601
+ # @option opts [String] :cookie
1602
+ # @option opts [String] :authorization in: authorization
839
1603
  # @return [Array<(Session, Integer, Hash)>] Session data, response status code and response headers
840
1604
  def whoami_with_http_info(opts = {})
841
1605
  if @api_client.config.debugging
@@ -846,11 +1610,13 @@ module OryHydraClient
846
1610
 
847
1611
  # query parameters
848
1612
  query_params = opts[:query_params] || {}
1613
+ query_params[:'Authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
849
1614
 
850
1615
  # header parameters
851
1616
  header_params = opts[:header_params] || {}
852
1617
  # HTTP header 'Accept' (if needed)
853
1618
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1619
+ header_params[:'Cookie'] = opts[:'cookie'] if !opts[:'cookie'].nil?
854
1620
 
855
1621
  # form parameters
856
1622
  form_params = opts[:form_params] || {}
@@ -862,7 +1628,7 @@ module OryHydraClient
862
1628
  return_type = opts[:return_type] || 'Session'
863
1629
 
864
1630
  # auth_names
865
- auth_names = opts[:auth_names] || []
1631
+ auth_names = opts[:auth_names] || ['sessionToken']
866
1632
 
867
1633
  new_options = opts.merge(
868
1634
  :header_params => header_params,