ory-kratos-client 0.3.0.alpha1 → 0.4.6.alpha1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (64) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -1
  3. data/README.md +14 -6
  4. data/docs/AdminApi.md +53 -5
  5. data/docs/CommonApi.md +53 -5
  6. data/docs/Form.md +2 -2
  7. data/docs/FormField.md +3 -3
  8. data/docs/GenericErrorPayload.md +1 -1
  9. data/docs/Identity.md +9 -7
  10. data/docs/LoginRequest.md +2 -0
  11. data/docs/LoginRequestMethodConfig.md +2 -2
  12. data/docs/Message.md +23 -0
  13. data/docs/PublicApi.md +153 -13
  14. data/docs/RecoveryAddress.md +21 -0
  15. data/docs/RecoveryRequest.md +31 -0
  16. data/docs/RecoveryRequestMethod.md +19 -0
  17. data/docs/RegistrationRequest.md +2 -0
  18. data/docs/RegistrationRequestMethodConfig.md +2 -2
  19. data/docs/RequestMethodConfig.md +2 -2
  20. data/docs/SettingsRequest.md +4 -2
  21. data/docs/VerificationRequest.md +2 -0
  22. data/lib/ory-kratos-client.rb +6 -3
  23. data/lib/ory-kratos-client/api/admin_api.rb +73 -10
  24. data/lib/ory-kratos-client/api/common_api.rb +73 -10
  25. data/lib/ory-kratos-client/api/health_api.rb +2 -2
  26. data/lib/ory-kratos-client/api/public_api.rb +198 -20
  27. data/lib/ory-kratos-client/api/version_api.rb +2 -2
  28. data/lib/ory-kratos-client/api_client.rb +9 -7
  29. data/lib/ory-kratos-client/api_error.rb +2 -2
  30. data/lib/ory-kratos-client/configuration.rb +2 -2
  31. data/lib/ory-kratos-client/models/complete_self_service_browser_settings_strategy_profile_flow_payload.rb +2 -2
  32. data/lib/ory-kratos-client/models/error_container.rb +2 -2
  33. data/lib/ory-kratos-client/models/form.rb +14 -15
  34. data/lib/ory-kratos-client/models/form_field.rb +11 -11
  35. data/lib/ory-kratos-client/models/generic_error.rb +2 -2
  36. data/lib/ory-kratos-client/models/generic_error_payload.rb +4 -6
  37. data/lib/ory-kratos-client/models/health_not_ready_status.rb +2 -2
  38. data/lib/ory-kratos-client/models/health_status.rb +2 -2
  39. data/lib/ory-kratos-client/models/identity.rb +48 -35
  40. data/lib/ory-kratos-client/models/login_request.rb +14 -3
  41. data/lib/ory-kratos-client/models/login_request_method.rb +2 -2
  42. data/lib/ory-kratos-client/models/login_request_method_config.rb +14 -15
  43. data/lib/ory-kratos-client/models/message.rb +233 -0
  44. data/lib/ory-kratos-client/models/provider_credentials_config.rb +2 -2
  45. data/lib/ory-kratos-client/models/recovery_address.rb +239 -0
  46. data/lib/ory-kratos-client/models/recovery_request.rb +309 -0
  47. data/lib/ory-kratos-client/models/recovery_request_method.rb +216 -0
  48. data/lib/ory-kratos-client/models/registration_request.rb +14 -3
  49. data/lib/ory-kratos-client/models/registration_request_method.rb +2 -2
  50. data/lib/ory-kratos-client/models/registration_request_method_config.rb +14 -15
  51. data/lib/ory-kratos-client/models/request_method_config.rb +14 -15
  52. data/lib/ory-kratos-client/models/session.rb +2 -2
  53. data/lib/ory-kratos-client/models/settings_request.rb +23 -13
  54. data/lib/ory-kratos-client/models/settings_request_method.rb +2 -2
  55. data/lib/ory-kratos-client/models/verifiable_address.rb +2 -2
  56. data/lib/ory-kratos-client/models/verification_request.rb +14 -3
  57. data/lib/ory-kratos-client/models/version.rb +2 -2
  58. data/lib/ory-kratos-client/version.rb +3 -3
  59. data/ory-kratos-client.gemspec +2 -2
  60. data/spec/models/message_spec.rb +59 -0
  61. data/spec/models/recovery_address_spec.rb +53 -0
  62. data/spec/models/recovery_request_method_spec.rb +47 -0
  63. data/spec/models/recovery_request_spec.rb +83 -0
  64. metadata +40 -24
