ory-kratos-client 0.1.0.alpha6 → 0.4.6.alpha1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (73) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/README.md +31 -15
  4. data/docs/AdminApi.md +111 -16
  5. data/docs/CommonApi.md +111 -16
  6. data/docs/CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload.md +19 -0
  7. data/docs/Form.md +3 -3
  8. data/docs/FormField.md +8 -8
  9. data/docs/GenericErrorPayload.md +1 -1
  10. data/docs/Identity.md +9 -7
  11. data/docs/LoginRequest.md +4 -0
  12. data/docs/LoginRequestMethodConfig.md +3 -3
  13. data/docs/Message.md +23 -0
  14. data/docs/ProviderCredentialsConfig.md +19 -0
  15. data/docs/PublicApi.md +327 -50
  16. data/docs/RecoveryAddress.md +21 -0
  17. data/docs/RecoveryRequest.md +31 -0
  18. data/docs/RecoveryRequestMethod.md +19 -0
  19. data/docs/RegistrationRequest.md +3 -1
  20. data/docs/RegistrationRequestMethodConfig.md +3 -3
  21. data/docs/RequestMethodConfig.md +23 -0
  22. data/docs/SettingsRequest.md +33 -0
  23. data/docs/SettingsRequestMethod.md +19 -0
  24. data/docs/VerifiableAddress.md +1 -1
  25. data/docs/VerificationRequest.md +3 -1
  26. data/lib/ory-kratos-client.rb +11 -5
  27. data/lib/ory-kratos-client/api/admin_api.rb +150 -27
  28. data/lib/ory-kratos-client/api/common_api.rb +150 -27
  29. data/lib/ory-kratos-client/api/health_api.rb +2 -2
  30. data/lib/ory-kratos-client/api/public_api.rb +433 -71
  31. data/lib/ory-kratos-client/api/version_api.rb +2 -2
  32. data/lib/ory-kratos-client/api_client.rb +9 -7
  33. data/lib/ory-kratos-client/api_error.rb +2 -2
  34. data/lib/ory-kratos-client/configuration.rb +2 -2
  35. data/lib/ory-kratos-client/models/complete_self_service_browser_settings_strategy_profile_flow_payload.rb +222 -0
  36. data/lib/ory-kratos-client/models/error_container.rb +2 -2
  37. data/lib/ory-kratos-client/models/form.rb +15 -16
  38. data/lib/ory-kratos-client/models/form_field.rb +16 -22
  39. data/lib/ory-kratos-client/models/generic_error.rb +2 -2
  40. data/lib/ory-kratos-client/models/generic_error_payload.rb +4 -7
  41. data/lib/ory-kratos-client/models/health_not_ready_status.rb +2 -2
  42. data/lib/ory-kratos-client/models/health_status.rb +2 -2
  43. data/lib/ory-kratos-client/models/identity.rb +48 -35
  44. data/lib/ory-kratos-client/models/login_request.rb +24 -3
  45. data/lib/ory-kratos-client/models/login_request_method.rb +2 -2
  46. data/lib/ory-kratos-client/models/login_request_method_config.rb +15 -16
  47. data/lib/ory-kratos-client/models/message.rb +233 -0
  48. data/lib/ory-kratos-client/models/provider_credentials_config.rb +215 -0
  49. data/lib/ory-kratos-client/models/recovery_address.rb +239 -0
  50. data/lib/ory-kratos-client/models/recovery_request.rb +309 -0
  51. data/lib/ory-kratos-client/models/recovery_request_method.rb +216 -0
  52. data/lib/ory-kratos-client/models/registration_request.rb +14 -8
  53. data/lib/ory-kratos-client/models/registration_request_method.rb +2 -2
  54. data/lib/ory-kratos-client/models/registration_request_method_config.rb +15 -16
  55. data/lib/ory-kratos-client/models/request_method_config.rb +255 -0
  56. data/lib/ory-kratos-client/models/session.rb +2 -2
  57. data/lib/ory-kratos-client/models/settings_request.rb +323 -0
  58. data/lib/ory-kratos-client/models/settings_request_method.rb +216 -0
  59. data/lib/ory-kratos-client/models/verifiable_address.rb +2 -7
  60. data/lib/ory-kratos-client/models/verification_request.rb +15 -4
  61. data/lib/ory-kratos-client/models/version.rb +2 -2
  62. data/lib/ory-kratos-client/version.rb +3 -3
  63. data/ory-kratos-client.gemspec +2 -2
  64. data/spec/models/complete_self_service_browser_settings_strategy_profile_flow_payload_spec.rb +47 -0
  65. data/spec/models/message_spec.rb +59 -0
  66. data/spec/models/provider_credentials_config_spec.rb +47 -0
  67. data/spec/models/recovery_address_spec.rb +53 -0
  68. data/spec/models/recovery_request_method_spec.rb +47 -0
  69. data/spec/models/recovery_request_spec.rb +83 -0
  70. data/spec/models/request_method_config_spec.rb +59 -0
  71. data/spec/models/settings_request_method_spec.rb +47 -0
  72. data/spec/models/settings_request_spec.rb +83 -0
  73. metadata +55 -19