@@ -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
 
@@ -18,7 +18,6 @@ require 'ory-kratos-client/configuration'
18
18
 
19
19
  # Models
20
20
  require 'ory-kratos-client/models/complete_self_service_browser_settings_strategy_profile_flow_payload'
21
- require 'ory-kratos-client/models/error'
22
21
  require 'ory-kratos-client/models/error_container'
23
22
  require 'ory-kratos-client/models/form'
24
23
  require 'ory-kratos-client/models/form_field'
@@ -30,7 +29,11 @@ require 'ory-kratos-client/models/identity'
30
29
  require 'ory-kratos-client/models/login_request'
31
30
  require 'ory-kratos-client/models/login_request_method'
32
31
  require 'ory-kratos-client/models/login_request_method_config'
32
+ require 'ory-kratos-client/models/message'
33
33
  require 'ory-kratos-client/models/provider_credentials_config'
34
+ require 'ory-kratos-client/models/recovery_address'
35
+ require 'ory-kratos-client/models/recovery_request'
36
+ require 'ory-kratos-client/models/recovery_request_method'
34
37
  require 'ory-kratos-client/models/registration_request'
35
38
  require 'ory-kratos-client/models/registration_request_method'
36
39
  require 'ory-kratos-client/models/registration_request_method_config'
@@ -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
 
@@ -268,7 +268,7 @@ module OryHydraClient
268
268
  end
269
269
 
270
270
  # Get the request context of browser-based login user flows
271
- # 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).
271
+ # 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).
272
272
  # @param request [String] Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`).
273
273
  # @param [Hash] opts the optional parameters
274
274
  # @return [LoginRequest]
@@ -278,7 +278,7 @@ module OryHydraClient
278
278
  end
279
279
 
280
280
  # Get the request context of browser-based login user flows
281
- # 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).
281
+ # 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).
282
282
  # @param request [String] Request is the Login Request ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/login?request=abcde`).
283
283
  # @param [Hash] opts the optional parameters
284
284
  # @return [Array<(LoginRequest, Integer, Hash)>] LoginRequest data, response status code and response headers
@@ -330,8 +330,71 @@ module OryHydraClient
330
330
  return data, status_code, headers
331
331
  end
332
332
 
333
+ # Get the request context of browser-based recovery flows
334
+ # 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).
335
+ # @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;).
336
+ # @param [Hash] opts the optional parameters
337
+ # @return [RecoveryRequest]
338
+ def get_self_service_browser_recovery_request(request, opts = {})
339
+ data, _status_code, _headers = get_self_service_browser_recovery_request_with_http_info(request, opts)
340
+ data
341
+ end
342
+
343
+ # Get the request context of browser-based recovery flows
344
+ # 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).
345
+ # @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;).
346
+ # @param [Hash] opts the optional parameters
347
+ # @return [Array<(RecoveryRequest, Integer, Hash)>] RecoveryRequest data, response status code and response headers
348
+ def get_self_service_browser_recovery_request_with_http_info(request, opts = {})
349
+ if @api_client.config.debugging
350
+ @api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_browser_recovery_request ...'
351
+ end
352
+ # verify the required parameter 'request' is set
353
+ if @api_client.config.client_side_validation && request.nil?
354
+ fail ArgumentError, "Missing the required parameter 'request' when calling AdminApi.get_self_service_browser_recovery_request"
355
+ end
356
+ # resource path
357
+ local_var_path = '/self-service/browser/flows/requests/recovery'
358
+
359
+ # query parameters
360
+ query_params = opts[:query_params] || {}
361
+ query_params[:'request'] = request
362
+
363
+ # header parameters
364
+ header_params = opts[:header_params] || {}
365
+ # HTTP header 'Accept' (if needed)
366
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
367
+
368
+ # form parameters
369
+ form_params = opts[:form_params] || {}
370
+
371
+ # http body (model)
372
+ post_body = opts[:body]
373
+
374
+ # return_type
375
+ return_type = opts[:return_type] || 'RecoveryRequest'
376
+
377
+ # auth_names
378
+ auth_names = opts[:auth_names] || []
379
+
380
+ new_options = opts.merge(
381
+ :header_params => header_params,
382
+ :query_params => query_params,
383
+ :form_params => form_params,
384
+ :body => post_body,
385
+ :auth_names => auth_names,
386
+ :return_type => return_type
387
+ )
388
+
389
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
390
+ if @api_client.config.debugging
391
+ @api_client.config.logger.debug "API called: AdminApi#get_self_service_browser_recovery_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
392
+ end
393
+ return data, status_code, headers
394
+ end
395
+
333
396
  # Get the request context of browser-based registration user flows
334
- # 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).
397
+ # 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).
335
398
  # @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;).
336
399
  # @param [Hash] opts the optional parameters
337
400
  # @return [RegistrationRequest]
@@ -341,7 +404,7 @@ module OryHydraClient
341
404
  end
342
405
 
343
406
  # Get the request context of browser-based registration user flows
344
- # 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).
407
+ # 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).
345
408
  # @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;).
346
409
  # @param [Hash] opts the optional parameters
347
410
  # @return [Array<(RegistrationRequest, Integer, Hash)>] RegistrationRequest data, response status code and response headers
@@ -395,7 +458,7 @@ module OryHydraClient
395
458
 
396
459
  # Get the request context of browser-based settings flows
397
460
  # 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).
398
- # @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;).
461
+ # @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;).
399
462
  # @param [Hash] opts the optional parameters
400
463
  # @return [SettingsRequest]
401
464
  def get_self_service_browser_settings_request(request, opts = {})
@@ -405,7 +468,7 @@ module OryHydraClient
405
468
 
406
469
  # Get the request context of browser-based settings flows
407
470
  # 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).
408
- # @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;).
471
+ # @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;).
409
472
  # @param [Hash] opts the optional parameters
410
473
  # @return [Array<(SettingsRequest, Integer, Hash)>] SettingsRequest data, response status code and response headers
411
474
  def get_self_service_browser_settings_request_with_http_info(request, opts = {})
@@ -457,7 +520,7 @@ module OryHydraClient
457
520
  end
458
521
 
459
522
  # Get user-facing self-service errors
460
- # 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).
523
+ # 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).
461
524
  # @param [Hash] opts the optional parameters
462
525
  # @option opts [String] :error
463
526
  # @return [ErrorContainer]
@@ -467,7 +530,7 @@ module OryHydraClient
467
530
  end
468
531
 
469
532
  # Get user-facing self-service errors
470
- # 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).
533
+ # 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).
471
534
  # @param [Hash] opts the optional parameters
472
535
  # @option opts [String] :error
473
536
  # @return [Array<(ErrorContainer, Integer, Hash)>] ErrorContainer data, response status code and response headers
@@ -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
 
@@ -80,7 +80,7 @@ module OryHydraClient
80
80
  end
81
81
 
82
82
  # Get the request context of browser-based login user flows
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 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).
84
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;).
85
85
  # @param [Hash] opts the optional parameters
86
86
  # @return [LoginRequest]
@@ -90,7 +90,7 @@ module OryHydraClient
90
90
  end
91
91
 
92
92
  # Get the request context of browser-based login user flows
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 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).
94
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;).
95
95
  # @param [Hash] opts the optional parameters
96
96
  # @return [Array<(LoginRequest, Integer, Hash)>] LoginRequest data, response status code and response headers
@@ -142,8 +142,71 @@ module OryHydraClient
142
142
  return data, status_code, headers
143
143
  end