@@ -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.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
 
@@ -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,37 +19,205 @@ 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).
22
+ # Complete the browser-based recovery flow using a recovery link
23
+ # > 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 Account Recovery Documentation](../self-service/flows/password-reset-account-recovery).
24
+ # @param [Hash] opts the optional parameters
25
+ # @return [nil]
26
+ def complete_self_service_browser_recovery_link_strategy_flow(opts = {})
27
+ complete_self_service_browser_recovery_link_strategy_flow_with_http_info(opts)
28
+ nil
29
+ end
30
+
31
+ # Complete the browser-based recovery flow using a recovery link
32
+ # &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 Account Recovery Documentation](../self-service/flows/password-reset-account-recovery).
33
+ # @param [Hash] opts the optional parameters
34
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
35
+ def complete_self_service_browser_recovery_link_strategy_flow_with_http_info(opts = {})
36
+ if @api_client.config.debugging
37
+ @api_client.config.logger.debug 'Calling API: PublicApi.complete_self_service_browser_recovery_link_strategy_flow ...'
38
+ end
39
+ # resource path
40
+ local_var_path = '/self-service/browser/flows/recovery/link'
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_recovery_link_strategy_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
74
+ end
75
+ return data, status_code, headers
76
+ end
77
+
78
+ # Complete the browser-based settings flow for the OpenID Connect strategy
79
+ # 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).
80
+ # @param [Hash] opts the optional parameters
81
+ # @return [nil]
82
+ def complete_self_service_browser_settings_oidc_settings_flow(opts = {})
83
+ complete_self_service_browser_settings_oidc_settings_flow_with_http_info(opts)
84
+ nil
85
+ end
86
+
87
+ # Complete the browser-based settings flow for the OpenID Connect strategy
88
+ # 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).
89
+ # @param [Hash] opts the optional parameters
90
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
91
+ def complete_self_service_browser_settings_oidc_settings_flow_with_http_info(opts = {})
92
+ if @api_client.config.debugging
93
+ @api_client.config.logger.debug 'Calling API: PublicApi.complete_self_service_browser_settings_oidc_settings_flow ...'
94
+ end
95
+ # resource path
96
+ local_var_path = '/self-service/browser/flows/registration/strategies/oidc/settings/connections'
97
+
98
+ # query parameters
99
+ query_params = opts[:query_params] || {}
100
+
101
+ # header parameters
102
+ header_params = opts[:header_params] || {}
103
+ # HTTP header 'Accept' (if needed)
104
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
105
+
106
+ # form parameters
107
+ form_params = opts[:form_params] || {}
108
+
109
+ # http body (model)
110
+ post_body = opts[:body]
111
+
112
+ # return_type
113
+ return_type = opts[:return_type]
114
+
115
+ # auth_names
116
+ auth_names = opts[:auth_names] || []
117
+
118
+ new_options = opts.merge(
119
+ :header_params => header_params,
120
+ :query_params => query_params,
121
+ :form_params => form_params,
122
+ :body => post_body,
123
+ :auth_names => auth_names,
124
+ :return_type => return_type
125
+ )
126
+
127
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
128
+ if @api_client.config.debugging
129
+ @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}"
130
+ end
131
+ return data, status_code, headers
132
+ end
133
+
134
+ # Complete the browser-based settings flow for the password strategy
135
+ # 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).
136
+ # @param [Hash] opts the optional parameters
137
+ # @return [nil]
138
+ def complete_self_service_browser_settings_password_strategy_flow(opts = {})
139
+ complete_self_service_browser_settings_password_strategy_flow_with_http_info(opts)
140
+ nil
141
+ end
142
+
143
+ # Complete the browser-based settings flow for the password strategy
144
+ # 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).
145
+ # @param [Hash] opts the optional parameters
146
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
147
+ def complete_self_service_browser_settings_password_strategy_flow_with_http_info(opts = {})
148
+ if @api_client.config.debugging
149
+ @api_client.config.logger.debug 'Calling API: PublicApi.complete_self_service_browser_settings_password_strategy_flow ...'
150
+ end
151
+ # resource path
152
+ local_var_path = '/self-service/browser/flows/settings/strategies/password'
153
+
154
+ # query parameters
155
+ query_params = opts[:query_params] || {}
156
+
157
+ # header parameters
158
+ header_params = opts[:header_params] || {}
159
+ # HTTP header 'Accept' (if needed)
160
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
161
+
162
+ # form parameters
163
+ form_params = opts[:form_params] || {}
164
+
165
+ # http body (model)
166
+ post_body = opts[:body]
167
+
168
+ # return_type
169
+ return_type = opts[:return_type]
170
+
171
+ # auth_names
172
+ auth_names = opts[:auth_names] || []
173
+
174
+ new_options = opts.merge(
175
+ :header_params => header_params,
176
+ :query_params => query_params,
177
+ :form_params => form_params,
178
+ :body => post_body,
179
+ :auth_names => auth_names,
180
+ :return_type => return_type
181
+ )
182
+
183
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
184
+ if @api_client.config.debugging
185
+ @api_client.config.logger.debug "API called: PublicApi#complete_self_service_browser_settings_password_strategy_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
186
+ end
187
+ return data, status_code, headers
188
+ end
189
+
190
+ # Complete the browser-based settings flow for profile data
191
+ # This endpoint completes a browser-based settings 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.settings_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 User Settings & Profile Management Documentation](../self-service/flows/user-settings).
24
192
  # @param request [String] Request is the request ID.