144
144
 
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;).
148
+ # @param [Hash] opts the optional parameters
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)
152
+ data
153
+ end
154
+
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;).
158
+ # @param [Hash] opts the optional parameters
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 = {})
161
+ if @api_client.config.debugging
162
+ @api_client.config.logger.debug 'Calling API: CommonApi.get_self_service_browser_recovery_request ...'
163
+ end
164
+ # verify the required parameter 'request' is set
165
+ if @api_client.config.client_side_validation && request.nil?
166
+ fail ArgumentError, "Missing the required parameter 'request' when calling CommonApi.get_self_service_browser_recovery_request"
167
+ end
168
+ # resource path
169
+ local_var_path = '/self-service/browser/flows/requests/recovery'
170
+
171
+ # query parameters
172
+ query_params = opts[:query_params] || {}
173
+ query_params[:'request'] = request
174
+
175
+ # header parameters
176
+ header_params = opts[:header_params] || {}
177
+ # HTTP header 'Accept' (if needed)
178
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
179
+
180
+ # form parameters
181
+ form_params = opts[:form_params] || {}
182
+
183
+ # http body (model)
184
+ post_body = opts[:body]
185
+
186
+ # return_type
187
+ return_type = opts[:return_type] || 'RecoveryRequest'
188
+
189
+ # auth_names
190
+ auth_names = opts[:auth_names] || []
191
+
192
+ new_options = opts.merge(
193
+ :header_params => header_params,
194
+ :query_params => query_params,
195
+ :form_params => form_params,
196
+ :body => post_body,
197
+ :auth_names => auth_names,
198
+ :return_type => return_type
199
+ )
200
+
201
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
202
+ if @api_client.config.debugging
203
+ @api_client.config.logger.debug "API called: CommonApi#get_self_service_browser_recovery_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
204
+ end
205
+ return data, status_code, headers
206
+ end
207
+
145
208
  # Get the request context of browser-based registration user flows
146
- # 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).
147
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;).
148
211
  # @param [Hash] opts the optional parameters
149
212
  # @return [RegistrationRequest]
@@ -153,7 +216,7 @@ module OryHydraClient
153
216
  end
154
217
 
155
218
  # Get the request context of browser-based registration user flows
156
- # 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).
157
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;).
158
221
  # @param [Hash] opts the optional parameters
159
222
  # @return [Array<(RegistrationRequest, Integer, Hash)>] RegistrationRequest data, response status code and response headers
@@ -207,7 +270,7 @@ module OryHydraClient
207
270
 
208
271
  # Get the request context of browser-based settings flows
209
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).
210
- # @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;).
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;).
211
274
  # @param [Hash] opts the optional parameters
212
275
  # @return [SettingsRequest]
213
276
  def get_self_service_browser_settings_request(request, opts = {})
@@ -217,7 +280,7 @@ module OryHydraClient
217
280
 
218
281
  # Get the request context of browser-based settings flows
219
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).
220
- # @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;).
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;).
221
284
  # @param [Hash] opts the optional parameters
222
285
  # @return [Array<(SettingsRequest, Integer, Hash)>] SettingsRequest data, response status code and response headers
223
286
  def get_self_service_browser_settings_request_with_http_info(request, opts = {})
@@ -269,7 +332,7 @@ module OryHydraClient
269
332
  end
270
333
 
271
334
  # Get user-facing self-service errors
272
- # 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).
273
336
  # @param [Hash] opts the optional parameters
274
337
  # @option opts [String] :error
275
338
  # @return [ErrorContainer]
@@ -279,7 +342,7 @@ module OryHydraClient
279
342
  end
280
343
 
281
344
  # Get user-facing self-service errors
282
- # 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).
283
346
  # @param [Hash] opts the optional parameters
284
347
  # @option opts [String] :error
285
348
  # @return [Array<(ErrorContainer, Integer, Hash)>] ErrorContainer data, response status code and response headers
@@ -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,6 +19,62 @@ module OryHydraClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
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
+
22
78
  # Complete the browser-based settings flow for the OpenID Connect strategy
23
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).
24
80
  # @param [Hash] opts the optional parameters
@@ -332,7 +388,7 @@ module OryHydraClient
332
388
  end
333
389
 
334
390
  # Get the request context of browser-based login user flows
335
- # 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).
336
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;).
337
393
  # @param [Hash] opts the optional parameters
338
394
  # @return [LoginRequest]
@@ -342,7 +398,7 @@ module OryHydraClient
342
398
  end
343
399
 
344
400
  # Get the request context of browser-based login user flows
345
- # 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).
346
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;).
347
403
  # @param [Hash] opts the optional parameters