25
- # @param body [CompleteSelfServiceBrowserProfileManagementFlowPayload]
193
+ # @param body [CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload]
26
194
  # @param [Hash] opts the optional parameters
27
195
  # @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)
196
+ def complete_self_service_browser_settings_profile_strategy_flow(request, body, opts = {})
197
+ complete_self_service_browser_settings_profile_strategy_flow_with_http_info(request, body, opts)
30
198
  nil
31
199
  end
32
200
 
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).
201
+ # Complete the browser-based settings flow for profile data
202
+ # This endpoint completes a browser-based settings 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.settings_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 User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
35
203
  # @param request [String] Request is the request ID.
36
- # @param body [CompleteSelfServiceBrowserProfileManagementFlowPayload]
204
+ # @param body [CompleteSelfServiceBrowserSettingsStrategyProfileFlowPayload]
37
205
  # @param [Hash] opts the optional parameters
38
206
  # @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 = {})
207
+ def complete_self_service_browser_settings_profile_strategy_flow_with_http_info(request, body, opts = {})
40
208
  if @api_client.config.debugging
41
- @api_client.config.logger.debug 'Calling API: PublicApi.complete_self_service_browser_profile_management_flow ...'
209
+ @api_client.config.logger.debug 'Calling API: PublicApi.complete_self_service_browser_settings_profile_strategy_flow ...'
42
210
  end
43
211
  # verify the required parameter 'request' is set
44
212
  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"
213
+ fail ArgumentError, "Missing the required parameter 'request' when calling PublicApi.complete_self_service_browser_settings_profile_strategy_flow"
46
214
  end
47
215
  # verify the required parameter 'body' is set
48
216
  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"
217
+ fail ArgumentError, "Missing the required parameter 'body' when calling PublicApi.complete_self_service_browser_settings_profile_strategy_flow"
50
218
  end
51
219
  # resource path
52
- local_var_path = '/self-service/browser/flows/profile/update'
220
+ local_var_path = '/self-service/browser/flows/settings/strategies/profile'
53
221
 
54
222
  # query parameters
55
223
  query_params = opts[:query_params] || {}
@@ -85,27 +253,29 @@ module OryHydraClient
85
253
 
86
254
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
87
255
  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}"
256
+ @api_client.config.logger.debug "API called: PublicApi#complete_self_service_browser_settings_profile_strategy_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
89
257
  end
90
258
  return data, status_code, headers
91
259
  end
92
260
 
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).
261
+ # Complete the browser-based verification flows
262
+ # This endpoint completes a browser-based verification flow. This is usually achieved by POSTing data to this endpoint. If the provided data is valid against the Identity's Traits JSON Schema, the data will be updated and the browser redirected to `url.settings_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
263
  # @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;).
264
+ # @param via [String] What to verify Currently only \&quot;email\&quot; is supported.
96
265
  # @param [Hash] opts the optional parameters
97
266
  # @return [nil]
98
- def complete_self_service_browser_verification_flow(request, opts = {})
99
- complete_self_service_browser_verification_flow_with_http_info(request, opts)
267
+ def complete_self_service_browser_verification_flow(request, via, opts = {})
268
+ complete_self_service_browser_verification_flow_with_http_info(request, via, opts)
100
269
  nil
101
270
  end
102
271
 
103
- # Complete the browser-based profile management flows
104
- # 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).
272
+ # Complete the browser-based verification flows
273
+ # This endpoint completes a browser-based verification flow. This is usually achieved by POSTing data to this endpoint. If the provided data is valid against the Identity&#39;s Traits JSON Schema, the data will be updated and the browser redirected to &#x60;url.settings_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).
105
274
  # @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;).
275
+ # @param via [String] What to verify Currently only \&quot;email\&quot; is supported.
106
276
  # @param [Hash] opts the optional parameters
107
277
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
108
- def complete_self_service_browser_verification_flow_with_http_info(request, opts = {})
278
+ def complete_self_service_browser_verification_flow_with_http_info(request, via, opts = {})
109
279
  if @api_client.config.debugging
110
280
  @api_client.config.logger.debug 'Calling API: PublicApi.complete_self_service_browser_verification_flow ...'
111
281
  end
@@ -113,8 +283,12 @@ module OryHydraClient
113
283
  if @api_client.config.client_side_validation && request.nil?
114
284
  fail ArgumentError, "Missing the required parameter 'request' when calling PublicApi.complete_self_service_browser_verification_flow"
115
285
  end
286
+ # verify the required parameter 'via' is set
287
+ if @api_client.config.client_side_validation && via.nil?
288
+ fail ArgumentError, "Missing the required parameter 'via' when calling PublicApi.complete_self_service_browser_verification_flow"
289
+ end
116
290
  # resource path
117
- local_var_path = '/self-service/browser/flows/verification/complete'
291
+ local_var_path = '/self-service/browser/flows/verification/{via}/complete'.sub('{' + 'via' + '}', CGI.escape(via.to_s))
118
292
 
119
293
  # query parameters
120
294
  query_params = opts[:query_params] || {}
@@ -153,8 +327,68 @@ module OryHydraClient
153
327
  return data, status_code, headers
154
328
  end
155
329
 
330
+ # Get a traits schema definition
331
+ # @param id [String] ID must be set to the ID of schema you want to get
332
+ # @param [Hash] opts the optional parameters
333
+ # @return [Object]
334
+ def get_schema(id, opts = {})
335
+ data, _status_code, _headers = get_schema_with_http_info(id, opts)
336
+ data
337
+ end
338
+
339
+ # Get a traits schema definition
340
+ # @param id [String] ID must be set to the ID of schema you want to get
341
+ # @param [Hash] opts the optional parameters
342
+ # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
343
+ def get_schema_with_http_info(id, opts = {})
344
+ if @api_client.config.debugging
345
+ @api_client.config.logger.debug 'Calling API: PublicApi.get_schema ...'
346
+ end
347
+ # verify the required parameter 'id' is set
348
+ if @api_client.config.client_side_validation && id.nil?
349
+ fail ArgumentError, "Missing the required parameter 'id' when calling PublicApi.get_schema"
350
+ end
351
+ # resource path
352
+ local_var_path = '/schemas/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
353
+
354
+ # query parameters
355
+ query_params = opts[:query_params] || {}
356
+
357
+ # header parameters
358
+ header_params = opts[:header_params] || {}
359
+ # HTTP header 'Accept' (if needed)
360
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
361
+
362
+ # form parameters
363
+ form_params = opts[:form_params] || {}
364
+
365
+ # http body (model)
366
+ post_body = opts[:body]
367
+
368
+ # return_type
369
+ return_type = opts[:return_type] || 'Object'
370
+
371
+ # auth_names
372
+ auth_names = opts[:auth_names] || []
373
+
374
+ new_options = opts.merge(
375
+ :header_params => header_params,
376
+ :query_params => query_params,
377
+ :form_params => form_params,
378
+ :body => post_body,
379
+ :auth_names => auth_names,
380
+ :return_type => return_type
381
+ )
382
+
383
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
384
+ if @api_client.config.debugging
385
+ @api_client.config.logger.debug "API called: PublicApi#get_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
386
+ end
387
+ return data, status_code, headers
388
+ end
389
+
156
390
  # Get the request context of browser-based login user flows
157
- # 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).
391
+ # 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).
158
392
  # @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;).
159
393
  # @param [Hash] opts the optional parameters
160
394
  # @return [LoginRequest]
@@ -164,7 +398,7 @@ module OryHydraClient
164
398
  end