348
404
  # @return [Array<(LoginRequest, Integer, Hash)>] LoginRequest data, response status code and response headers
@@ -394,8 +450,71 @@ module OryHydraClient
394
450
  return data, status_code, headers
395
451
  end
396
452
 
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;).
456
+ # @param [Hash] opts the optional parameters
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)
460
+ data
461
+ end
462
+
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;).
466
+ # @param [Hash] opts the optional parameters
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 = {})
469
+ if @api_client.config.debugging
470
+ @api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_browser_recovery_request ...'
471
+ end
472
+ # verify the required parameter 'request' is set
473
+ if @api_client.config.client_side_validation && request.nil?
474
+ fail ArgumentError, "Missing the required parameter 'request' when calling PublicApi.get_self_service_browser_recovery_request"
475
+ end
476
+ # resource path
477
+ local_var_path = '/self-service/browser/flows/requests/recovery'
478
+
479
+ # query parameters
480
+ query_params = opts[:query_params] || {}
481
+ query_params[:'request'] = request
482
+
483
+ # header parameters
484
+ header_params = opts[:header_params] || {}
485
+ # HTTP header 'Accept' (if needed)
486
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
487
+
488
+ # form parameters
489
+ form_params = opts[:form_params] || {}
490
+
491
+ # http body (model)
492
+ post_body = opts[:body]
493
+
494
+ # return_type
495
+ return_type = opts[:return_type] || 'RecoveryRequest'
496
+
497
+ # auth_names
498
+ auth_names = opts[:auth_names] || []
499
+
500
+ new_options = opts.merge(
501
+ :header_params => header_params,
502
+ :query_params => query_params,
503
+ :form_params => form_params,
504
+ :body => post_body,
505
+ :auth_names => auth_names,
506
+ :return_type => return_type
507
+ )
508
+
509
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
510
+ if @api_client.config.debugging
511
+ @api_client.config.logger.debug "API called: PublicApi#get_self_service_browser_recovery_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
512
+ end
513
+ return data, status_code, headers
514
+ end
515
+
397
516
  # Get the request context of browser-based registration user flows
398
- # 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).
399
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;).
400
519
  # @param [Hash] opts the optional parameters
401
520
  # @return [RegistrationRequest]
@@ -405,7 +524,7 @@ module OryHydraClient
405
524
  end
406
525
 
407
526
  # Get the request context of browser-based registration user flows
408
- # 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).
409
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;).
410
529
  # @param [Hash] opts the optional parameters
411
530
  # @return [Array<(RegistrationRequest, Integer, Hash)>] RegistrationRequest data, response status code and response headers
@@ -459,7 +578,7 @@ module OryHydraClient
459
578
 
460
579
  # Get the request context of browser-based settings flows
461
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).
462
- # @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;).
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;).
463
582
  # @param [Hash] opts the optional parameters
464
583
  # @return [SettingsRequest]
465
584
  def get_self_service_browser_settings_request(request, opts = {})
@@ -469,7 +588,7 @@ module OryHydraClient
469
588
 
470
589
  # Get the request context of browser-based settings flows
471
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).
472
- # @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;).
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;).
473
592
  # @param [Hash] opts the optional parameters
474
593
  # @return [Array<(SettingsRequest, Integer, Hash)>] SettingsRequest data, response status code and response headers
475
594
  def get_self_service_browser_settings_request_with_http_info(request, opts = {})
@@ -521,7 +640,7 @@ module OryHydraClient
521
640
  end
522
641
 
523
642
  # Get user-facing self-service errors
524
- # 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).
525
644
  # @param [Hash] opts the optional parameters
526
645
  # @option opts [String] :error
527
646
  # @return [ErrorContainer]
@@ -531,7 +650,7 @@ module OryHydraClient
531
650
  end
532
651
 
533
652
  # Get user-facing self-service errors
534
- # 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).
535
654
  # @param [Hash] opts the optional parameters
536
655
  # @option opts [String] :error
537
656
  # @return [Array<(ErrorContainer, Integer, Hash)>] ErrorContainer data, response status code and response headers
@@ -643,8 +762,9 @@ module OryHydraClient
643
762
  end
644
763
 
645
764
  # Initialize browser-based login user flow
646
- # 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).
647
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.
648
768
  # @return [nil]
649
769
  def initialize_self_service_browser_login_flow(opts = {})
650
770
  initialize_self_service_browser_login_flow_with_http_info(opts)
@@ -652,8 +772,9 @@ module OryHydraClient
652
772
  end
653
773
 
654
774
  # Initialize browser-based login user flow
655
- # 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).
656
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.
657
778
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
658
779
  def initialize_self_service_browser_login_flow_with_http_info(opts = {})
659
780
  if @api_client.config.debugging
@@ -664,6 +785,7 @@ module OryHydraClient
664
785
 
665
786
  # query parameters
666
787
  query_params = opts[:query_params] || {}
788
+ query_params[:'refresh'] = opts[:'refresh'] if !opts[:'refresh'].nil?
667
789
 
668
790
  # header parameters
669
791
  header_params = opts[:header_params] || {}
@@ -755,7 +877,7 @@ module OryHydraClient
755
877
  end
756
878
 
757
879
  # Initialize browser-based registration user flow
758
- # 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).
759
881
  # @param [Hash] opts the optional parameters
760
882
  # @return [nil]
761
883
  def initialize_self_service_browser_registration_flow(opts = {})
@@ -764,7 +886,7 @@ module OryHydraClient
764
886
  end
765
887
 
766
888
  # Initialize browser-based registration user flow
767
- # 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).
768
890
  # @param [Hash] opts the optional parameters
769
891
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
770
892
  def initialize_self_service_browser_registration_flow_with_http_info(opts = {})
@@ -811,7 +933,7 @@ module OryHydraClient
811
933
  end
812
934
 
813
935
  # Initialize browser-based verification flow
814
- # This endpoint initializes a browser-based verification flow. Once initialized, the browser will be redirected to `urls.settings_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).
815
937
  # @param via [String] What to verify Currently only \&quot;email\&quot; is supported.
816
938
  # @param [Hash] opts the optional parameters
817
939
  # @return [nil]
@@ -821,7 +943,7 @@ module OryHydraClient
821
943
  end
822
944
 
823
945
  # Initialize browser-based verification flow
824
- # This endpoint initializes a browser-based verification flow. Once initialized, the browser will be redirected to &#x60;urls.settings_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).
825
947
  # @param via [String] What to verify Currently only \&quot;email\&quot; is supported.
826
948
  # @param [Hash] opts the optional parameters
827
949
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -872,8 +994,64 @@ module OryHydraClient
872
994
  return data, status_code, headers
873
995
  end
874
996
 
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
+
875
1053
  # Initialize browser-based settings flow
876
- # This endpoint initializes a browser-based settings flow. Once initialized, the browser will be redirected to `urls.settings_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 User Settings & Profile Management Documentation](../self-service/flows/user-settings).
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).
877
1055
  # @param [Hash] opts the optional parameters
878
1056
  # @return [nil]
879
1057
  def initialize_self_service_settings_flow(opts = {})
@@ -882,7 +1060,7 @@ module OryHydraClient
882
1060
  end
883
1061
 
884
1062
  # Initialize browser-based settings flow
885
- # This endpoint initializes a browser-based settings flow. Once initialized, the browser will be redirected to &#x60;urls.settings_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 User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
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).
886
1064
  # @param [Hash] opts the optional parameters
887
1065
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
888
1066
  def initialize_self_service_settings_flow_with_http_info(opts = {})
@@ -997,7 +1175,7 @@ module OryHydraClient
997
1175
  end
998
1176
 
999
1177
  # Check who the current HTTP session belongs to
1000
- # 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.
1001
1179
  # @param [Hash] opts the optional parameters
1002
1180
  # @return [Session]
1003
1181
  def whoami(opts = {})
@@ -1006,7 +1184,7 @@ module OryHydraClient
1006
1184
  end
1007
1185
 
1008
1186
  # Check who the current HTTP session belongs to
1009
- # 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.
1010
1188
  # @param [Hash] opts the optional parameters
1011
1189
  # @return [Array<(Session, Integer, Hash)>] Session data, response status code and response headers
1012
1190
  def whoami_with_http_info(opts = {})