165
399
 
166
400
  # Get the request context of browser-based login user flows
167
- # 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).
401
+ # 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).
168
402
  # @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;).
169
403
  # @param [Hash] opts the optional parameters
170
404
  # @return [Array<(LoginRequest, Integer, Hash)>] LoginRequest data, response status code and response headers
@@ -216,31 +450,31 @@ module OryHydraClient
216
450
  return data, status_code, headers
217
451
  end
218
452
 
219
- # Get the request context of browser-based profile management flows
220
- # 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).
221
- # @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;).
453
+ # Get the request context of browser-based recovery flows
454
+ # 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).
455
+ # @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;).
222
456
  # @param [Hash] opts the optional parameters
223
- # @return [ProfileManagementRequest]
224
- def get_self_service_browser_profile_management_request(request, opts = {})
225
- data, _status_code, _headers = get_self_service_browser_profile_management_request_with_http_info(request, opts)
457
+ # @return [RecoveryRequest]
458
+ def get_self_service_browser_recovery_request(request, opts = {})
459
+ data, _status_code, _headers = get_self_service_browser_recovery_request_with_http_info(request, opts)
226
460
  data
227
461
  end
228
462
 
229
- # Get the request context of browser-based profile management flows
230
- # 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).
231
- # @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;).
463
+ # Get the request context of browser-based recovery flows
464
+ # 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).
465
+ # @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;).
232
466
  # @param [Hash] opts the optional parameters
233
- # @return [Array<(ProfileManagementRequest, Integer, Hash)>] ProfileManagementRequest data, response status code and response headers
234
- def get_self_service_browser_profile_management_request_with_http_info(request, opts = {})
467
+ # @return [Array<(RecoveryRequest, Integer, Hash)>] RecoveryRequest data, response status code and response headers
468
+ def get_self_service_browser_recovery_request_with_http_info(request, opts = {})
235
469
  if @api_client.config.debugging
236
- @api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_browser_profile_management_request ...'
470
+ @api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_browser_recovery_request ...'
237
471
  end
238
472
  # verify the required parameter 'request' is set
239
473
  if @api_client.config.client_side_validation && request.nil?
240
- fail ArgumentError, "Missing the required parameter 'request' when calling PublicApi.get_self_service_browser_profile_management_request"
474
+ fail ArgumentError, "Missing the required parameter 'request' when calling PublicApi.get_self_service_browser_recovery_request"
241
475
  end
242
476
  # resource path
243
- local_var_path = '/self-service/browser/flows/requests/profile'
477
+ local_var_path = '/self-service/browser/flows/requests/recovery'
244
478
 
245
479
  # query parameters
246
480
  query_params = opts[:query_params] || {}
@@ -258,7 +492,7 @@ module OryHydraClient
258
492
  post_body = opts[:body]
259
493
 
260
494
  # return_type
261
- return_type = opts[:return_type] || 'ProfileManagementRequest'
495
+ return_type = opts[:return_type] || 'RecoveryRequest'
262
496
 
263
497
  # auth_names
264
498
  auth_names = opts[:auth_names] || []
@@ -274,13 +508,13 @@ module OryHydraClient
274
508
 
275
509
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
276
510
  if @api_client.config.debugging
277
- @api_client.config.logger.debug "API called: PublicApi#get_self_service_browser_profile_management_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
511
+ @api_client.config.logger.debug "API called: PublicApi#get_self_service_browser_recovery_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
278
512
  end
279
513
  return data, status_code, headers
280
514
  end
281
515
 
282
516
  # Get the request context of browser-based registration user flows
283
- # 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).
517
+ # 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).
284
518
  # @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;).
285
519
  # @param [Hash] opts the optional parameters
286
520
  # @return [RegistrationRequest]
@@ -290,7 +524,7 @@ module OryHydraClient
290
524
  end
291
525
 
292
526
  # Get the request context of browser-based registration user flows
293
- # 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).
527
+ # 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).
294
528
  # @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;).
295
529
  # @param [Hash] opts the optional parameters
296
530
  # @return [Array<(RegistrationRequest, Integer, Hash)>] RegistrationRequest data, response status code and response headers
@@ -342,10 +576,73 @@ module OryHydraClient
342
576
  return data, status_code, headers
343
577
  end
344
578
 
579
+ # Get the request context of browser-based settings flows
580
+ # 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).
581
+ # @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;).
582
+ # @param [Hash] opts the optional parameters
583
+ # @return [SettingsRequest]
584
+ def get_self_service_browser_settings_request(request, opts = {})
585
+ data, _status_code, _headers = get_self_service_browser_settings_request_with_http_info(request, opts)
586
+ data
587
+ end
588
+
589
+ # Get the request context of browser-based settings flows
590
+ # 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).
591
+ # @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;).
592
+ # @param [Hash] opts the optional parameters
593
+ # @return [Array<(SettingsRequest, Integer, Hash)>] SettingsRequest data, response status code and response headers
594
+ def get_self_service_browser_settings_request_with_http_info(request, opts = {})
595
+ if @api_client.config.debugging
596
+ @api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_browser_settings_request ...'
597
+ end
598
+ # verify the required parameter 'request' is set
599
+ if @api_client.config.client_side_validation && request.nil?
600
+ fail ArgumentError, "Missing the required parameter 'request' when calling PublicApi.get_self_service_browser_settings_request"
601
+ end
602
+ # resource path
603
+ local_var_path = '/self-service/browser/flows/requests/settings'
604
+
605
+ # query parameters
606
+ query_params = opts[:query_params] || {}
607
+ query_params[:'request'] = request
608
+
609
+ # header parameters
610
+ header_params = opts[:header_params] || {}
611
+ # HTTP header 'Accept' (if needed)
612
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
613
+
614
+ # form parameters
615
+ form_params = opts[:form_params] || {}
616
+
617
+ # http body (model)
618
+ post_body = opts[:body]
619
+
620
+ # return_type
621
+ return_type = opts[:return_type] || 'SettingsRequest'
622
+
623
+ # auth_names
624
+ auth_names = opts[:auth_names] || []
625
+
626
+ new_options = opts.merge(
627
+ :header_params => header_params,
628
+ :query_params => query_params,
629
+ :form_params => form_params,
630
+ :body => post_body,
631
+ :auth_names => auth_names,
632
+ :return_type => return_type
633
+ )
634
+
635
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
636
+ if @api_client.config.debugging
637
+ @api_client.config.logger.debug "API called: PublicApi#get_self_service_browser_settings_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
638
+ end
639
+ return data, status_code, headers
640
+ end
641
+
345
642
  # Get user-facing self-service errors
346
- # 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).
643
+ # 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).
347
644
  # @param [Hash] opts the optional parameters
348
- # @option opts [String] :id
645
+ # @option opts [String] :error
349
646
  # @return [ErrorContainer]
350
647
  def get_self_service_error(opts = {})
351
648
  data, _status_code, _headers = get_self_service_error_with_http_info(opts)
@@ -353,9 +650,9 @@ module OryHydraClient
353
650
  end
354
651
 
355
652
  # Get user-facing self-service errors
356
- # 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).
653
+ # 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).
357
654
  # @param [Hash] opts the optional parameters
358
- # @option opts [String] :id
655
+ # @option opts [String] :error
359
656
  # @return [Array<(ErrorContainer, Integer, Hash)>] ErrorContainer data, response status code and response headers
360
657
  def get_self_service_error_with_http_info(opts = {})
361
658
  if @api_client.config.debugging
@@ -366,7 +663,7 @@ module OryHydraClient
366
663
 
367
664
  # query parameters
368
665
  query_params = opts[:query_params] || {}
369
- query_params[:'id'] = opts[:'id'] if !opts[:'id'].nil?
666
+ query_params[:'error'] = opts[:'error'] if !opts[:'error'].nil?
370
667
 
371
668
  # header parameters
372
669
  header_params = opts[:header_params] || {}
@@ -465,8 +762,9 @@ module OryHydraClient
465
762
  end
466
763
 
467
764
  # Initialize browser-based login user flow
468
- # 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).
765
+ # This endpoint initializes a browser-based user login flow. Once initialized, the browser will be redirected to `selfservice.flows.login.ui_url` 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).
469
766
  # @param [Hash] opts the optional parameters
767
+ # @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.
470
768
  # @return [nil]
471
769
  def initialize_self_service_browser_login_flow(opts = {})
472
770
  initialize_self_service_browser_login_flow_with_http_info(opts)
@@ -474,8 +772,9 @@ module OryHydraClient
474
772
  end
475
773
 
476
774
  # Initialize browser-based login user flow
477
- # 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).
775
+ # 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 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).
478
776
  # @param [Hash] opts the optional parameters
777
+ # @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.
479
778
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
480
779
  def initialize_self_service_browser_login_flow_with_http_info(opts = {})
481
780
  if @api_client.config.debugging
@@ -486,6 +785,7 @@ module OryHydraClient
486
785
 
487
786
  # query parameters
488
787
  query_params = opts[:query_params] || {}
788
+ query_params[:'refresh'] = opts[:'refresh'] if !opts[:'refresh'].nil?
489
789
 
490
790
  # header parameters
491
791
  header_params = opts[:header_params] || {}
@@ -577,7 +877,7 @@ module OryHydraClient
577
877
  end
578
878
 
579
879
  # Initialize browser-based registration user flow
580
- # 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).
880
+ # This endpoint initializes a browser-based user registration flow. Once initialized, the browser will be redirected to `selfservice.flows.registration.ui_url` 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).
581
881
  # @param [Hash] opts the optional parameters
582
882
  # @return [nil]
583
883
  def initialize_self_service_browser_registration_flow(opts = {})
@@ -586,7 +886,7 @@ module OryHydraClient
586
886
  end
587
887
 
588
888
  # Initialize browser-based registration user flow
589
- # 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).
889
+ # 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 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).
590
890
  # @param [Hash] opts the optional parameters
591
891
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
592
892
  def initialize_self_service_browser_registration_flow_with_http_info(opts = {})
@@ -633,7 +933,7 @@ module OryHydraClient
633
933
  end
634
934
 
635
935
  # Initialize browser-based verification flow
636
- # 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).
936
+ # This endpoint initializes a browser-based verification flow. Once initialized, the browser will be redirected to `selfservice.flows.settings.ui_url` 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).
637
937
  # @param via [String] What to verify Currently only \&quot;email\&quot; is supported.
638
938
  # @param [Hash] opts the optional parameters
639
939
  # @return [nil]
@@ -643,7 +943,7 @@ module OryHydraClient
643
943
  end
644
944
 
645
945
  # Initialize browser-based verification flow
646
- # 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).
946
+ # This endpoint initializes a browser-based verification flow. Once initialized, the browser will be redirected to &#x60;selfservice.flows.settings.ui_url&#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).
647
947
  # @param via [String] What to verify Currently only \&quot;email\&quot; is supported.
648
948
  # @param [Hash] opts the optional parameters
649
949
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -694,25 +994,81 @@ module OryHydraClient
694
994
  return data, status_code, headers
695
995
  end
696
996
 
697
- # Initialize browser-based profile management flow
698
- # 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).
997
+ # Initialize browser-based account recovery flow
998
+ # This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to `selfservice.flows.recovery.ui_url` with the request ID set as a query parameter. If a valid user session exists, the request is aborted. > 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/password-reset-account-recovery).
999
+ # @param [Hash] opts the optional parameters
1000
+ # @return [nil]
1001
+ def initialize_self_service_recovery_flow(opts = {})
1002
+ initialize_self_service_recovery_flow_with_http_info(opts)
1003
+ nil
1004
+ end
1005
+
1006
+ # Initialize browser-based account recovery flow
1007
+ # 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 request ID set as a query parameter. If a valid user session exists, the request is aborted. &gt; 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/password-reset-account-recovery).
1008
+ # @param [Hash] opts the optional parameters
1009
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1010
+ def initialize_self_service_recovery_flow_with_http_info(opts = {})
1011
+ if @api_client.config.debugging
1012
+ @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_recovery_flow ...'
1013
+ end
1014
+ # resource path
1015
+ local_var_path = '/self-service/browser/flows/recovery'
1016
+
1017
+ # query parameters
1018
+ query_params = opts[:query_params] || {}
1019
+
1020
+ # header parameters
1021
+ header_params = opts[:header_params] || {}
1022
+ # HTTP header 'Accept' (if needed)
1023
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1024
+
1025
+ # form parameters
1026
+ form_params = opts[:form_params] || {}
1027
+
1028
+ # http body (model)
1029
+ post_body = opts[:body]
1030
+
1031
+ # return_type
1032
+ return_type = opts[:return_type]
1033
+
1034
+ # auth_names
1035
+ auth_names = opts[:auth_names] || []
1036
+
1037
+ new_options = opts.merge(
1038
+ :header_params => header_params,
1039
+ :query_params => query_params,
1040
+ :form_params => form_params,
1041
+ :body => post_body,
1042
+ :auth_names => auth_names,
1043
+ :return_type => return_type
1044
+ )
1045
+
1046
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1047
+ if @api_client.config.debugging
1048
+ @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_recovery_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1049
+ end
1050
+ return data, status_code, headers
1051
+ end
1052
+
1053
+ # Initialize browser-based settings flow
1054
+ # This endpoint initializes a browser-based settings flow. Once initialized, the browser will be redirected to `selfservice.flows.settings.ui_url` 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 User Settings & Profile Management Documentation](../self-service/flows/user-settings).
699
1055
  # @param [Hash] opts the optional parameters
700
1056
  # @return [nil]
701
- def initialize_self_service_profile_management_flow(opts = {})
702
- initialize_self_service_profile_management_flow_with_http_info(opts)
1057
+ def initialize_self_service_settings_flow(opts = {})
1058
+ initialize_self_service_settings_flow_with_http_info(opts)
703
1059
  nil
704
1060
  end
705
1061
 
706
- # Initialize browser-based profile management flow
707
- # 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).
1062
+ # Initialize browser-based settings flow
1063
+ # This endpoint initializes a browser-based settings flow. Once initialized, the browser will be redirected to &#x60;selfservice.flows.settings.ui_url&#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 User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
708
1064
  # @param [Hash] opts the optional parameters
709
1065
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
710
- def initialize_self_service_profile_management_flow_with_http_info(opts = {})
1066
+ def initialize_self_service_settings_flow_with_http_info(opts = {})
711
1067
  if @api_client.config.debugging
712
- @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_profile_management_flow ...'
1068
+ @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_settings_flow ...'
713
1069
  end
714
1070
  # resource path
715
- local_var_path = '/self-service/browser/flows/profile'
1071
+ local_var_path = '/self-service/browser/flows/settings'
716
1072
 
717
1073
  # query parameters
718
1074
  query_params = opts[:query_params] || {}
@@ -745,7 +1101,7 @@ module OryHydraClient
745
1101
 
746
1102
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
747
1103
  if @api_client.config.debugging
748
- @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_profile_management_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1104
+ @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_settings_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
749
1105
  end
750
1106
  return data, status_code, headers
751
1107
  end
@@ -753,19 +1109,21 @@ module OryHydraClient
753
1109
  # Complete the browser-based verification flows
754
1110
  # 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).
755
1111
  # @param code [String]
1112
+ # @param via [String] What to verify Currently only \&quot;email\&quot; is supported.
756
1113
  # @param [Hash] opts the optional parameters
757
1114
  # @return [nil]
758
- def self_service_browser_verify(code, opts = {})
759
- self_service_browser_verify_with_http_info(code, opts)
1115
+ def self_service_browser_verify(code, via, opts = {})
1116
+ self_service_browser_verify_with_http_info(code, via, opts)
760
1117
  nil
761
1118
  end
762
1119
 
763
1120
  # Complete the browser-based verification flows
764
1121
  # 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).
765
1122
  # @param code [String]
1123
+ # @param via [String] What to verify Currently only \&quot;email\&quot; is supported.
766
1124
  # @param [Hash] opts the optional parameters
767
1125
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
768
- def self_service_browser_verify_with_http_info(code, opts = {})
1126
+ def self_service_browser_verify_with_http_info(code, via, opts = {})
769
1127
  if @api_client.config.debugging
770
1128
  @api_client.config.logger.debug 'Calling API: PublicApi.self_service_browser_verify ...'
771
1129
  end
@@ -773,8 +1131,12 @@ module OryHydraClient
773
1131
  if @api_client.config.client_side_validation && code.nil?
774
1132
  fail ArgumentError, "Missing the required parameter 'code' when calling PublicApi.self_service_browser_verify"
775
1133
  end
1134
+ # verify the required parameter 'via' is set
1135
+ if @api_client.config.client_side_validation && via.nil?
1136
+ fail ArgumentError, "Missing the required parameter 'via' when calling PublicApi.self_service_browser_verify"
1137
+ end
776
1138
  # resource path
777
- local_var_path = '/self-service/browser/flows/verification/confirm/{code}'.sub('{' + 'code' + '}', CGI.escape(code.to_s))
1139
+ 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))
778
1140
 
779
1141
  # query parameters
780
1142
  query_params = opts[:query_params] || {}
@@ -813,7 +1175,7 @@ module OryHydraClient
813
1175
  end
814
1176
 
815
1177
  # Check who the current HTTP session belongs to
816
- # 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.
1178
+ # 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.
817
1179
  # @param [Hash] opts the optional parameters
818
1180
  # @return [Session]
819
1181
  def whoami(opts = {})
@@ -822,7 +1184,7 @@ module OryHydraClient
822
1184
  end
823
1185
 
824
1186
  # Check who the current HTTP session belongs to
825
- # 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.
1187
+ # 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.
826
1188
  # @param [Hash] opts the optional parameters
827
1189
  # @return [Array<(Session, Integer, Hash)>] Session data, response status code and response headers
828
1190
  def whoami_with_http_info(opts = {})