ory-kratos-client 0.6.2.alpha1 → 0.6.3.alpha1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (104) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +25 -24
  3. data/docs/AdminApi.md +15 -13
  4. data/docs/GenericError.md +14 -2
  5. data/docs/Identity.md +6 -2
  6. data/docs/IdentityCredentials.md +5 -1
  7. data/docs/JsonError.md +18 -0
  8. data/docs/LoginFlow.md +5 -1
  9. data/docs/PublicApi.md +216 -210
  10. data/docs/RecoveryAddress.md +4 -0
  11. data/docs/SelfServiceErrorContainer.md +24 -0
  12. data/docs/VerifiableIdentityAddress.md +32 -0
  13. data/lib/ory-kratos-client.rb +4 -4
  14. data/lib/ory-kratos-client/api/admin_api.rb +7 -4
  15. data/lib/ory-kratos-client/api/public_api.rb +171 -162
  16. data/lib/ory-kratos-client/api_client.rb +1 -1
  17. data/lib/ory-kratos-client/api_error.rb +1 -1
  18. data/lib/ory-kratos-client/configuration.rb +15 -22
  19. data/lib/ory-kratos-client/models/authenticate_ok_body.rb +1 -1
  20. data/lib/ory-kratos-client/models/container_change_response_item.rb +1 -1
  21. data/lib/ory-kratos-client/models/container_create_created_body.rb +1 -1
  22. data/lib/ory-kratos-client/models/container_top_ok_body.rb +1 -1
  23. data/lib/ory-kratos-client/models/container_update_ok_body.rb +1 -1
  24. data/lib/ory-kratos-client/models/container_wait_ok_body.rb +1 -1
  25. data/lib/ory-kratos-client/models/container_wait_ok_body_error.rb +1 -1
  26. data/lib/ory-kratos-client/models/create_identity.rb +1 -1
  27. data/lib/ory-kratos-client/models/create_recovery_link.rb +1 -1
  28. data/lib/ory-kratos-client/models/error_response.rb +1 -1
  29. data/lib/ory-kratos-client/models/generic_error.rb +76 -9
  30. data/lib/ory-kratos-client/models/graph_driver_data.rb +1 -1
  31. data/lib/ory-kratos-client/models/health_not_ready_status.rb +1 -1
  32. data/lib/ory-kratos-client/models/health_status.rb +1 -1
  33. data/lib/ory-kratos-client/models/id_response.rb +1 -1
  34. data/lib/ory-kratos-client/models/identity.rb +27 -9
  35. data/lib/ory-kratos-client/models/identity_credentials.rb +25 -5
  36. data/lib/ory-kratos-client/models/image_delete_response_item.rb +1 -1
  37. data/lib/ory-kratos-client/models/image_summary.rb +1 -1
  38. data/lib/ory-kratos-client/models/inline_response200.rb +1 -1
  39. data/lib/ory-kratos-client/models/inline_response2001.rb +1 -1
  40. data/lib/ory-kratos-client/models/inline_response503.rb +1 -1
  41. data/lib/ory-kratos-client/models/json_error.rb +224 -0
  42. data/lib/ory-kratos-client/models/login_flow.rb +25 -5
  43. data/lib/ory-kratos-client/models/login_via_api_response.rb +1 -1
  44. data/lib/ory-kratos-client/models/meta.rb +1 -1
  45. data/lib/ory-kratos-client/models/plugin.rb +1 -1
  46. data/lib/ory-kratos-client/models/plugin_config.rb +1 -1
  47. data/lib/ory-kratos-client/models/plugin_config_args.rb +1 -1
  48. data/lib/ory-kratos-client/models/plugin_config_interface.rb +1 -1
  49. data/lib/ory-kratos-client/models/plugin_config_linux.rb +1 -1
  50. data/lib/ory-kratos-client/models/plugin_config_network.rb +1 -1
  51. data/lib/ory-kratos-client/models/plugin_config_rootfs.rb +1 -1
  52. data/lib/ory-kratos-client/models/plugin_config_user.rb +1 -1
  53. data/lib/ory-kratos-client/models/plugin_device.rb +1 -1
  54. data/lib/ory-kratos-client/models/plugin_env.rb +1 -1
  55. data/lib/ory-kratos-client/models/plugin_interface_type.rb +1 -1
  56. data/lib/ory-kratos-client/models/plugin_mount.rb +1 -1
  57. data/lib/ory-kratos-client/models/plugin_settings.rb +1 -1
  58. data/lib/ory-kratos-client/models/port.rb +1 -1
  59. data/lib/ory-kratos-client/models/recovery_address.rb +22 -2
  60. data/lib/ory-kratos-client/models/recovery_flow.rb +1 -1
  61. data/lib/ory-kratos-client/models/recovery_link.rb +1 -1
  62. data/lib/ory-kratos-client/models/registration_flow.rb +1 -1
  63. data/lib/ory-kratos-client/models/registration_via_api_response.rb +1 -1
  64. data/lib/ory-kratos-client/models/revoke_session.rb +1 -1
  65. data/lib/ory-kratos-client/models/self_service_error_container.rb +260 -0
  66. data/lib/ory-kratos-client/models/service_update_response.rb +1 -1
  67. data/lib/ory-kratos-client/models/session.rb +1 -1
  68. data/lib/ory-kratos-client/models/settings_flow.rb +1 -1
  69. data/lib/ory-kratos-client/models/settings_profile_form_config.rb +1 -1
  70. data/lib/ory-kratos-client/models/settings_via_api_response.rb +1 -1
  71. data/lib/ory-kratos-client/models/submit_self_service_browser_settings_oidc_flow_payload.rb +1 -1
  72. data/lib/ory-kratos-client/models/submit_self_service_login_flow.rb +1 -1
  73. data/lib/ory-kratos-client/models/submit_self_service_login_flow_with_password_method.rb +1 -1
  74. data/lib/ory-kratos-client/models/submit_self_service_recovery_flow_with_link_method.rb +1 -1
  75. data/lib/ory-kratos-client/models/submit_self_service_registration_flow.rb +1 -1
  76. data/lib/ory-kratos-client/models/submit_self_service_registration_flow_with_password_method.rb +22 -1
  77. data/lib/ory-kratos-client/models/submit_self_service_settings_flow.rb +1 -1
  78. data/lib/ory-kratos-client/models/submit_self_service_settings_flow_with_password_method.rb +1 -1
  79. data/lib/ory-kratos-client/models/submit_self_service_settings_flow_with_profile_method.rb +1 -1
  80. data/lib/ory-kratos-client/models/submit_self_service_verification_flow_with_link_method.rb +1 -1
  81. data/lib/ory-kratos-client/models/ui_container.rb +1 -1
  82. data/lib/ory-kratos-client/models/ui_node.rb +1 -1
  83. data/lib/ory-kratos-client/models/ui_node_anchor_attributes.rb +1 -1
  84. data/lib/ory-kratos-client/models/ui_node_attributes.rb +1 -1
  85. data/lib/ory-kratos-client/models/ui_node_image_attributes.rb +1 -1
  86. data/lib/ory-kratos-client/models/ui_node_input_attributes.rb +1 -1
  87. data/lib/ory-kratos-client/models/ui_node_input_attributes_value.rb +1 -1
  88. data/lib/ory-kratos-client/models/ui_node_text_attributes.rb +1 -1
  89. data/lib/ory-kratos-client/models/ui_text.rb +1 -1
  90. data/lib/ory-kratos-client/models/update_identity.rb +1 -1
  91. data/lib/ory-kratos-client/models/verifiable_identity_address.rb +313 -0
  92. data/lib/ory-kratos-client/models/verification_flow.rb +1 -1
  93. data/lib/ory-kratos-client/models/version.rb +1 -1
  94. data/lib/ory-kratos-client/models/volume.rb +1 -1
  95. data/lib/ory-kratos-client/models/volume_usage_data.rb +1 -1
  96. data/lib/ory-kratos-client/version.rb +2 -2
  97. data/ory-kratos-client.gemspec +1 -1
  98. data/spec/api_client_spec.rb +1 -1
  99. data/spec/configuration_spec.rb +4 -4
  100. data/spec/models/json_error_spec.rb +34 -0
  101. data/spec/models/self_service_error_container_spec.rb +52 -0
  102. data/spec/models/verifiable_identity_address_spec.rb +76 -0
  103. data/spec/spec_helper.rb +1 -1
  104. metadata +14 -2
@@ -4,7 +4,9 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **created_at** | **Time** | CreatedAt is a helper struct field for gobuffalo.pop. | [optional] |
7
8
  | **id** | **String** | | |
9
+ | **updated_at** | **Time** | UpdatedAt is a helper struct field for gobuffalo.pop. | [optional] |
8
10
  | **value** | **String** | | |
9
11
  | **via** | **String** | | |
10
12
 
@@ -14,7 +16,9 @@
14
16
  require 'ory-kratos-client'
15
17
 
16
18
  instance = OryHydraClient::RecoveryAddress.new(
19
+ created_at: null,
17
20
  id: null,
21
+ updated_at: null,
18
22
  value: null,
19
23
  via: null
20
24
  )
@@ -0,0 +1,24 @@
1
+ # OryHydraClient::SelfServiceErrorContainer
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **created_at** | **Time** | CreatedAt is a helper struct field for gobuffalo.pop. | [optional] |
8
+ | **errors** | **Array<Object>** | Errors in the container | |
9
+ | **id** | **String** | | |
10
+ | **updated_at** | **Time** | UpdatedAt is a helper struct field for gobuffalo.pop. | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'ory-kratos-client'
16
+
17
+ instance = OryHydraClient::SelfServiceErrorContainer.new(
18
+ created_at: null,
19
+ errors: null,
20
+ id: null,
21
+ updated_at: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,32 @@
1
+ # OryHydraClient::VerifiableIdentityAddress
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **created_at** | **Time** | When this entry was created | [optional] |
8
+ | **id** | **String** | | |
9
+ | **status** | **String** | VerifiableAddressStatus must not exceed 16 characters as that is the limitation in the SQL Schema | |
10
+ | **updated_at** | **Time** | When this entry was last updated | [optional] |
11
+ | **value** | **String** | The address value example foo@user.com | |
12
+ | **verified** | **Boolean** | Indicates if the address has already been verified | |
13
+ | **verified_at** | **Time** | | [optional] |
14
+ | **via** | **String** | VerifiableAddressType must not exceed 16 characters as that is the limitation in the SQL Schema | |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'ory-kratos-client'
20
+
21
+ instance = OryHydraClient::VerifiableIdentityAddress.new(
22
+ created_at: 2014-01-01T23:28:56.782Z,
23
+ id: null,
24
+ status: null,
25
+ updated_at: 2014-01-01T23:28:56.782Z,
26
+ value: null,
27
+ verified: true,
28
+ verified_at: null,
29
+ via: null
30
+ )
31
+ ```
32
+
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Documentation for all public and administrative Ory Kratos APIs. Public and administrative APIs are exposed on different ports. Public APIs can face the public internet without any protection while administrative APIs should never be exposed without prior authorization. To protect the administative API port you should use something like Nginx, Ory Oathkeeper, or any other technology capable of authorizing incoming requests.
5
5
 
6
- The version of the OpenAPI document: v0.6.2-alpha.1
6
+ The version of the OpenAPI document: v0.6.3-alpha.1
7
7
  Contact: hi@ory.sh
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.1
@@ -26,10 +26,8 @@ require 'ory-kratos-client/models/container_wait_ok_body'
26
26
  require 'ory-kratos-client/models/container_wait_ok_body_error'
27
27
  require 'ory-kratos-client/models/create_identity'
28
28
  require 'ory-kratos-client/models/create_recovery_link'
29
- require 'ory-kratos-client/models/error_container'
30
29
  require 'ory-kratos-client/models/error_response'
31
30
  require 'ory-kratos-client/models/generic_error'
32
- require 'ory-kratos-client/models/generic_error_payload'
33
31
  require 'ory-kratos-client/models/graph_driver_data'
34
32
  require 'ory-kratos-client/models/health_not_ready_status'
35
33
  require 'ory-kratos-client/models/health_status'
@@ -41,6 +39,7 @@ require 'ory-kratos-client/models/image_summary'
41
39
  require 'ory-kratos-client/models/inline_response200'
42
40
  require 'ory-kratos-client/models/inline_response2001'
43
41
  require 'ory-kratos-client/models/inline_response503'
42
+ require 'ory-kratos-client/models/json_error'
44
43
  require 'ory-kratos-client/models/login_flow'
45
44
  require 'ory-kratos-client/models/login_via_api_response'
46
45
  require 'ory-kratos-client/models/meta'
@@ -64,6 +63,7 @@ require 'ory-kratos-client/models/recovery_link'
64
63
  require 'ory-kratos-client/models/registration_flow'
65
64
  require 'ory-kratos-client/models/registration_via_api_response'
66
65
  require 'ory-kratos-client/models/revoke_session'
66
+ require 'ory-kratos-client/models/self_service_error_container'
67
67
  require 'ory-kratos-client/models/service_update_response'
68
68
  require 'ory-kratos-client/models/session'
69
69
  require 'ory-kratos-client/models/settings_flow'
@@ -89,7 +89,7 @@ require 'ory-kratos-client/models/ui_node_input_attributes_value'
89
89
  require 'ory-kratos-client/models/ui_node_text_attributes'
90
90
  require 'ory-kratos-client/models/ui_text'
91
91
  require 'ory-kratos-client/models/update_identity'
92
- require 'ory-kratos-client/models/verifiable_address'
92
+ require 'ory-kratos-client/models/verifiable_identity_address'
93
93
  require 'ory-kratos-client/models/verification_flow'
94
94
  require 'ory-kratos-client/models/version'
95
95
  require 'ory-kratos-client/models/volume'
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Documentation for all public and administrative Ory Kratos APIs. Public and administrative APIs are exposed on different ports. Public APIs can face the public internet without any protection while administrative APIs should never be exposed without prior authorization. To protect the administative API port you should use something like Nginx, Ory Oathkeeper, or any other technology capable of authorizing incoming requests.
5
5
 
6
- The version of the OpenAPI document: v0.6.2-alpha.1
6
+ The version of the OpenAPI document: v0.6.3-alpha.1
7
7
  Contact: hi@ory.sh
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.1
@@ -332,7 +332,7 @@ module OryHydraClient
332
332
  # This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: `?error=stub:500` - returns a stub 500 (Internal Server Error) error. More information can be found at [Ory Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
333
333
  # @param error [String] Error is the container's ID
334
334
  # @param [Hash] opts the optional parameters
335
- # @return [ErrorContainer]
335
+ # @return [SelfServiceErrorContainer]
336
336
  def get_self_service_error(error, opts = {})
337
337
  data, _status_code, _headers = get_self_service_error_with_http_info(error, opts)
338
338
  data
@@ -342,7 +342,7 @@ module OryHydraClient
342
342
  # This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: `?error=stub:500` - returns a stub 500 (Internal Server Error) error. More information can be found at [Ory Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
343
343
  # @param error [String] Error is the container's ID
344
344
  # @param [Hash] opts the optional parameters
345
- # @return [Array<(ErrorContainer, Integer, Hash)>] ErrorContainer data, response status code and response headers
345
+ # @return [Array<(SelfServiceErrorContainer, Integer, Hash)>] SelfServiceErrorContainer data, response status code and response headers
346
346
  def get_self_service_error_with_http_info(error, opts = {})
347
347
  if @api_client.config.debugging
348
348
  @api_client.config.logger.debug 'Calling API: AdminApi.get_self_service_error ...'
@@ -370,7 +370,7 @@ module OryHydraClient
370
370
  post_body = opts[:debug_body]
371
371
 
372
372
  # return_type
373
- return_type = opts[:debug_return_type] || 'ErrorContainer'
373
+ return_type = opts[:debug_return_type] || 'SelfServiceErrorContainer'
374
374
 
375
375
  # auth_names
376
376
  auth_names = opts[:debug_auth_names] || []
@@ -588,6 +588,7 @@ module OryHydraClient
588
588
  # When accessing this endpoint through Ory Kratos' Public API you must ensure that either the Ory Kratos Session Cookie or the Ory Kratos Session Token are set. The public endpoint does not return 404 status codes but instead 403 or 500 to improve data privacy. You can access this endpoint without credentials when using Ory Kratos' Admin API. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
589
589
  # @param id [String] ID is the Settings Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/settings?flow&#x3D;abcde&#x60;).
590
590
  # @param [Hash] opts the optional parameters
591
+ # @option opts [String] :x_session_token The Session Token of the Identity performing the settings flow.
591
592
  # @return [SettingsFlow]
592
593
  def get_self_service_settings_flow(id, opts = {})
593
594
  data, _status_code, _headers = get_self_service_settings_flow_with_http_info(id, opts)
@@ -598,6 +599,7 @@ module OryHydraClient
598
599
  # When accessing this endpoint through Ory Kratos&#39; Public API you must ensure that either the Ory Kratos Session Cookie or the Ory Kratos Session Token are set. The public endpoint does not return 404 status codes but instead 403 or 500 to improve data privacy. You can access this endpoint without credentials when using Ory Kratos&#39; Admin API. More information can be found at [Ory Kratos User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
599
600
  # @param id [String] ID is the Settings Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/settings?flow&#x3D;abcde&#x60;).
600
601
  # @param [Hash] opts the optional parameters
602
+ # @option opts [String] :x_session_token The Session Token of the Identity performing the settings flow.
601
603
  # @return [Array<(SettingsFlow, Integer, Hash)>] SettingsFlow data, response status code and response headers
602
604
  def get_self_service_settings_flow_with_http_info(id, opts = {})
603
605
  if @api_client.config.debugging
@@ -618,6 +620,7 @@ module OryHydraClient
618
620
  header_params = opts[:header_params] || {}
619
621
  # HTTP header 'Accept' (if needed)
620
622
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
623
+ header_params[:'X-Session-Token'] = opts[:'x_session_token'] if !opts[:'x_session_token'].nil?
621
624
 
622
625
  # form parameters
623
626
  form_params = opts[:form_params] || {}
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Documentation for all public and administrative Ory Kratos APIs. Public and administrative APIs are exposed on different ports. Public APIs can face the public internet without any protection while administrative APIs should never be exposed without prior authorization. To protect the administative API port you should use something like Nginx, Ory Oathkeeper, or any other technology capable of authorizing incoming requests.
5
5
 
6
- The version of the OpenAPI document: v0.6.2-alpha.1
6
+ The version of the OpenAPI document: v0.6.3-alpha.1
7
7
  Contact: hi@ory.sh
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.1
@@ -84,7 +84,7 @@ module OryHydraClient
84
84
  # This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: `?error=stub:500` - returns a stub 500 (Internal Server Error) error. More information can be found at [Ory Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
85
85
  # @param error [String] Error is the container&#39;s ID
86
86
  # @param [Hash] opts the optional parameters
87
- # @return [ErrorContainer]
87
+ # @return [SelfServiceErrorContainer]
88
88
  def get_self_service_error(error, opts = {})
89
89
  data, _status_code, _headers = get_self_service_error_with_http_info(error, opts)
90
90
  data
@@ -94,7 +94,7 @@ module OryHydraClient
94
94
  # This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: &#x60;?error&#x3D;stub:500&#x60; - returns a stub 500 (Internal Server Error) error. More information can be found at [Ory Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
95
95
  # @param error [String] Error is the container&#39;s ID
96
96
  # @param [Hash] opts the optional parameters
97
- # @return [Array<(ErrorContainer, Integer, Hash)>] ErrorContainer data, response status code and response headers
97
+ # @return [Array<(SelfServiceErrorContainer, Integer, Hash)>] SelfServiceErrorContainer data, response status code and response headers
98
98
  def get_self_service_error_with_http_info(error, opts = {})
99
99
  if @api_client.config.debugging
100
100
  @api_client.config.logger.debug 'Calling API: PublicApi.get_self_service_error ...'
@@ -122,7 +122,7 @@ module OryHydraClient
122
122
  post_body = opts[:debug_body]
123
123
 
124
124
  # return_type
125
- return_type = opts[:debug_return_type] || 'ErrorContainer'
125
+ return_type = opts[:debug_return_type] || 'SelfServiceErrorContainer'
126
126
 
127
127
  # auth_names
128
128
  auth_names = opts[:debug_auth_names] || []
@@ -340,6 +340,7 @@ module OryHydraClient
340
340
  # When accessing this endpoint through Ory Kratos' Public API you must ensure that either the Ory Kratos Session Cookie or the Ory Kratos Session Token are set. The public endpoint does not return 404 status codes but instead 403 or 500 to improve data privacy. You can access this endpoint without credentials when using Ory Kratos' Admin API. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
341
341
  # @param id [String] ID is the Settings Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/settings?flow&#x3D;abcde&#x60;).
342
342
  # @param [Hash] opts the optional parameters
343
+ # @option opts [String] :x_session_token The Session Token of the Identity performing the settings flow.
343
344
  # @return [SettingsFlow]
344
345
  def get_self_service_settings_flow(id, opts = {})
345
346
  data, _status_code, _headers = get_self_service_settings_flow_with_http_info(id, opts)
@@ -350,6 +351,7 @@ module OryHydraClient
350
351
  # When accessing this endpoint through Ory Kratos&#39; Public API you must ensure that either the Ory Kratos Session Cookie or the Ory Kratos Session Token are set. The public endpoint does not return 404 status codes but instead 403 or 500 to improve data privacy. You can access this endpoint without credentials when using Ory Kratos&#39; Admin API. More information can be found at [Ory Kratos User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
351
352
  # @param id [String] ID is the Settings Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/settings?flow&#x3D;abcde&#x60;).
352
353
  # @param [Hash] opts the optional parameters
354
+ # @option opts [String] :x_session_token The Session Token of the Identity performing the settings flow.
353
355
  # @return [Array<(SettingsFlow, Integer, Hash)>] SettingsFlow data, response status code and response headers
354
356
  def get_self_service_settings_flow_with_http_info(id, opts = {})
355
357
  if @api_client.config.debugging
@@ -370,6 +372,7 @@ module OryHydraClient
370
372
  header_params = opts[:header_params] || {}
371
373
  # HTTP header 'Accept' (if needed)
372
374
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
375
+ header_params[:'X-Session-Token'] = opts[:'x_session_token'] if !opts[:'x_session_token'].nil?
373
376
 
374
377
  # form parameters
375
378
  form_params = opts[:form_params] || {}
@@ -521,24 +524,84 @@ module OryHydraClient
521
524
  return data, status_code, headers
522
525
  end
523
526
 
524
- # Initialize Login Flow for API clients
527
+ # Initialize Login Flow for browsers
528
+ # This endpoint initializes a browser-based user login flow. Once initialized, the browser will be redirected to `selfservice.flows.login.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url` unless the query parameter `?refresh=true` was set. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
529
+ # @param [Hash] opts the optional parameters
530
+ # @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.
531
+ # @return [nil]
532
+ def initialize_self_service_login_for_browsers(opts = {})
533
+ initialize_self_service_login_for_browsers_with_http_info(opts)
534
+ nil
535
+ end
536
+
537
+ # Initialize Login Flow for browsers
538
+ # This endpoint initializes a browser-based user login flow. Once initialized, the browser will be redirected to &#x60;selfservice.flows.login.ui_url&#x60; with the flow ID set as the query parameter &#x60;?flow&#x3D;&#x60;. If a valid user session exists already, the browser will be redirected to &#x60;urls.default_redirect_url&#x60; unless the query parameter &#x60;?refresh&#x3D;true&#x60; was set. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
539
+ # @param [Hash] opts the optional parameters
540
+ # @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.
541
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
542
+ def initialize_self_service_login_for_browsers_with_http_info(opts = {})
543
+ if @api_client.config.debugging
544
+ @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_login_for_browsers ...'
545
+ end
546
+ # resource path
547
+ local_var_path = '/self-service/login/browser'
548
+
549
+ # query parameters
550
+ query_params = opts[:query_params] || {}
551
+ query_params[:'refresh'] = opts[:'refresh'] if !opts[:'refresh'].nil?
552
+
553
+ # header parameters
554
+ header_params = opts[:header_params] || {}
555
+ # HTTP header 'Accept' (if needed)
556
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
557
+
558
+ # form parameters
559
+ form_params = opts[:form_params] || {}
560
+
561
+ # http body (model)
562
+ post_body = opts[:debug_body]
563
+
564
+ # return_type
565
+ return_type = opts[:debug_return_type]
566
+
567
+ # auth_names
568
+ auth_names = opts[:debug_auth_names] || []
569
+
570
+ new_options = opts.merge(
571
+ :operation => :"PublicApi.initialize_self_service_login_for_browsers",
572
+ :header_params => header_params,
573
+ :query_params => query_params,
574
+ :form_params => form_params,
575
+ :body => post_body,
576
+ :auth_names => auth_names,
577
+ :return_type => return_type
578
+ )
579
+
580
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
581
+ if @api_client.config.debugging
582
+ @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_login_for_browsers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
583
+ end
584
+ return data, status_code, headers
585
+ end
586
+
587
+ # Initialize Login Flow for Native Apps and API clients
525
588
  # This endpoint initiates a login flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing login flow call `/self-service/login/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks, including CSRF login attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
526
589
  # @param [Hash] opts the optional parameters
527
590
  # @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.
528
591
  # @return [LoginFlow]
529
- def initialize_self_service_login_via_api_flow(opts = {})
530
- data, _status_code, _headers = initialize_self_service_login_via_api_flow_with_http_info(opts)
592
+ def initialize_self_service_login_for_native_apps(opts = {})
593
+ data, _status_code, _headers = initialize_self_service_login_for_native_apps_with_http_info(opts)
531
594
  data
532
595
  end
533
596
 
534
- # Initialize Login Flow for API clients
597
+ # Initialize Login Flow for Native Apps and API clients
535
598
  # This endpoint initiates a login flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter &#x60;?refresh&#x3D;true&#x60; is set. To fetch an existing login flow call &#x60;/self-service/login/flows?flow&#x3D;&lt;flow_id&gt;&#x60;. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks, including CSRF login attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
536
599
  # @param [Hash] opts the optional parameters
537
600
  # @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.
538
601
  # @return [Array<(LoginFlow, Integer, Hash)>] LoginFlow data, response status code and response headers
539
- def initialize_self_service_login_via_api_flow_with_http_info(opts = {})
602
+ def initialize_self_service_login_for_native_apps_with_http_info(opts = {})
540
603
  if @api_client.config.debugging
541
- @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_login_via_api_flow ...'
604
+ @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_login_for_native_apps ...'
542
605
  end
543
606
  # resource path
544
607
  local_var_path = '/self-service/login/api'
@@ -565,7 +628,7 @@ module OryHydraClient
565
628
  auth_names = opts[:debug_auth_names] || []
566
629
 
567
630
  new_options = opts.merge(
568
- :operation => :"PublicApi.initialize_self_service_login_via_api_flow",
631
+ :operation => :"PublicApi.initialize_self_service_login_for_native_apps",
569
632
  :header_params => header_params,
570
633
  :query_params => query_params,
571
634
  :form_params => form_params,
@@ -576,30 +639,30 @@ module OryHydraClient
576
639
 
577
640
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
578
641
  if @api_client.config.debugging
579
- @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_login_via_api_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
642
+ @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_login_for_native_apps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
580
643
  end
581
644
  return data, status_code, headers
582
645
  end
583
646
 
584
- # Initialize Login Flow for browsers
585
- # This endpoint initializes a browser-based user login flow. Once initialized, the browser will be redirected to `selfservice.flows.login.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url` unless the query parameter `?refresh=true` was set. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
647
+ # Initialize Recovery Flow for Browser Clients
648
+ # This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to `selfservice.flows.recovery.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists, the browser is returned to the configured return URL. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
586
649
  # @param [Hash] opts the optional parameters
587
650
  # @return [nil]
588
- def initialize_self_service_login_via_browser_flow(opts = {})
589
- initialize_self_service_login_via_browser_flow_with_http_info(opts)
651
+ def initialize_self_service_recovery_for_browsers(opts = {})
652
+ initialize_self_service_recovery_for_browsers_with_http_info(opts)
590
653
  nil
591
654
  end
592
655
 
593
- # Initialize Login Flow for browsers
594
- # This endpoint initializes a browser-based user login flow. Once initialized, the browser will be redirected to &#x60;selfservice.flows.login.ui_url&#x60; with the flow ID set as the query parameter &#x60;?flow&#x3D;&#x60;. If a valid user session exists already, the browser will be redirected to &#x60;urls.default_redirect_url&#x60; unless the query parameter &#x60;?refresh&#x3D;true&#x60; was set. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
656
+ # Initialize Recovery Flow for Browser Clients
657
+ # This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to &#x60;selfservice.flows.recovery.ui_url&#x60; with the flow ID set as the query parameter &#x60;?flow&#x3D;&#x60;. If a valid user session exists, the browser is returned to the configured return URL. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
595
658
  # @param [Hash] opts the optional parameters
596
659
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
597
- def initialize_self_service_login_via_browser_flow_with_http_info(opts = {})
660
+ def initialize_self_service_recovery_for_browsers_with_http_info(opts = {})
598
661
  if @api_client.config.debugging
599
- @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_login_via_browser_flow ...'
662
+ @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_recovery_for_browsers ...'
600
663
  end
601
664
  # resource path
602
- local_var_path = '/self-service/login/browser'
665
+ local_var_path = '/self-service/recovery/browser'
603
666
 
604
667
  # query parameters
605
668
  query_params = opts[:query_params] || {}
@@ -622,7 +685,7 @@ module OryHydraClient
622
685
  auth_names = opts[:debug_auth_names] || []
623
686
 
624
687
  new_options = opts.merge(
625
- :operation => :"PublicApi.initialize_self_service_login_via_browser_flow",
688
+ :operation => :"PublicApi.initialize_self_service_recovery_for_browsers",
626
689
  :header_params => header_params,
627
690
  :query_params => query_params,
628
691
  :form_params => form_params,
@@ -633,27 +696,27 @@ module OryHydraClient
633
696
 
634
697
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
635
698
  if @api_client.config.debugging
636
- @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_login_via_browser_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
699
+ @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_recovery_for_browsers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
637
700
  end
638
701
  return data, status_code, headers
639
702
  end
640
703
 
641
- # Initialize Recovery Flow for API Clients
704
+ # Initialize Recovery Flow for Native Apps and API clients
642
705
  # This endpoint initiates a recovery flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error. To fetch an existing recovery flow call `/self-service/recovery/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
643
706
  # @param [Hash] opts the optional parameters
644
707
  # @return [RecoveryFlow]
645
- def initialize_self_service_recovery_via_api_flow(opts = {})
646
- data, _status_code, _headers = initialize_self_service_recovery_via_api_flow_with_http_info(opts)
708
+ def initialize_self_service_recovery_for_native_apps(opts = {})
709
+ data, _status_code, _headers = initialize_self_service_recovery_for_native_apps_with_http_info(opts)
647
710
  data
648
711
  end
649
712
 
650
- # Initialize Recovery Flow for API Clients
713
+ # Initialize Recovery Flow for Native Apps and API clients
651
714
  # This endpoint initiates a recovery flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error. To fetch an existing recovery flow call &#x60;/self-service/recovery/flows?flow&#x3D;&lt;flow_id&gt;&#x60;. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
652
715
  # @param [Hash] opts the optional parameters
653
716
  # @return [Array<(RecoveryFlow, Integer, Hash)>] RecoveryFlow data, response status code and response headers
654
- def initialize_self_service_recovery_via_api_flow_with_http_info(opts = {})
717
+ def initialize_self_service_recovery_for_native_apps_with_http_info(opts = {})
655
718
  if @api_client.config.debugging
656
- @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_recovery_via_api_flow ...'
719
+ @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_recovery_for_native_apps ...'
657
720
  end
658
721
  # resource path
659
722
  local_var_path = '/self-service/recovery/api'
@@ -679,7 +742,7 @@ module OryHydraClient
679
742
  auth_names = opts[:debug_auth_names] || []
680
743
 
681
744
  new_options = opts.merge(
682
- :operation => :"PublicApi.initialize_self_service_recovery_via_api_flow",
745
+ :operation => :"PublicApi.initialize_self_service_recovery_for_native_apps",
683
746
  :header_params => header_params,
684
747
  :query_params => query_params,
685
748
  :form_params => form_params,
@@ -690,30 +753,30 @@ module OryHydraClient
690
753
 
691
754
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
692
755
  if @api_client.config.debugging
693
- @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_recovery_via_api_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
756
+ @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_recovery_for_native_apps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
694
757
  end
695
758
  return data, status_code, headers
696
759
  end
697
760
 
698
- # Initialize Recovery Flow for Browser Clients
699
- # This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to `selfservice.flows.recovery.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists, the browser is returned to the configured return URL. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
761
+ # Initialize Registration Flow for browsers
762
+ # This endpoint initializes a browser-based user registration flow. Once initialized, the browser will be redirected to `selfservice.flows.registration.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url` unless the query parameter `?refresh=true` was set. :::note This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). ::: More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
700
763
  # @param [Hash] opts the optional parameters
701
764
  # @return [nil]
702
- def initialize_self_service_recovery_via_browser_flow(opts = {})
703
- initialize_self_service_recovery_via_browser_flow_with_http_info(opts)
765
+ def initialize_self_service_registration_for_browsers(opts = {})
766
+ initialize_self_service_registration_for_browsers_with_http_info(opts)
704
767
  nil
705
768
  end
706
769
 
707
- # Initialize Recovery Flow for Browser Clients
708
- # This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to &#x60;selfservice.flows.recovery.ui_url&#x60; with the flow ID set as the query parameter &#x60;?flow&#x3D;&#x60;. If a valid user session exists, the browser is returned to the configured return URL. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
770
+ # Initialize Registration Flow for browsers
771
+ # This endpoint initializes a browser-based user registration flow. Once initialized, the browser will be redirected to &#x60;selfservice.flows.registration.ui_url&#x60; with the flow ID set as the query parameter &#x60;?flow&#x3D;&#x60;. If a valid user session exists already, the browser will be redirected to &#x60;urls.default_redirect_url&#x60; unless the query parameter &#x60;?refresh&#x3D;true&#x60; was set. :::note This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). ::: More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
709
772
  # @param [Hash] opts the optional parameters
710
773
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
711
- def initialize_self_service_recovery_via_browser_flow_with_http_info(opts = {})
774
+ def initialize_self_service_registration_for_browsers_with_http_info(opts = {})
712
775
  if @api_client.config.debugging
713
- @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_recovery_via_browser_flow ...'
776
+ @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_registration_for_browsers ...'
714
777
  end
715
778
  # resource path
716
- local_var_path = '/self-service/recovery/browser'
779
+ local_var_path = '/self-service/registration/browser'
717
780
 
718
781
  # query parameters
719
782
  query_params = opts[:query_params] || {}
@@ -736,7 +799,7 @@ module OryHydraClient
736
799
  auth_names = opts[:debug_auth_names] || []
737
800
 
738
801
  new_options = opts.merge(
739
- :operation => :"PublicApi.initialize_self_service_recovery_via_browser_flow",
802
+ :operation => :"PublicApi.initialize_self_service_registration_for_browsers",
740
803
  :header_params => header_params,
741
804
  :query_params => query_params,
742
805
  :form_params => form_params,
@@ -747,27 +810,27 @@ module OryHydraClient
747
810
 
748
811
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
749
812
  if @api_client.config.debugging
750
- @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_recovery_via_browser_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
813
+ @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_registration_for_browsers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
751
814
  end
752
815
  return data, status_code, headers
753
816
  end
754
817
 
755
- # Initialize Registration Flow for API clients
818
+ # Initialize Registration Flow for Native Apps and API clients
756
819
  # This endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing registration flow call `/self-service/registration/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
757
820
  # @param [Hash] opts the optional parameters
758
821
  # @return [RegistrationFlow]
759
- def initialize_self_service_registration_via_api_flow(opts = {})
760
- data, _status_code, _headers = initialize_self_service_registration_via_api_flow_with_http_info(opts)
822
+ def initialize_self_service_registration_for_native_apps(opts = {})
823
+ data, _status_code, _headers = initialize_self_service_registration_for_native_apps_with_http_info(opts)
761
824
  data
762
825
  end
763
826
 
764
- # Initialize Registration Flow for API clients
827
+ # Initialize Registration Flow for Native Apps and API clients
765
828
  # This endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter &#x60;?refresh&#x3D;true&#x60; is set. To fetch an existing registration flow call &#x60;/self-service/registration/flows?flow&#x3D;&lt;flow_id&gt;&#x60;. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
766
829
  # @param [Hash] opts the optional parameters
767
830
  # @return [Array<(RegistrationFlow, Integer, Hash)>] RegistrationFlow data, response status code and response headers
768
- def initialize_self_service_registration_via_api_flow_with_http_info(opts = {})
831
+ def initialize_self_service_registration_for_native_apps_with_http_info(opts = {})
769
832
  if @api_client.config.debugging
770
- @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_registration_via_api_flow ...'
833
+ @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_registration_for_native_apps ...'
771
834
  end
772
835
  # resource path
773
836
  local_var_path = '/self-service/registration/api'
@@ -793,7 +856,7 @@ module OryHydraClient
793
856
  auth_names = opts[:debug_auth_names] || []
794
857
 
795
858
  new_options = opts.merge(
796
- :operation => :"PublicApi.initialize_self_service_registration_via_api_flow",
859
+ :operation => :"PublicApi.initialize_self_service_registration_for_native_apps",
797
860
  :header_params => header_params,
798
861
  :query_params => query_params,
799
862
  :form_params => form_params,
@@ -804,30 +867,30 @@ module OryHydraClient
804
867
 
805
868
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
806
869
  if @api_client.config.debugging
807
- @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_registration_via_api_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
870
+ @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_registration_for_native_apps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
808
871
  end
809
872
  return data, status_code, headers
810
873
  end
811
874
 
812
- # Initialize Registration Flow for browsers
813
- # This endpoint initializes a browser-based user registration flow. Once initialized, the browser will be redirected to `selfservice.flows.registration.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url` unless the query parameter `?refresh=true` was set. :::note This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). ::: More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
875
+ # Initialize Settings Flow for Browsers
876
+ # This endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid Ory Kratos Session Cookie is included in the request, a login flow will be initialized. :::note This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). ::: More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
814
877
  # @param [Hash] opts the optional parameters
815
878
  # @return [nil]
816
- def initialize_self_service_registration_via_browser_flow(opts = {})
817
- initialize_self_service_registration_via_browser_flow_with_http_info(opts)
879
+ def initialize_self_service_settings_for_browsers(opts = {})
880
+ initialize_self_service_settings_for_browsers_with_http_info(opts)
818
881
  nil
819
882
  end
820
883
 
821
- # Initialize Registration Flow for browsers
822
- # This endpoint initializes a browser-based user registration flow. Once initialized, the browser will be redirected to &#x60;selfservice.flows.registration.ui_url&#x60; with the flow ID set as the query parameter &#x60;?flow&#x3D;&#x60;. If a valid user session exists already, the browser will be redirected to &#x60;urls.default_redirect_url&#x60; unless the query parameter &#x60;?refresh&#x3D;true&#x60; was set. :::note This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). ::: More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
884
+ # Initialize Settings Flow for Browsers
885
+ # This endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to &#x60;selfservice.flows.settings.ui_url&#x60; with the flow ID set as the query parameter &#x60;?flow&#x3D;&#x60;. If no valid Ory Kratos Session Cookie is included in the request, a login flow will be initialized. :::note This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). ::: More information can be found at [Ory Kratos User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
823
886
  # @param [Hash] opts the optional parameters
824
887
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
825
- def initialize_self_service_registration_via_browser_flow_with_http_info(opts = {})
888
+ def initialize_self_service_settings_for_browsers_with_http_info(opts = {})
826
889
  if @api_client.config.debugging
827
- @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_registration_via_browser_flow ...'
890
+ @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_settings_for_browsers ...'
828
891
  end
829
892
  # resource path
830
- local_var_path = '/self-service/registration/browser'
893
+ local_var_path = '/self-service/settings/browser'
831
894
 
832
895
  # query parameters
833
896
  query_params = opts[:query_params] || {}
@@ -847,10 +910,10 @@ module OryHydraClient
847
910
  return_type = opts[:debug_return_type]
848
911
 
849
912
  # auth_names
850
- auth_names = opts[:debug_auth_names] || []
913
+ auth_names = opts[:debug_auth_names] || ['sessionToken']
851
914
 
852
915
  new_options = opts.merge(
853
- :operation => :"PublicApi.initialize_self_service_registration_via_browser_flow",
916
+ :operation => :"PublicApi.initialize_self_service_settings_for_browsers",
854
917
  :header_params => header_params,
855
918
  :query_params => query_params,
856
919
  :form_params => form_params,
@@ -861,27 +924,29 @@ module OryHydraClient
861
924
 
862
925
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
863
926
  if @api_client.config.debugging
864
- @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_registration_via_browser_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
927
+ @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_settings_for_browsers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
865
928
  end
866
929
  return data, status_code, headers
867
930
  end
868
931
 
869
- # Initialize Settings Flow for API Clients
932
+ # Initialize Settings Flow for Native Apps and API clients
870
933
  # This endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on. You must provide a valid Ory Kratos Session Token for this endpoint to respond with HTTP 200 OK. To fetch an existing settings flow call `/self-service/settings/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
871
934
  # @param [Hash] opts the optional parameters
935
+ # @option opts [String] :x_session_token The Session Token of the Identity performing the settings flow.
872
936
  # @return [SettingsFlow]
873
- def initialize_self_service_settings_via_api_flow(opts = {})
874
- data, _status_code, _headers = initialize_self_service_settings_via_api_flow_with_http_info(opts)
937
+ def initialize_self_service_settings_for_native_apps(opts = {})
938
+ data, _status_code, _headers = initialize_self_service_settings_for_native_apps_with_http_info(opts)
875
939
  data
876
940
  end
877
941
 
878
- # Initialize Settings Flow for API Clients
942
+ # Initialize Settings Flow for Native Apps and API clients
879
943
  # This endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on. You must provide a valid Ory Kratos Session Token for this endpoint to respond with HTTP 200 OK. To fetch an existing settings flow call &#x60;/self-service/settings/flows?flow&#x3D;&lt;flow_id&gt;&#x60;. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
880
944
  # @param [Hash] opts the optional parameters
945
+ # @option opts [String] :x_session_token The Session Token of the Identity performing the settings flow.
881
946
  # @return [Array<(SettingsFlow, Integer, Hash)>] SettingsFlow data, response status code and response headers
882
- def initialize_self_service_settings_via_api_flow_with_http_info(opts = {})
947
+ def initialize_self_service_settings_for_native_apps_with_http_info(opts = {})
883
948
  if @api_client.config.debugging
884
- @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_settings_via_api_flow ...'
949
+ @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_settings_for_native_apps ...'
885
950
  end
886
951
  # resource path
887
952
  local_var_path = '/self-service/settings/api'
@@ -893,6 +958,7 @@ module OryHydraClient
893
958
  header_params = opts[:header_params] || {}
894
959
  # HTTP header 'Accept' (if needed)
895
960
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
961
+ header_params[:'X-Session-Token'] = opts[:'x_session_token'] if !opts[:'x_session_token'].nil?
896
962
 
897
963
  # form parameters
898
964
  form_params = opts[:form_params] || {}
@@ -907,7 +973,7 @@ module OryHydraClient
907
973
  auth_names = opts[:debug_auth_names] || ['sessionToken']
908
974
 
909
975
  new_options = opts.merge(
910
- :operation => :"PublicApi.initialize_self_service_settings_via_api_flow",
976
+ :operation => :"PublicApi.initialize_self_service_settings_for_native_apps",
911
977
  :header_params => header_params,
912
978
  :query_params => query_params,
913
979
  :form_params => form_params,
@@ -918,30 +984,30 @@ module OryHydraClient
918
984
 
919
985
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
920
986
  if @api_client.config.debugging
921
- @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_settings_via_api_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
987
+ @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_settings_for_native_apps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
922
988
  end
923
989
  return data, status_code, headers
924
990
  end
925
991
 
926
- # Initialize Settings Flow for Browsers
927
- # This endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid Ory Kratos Session Cookie is included in the request, a login flow will be initialized. :::note This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). ::: More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
992
+ # Initialize Verification Flow for Browser Clients
993
+ # This endpoint initializes a browser-based account verification flow. Once initialized, the browser will be redirected to `selfservice.flows.verification.ui_url` with the flow ID set as the query parameter `?flow=`. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
928
994
  # @param [Hash] opts the optional parameters
929
995
  # @return [nil]
930
- def initialize_self_service_settings_via_browser_flow(opts = {})
931
- initialize_self_service_settings_via_browser_flow_with_http_info(opts)
996
+ def initialize_self_service_verification_for_browsers(opts = {})
997
+ initialize_self_service_verification_for_browsers_with_http_info(opts)
932
998
  nil
933
999
  end
934
1000
 
935
- # Initialize Settings Flow for Browsers
936
- # This endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to &#x60;selfservice.flows.settings.ui_url&#x60; with the flow ID set as the query parameter &#x60;?flow&#x3D;&#x60;. If no valid Ory Kratos Session Cookie is included in the request, a login flow will be initialized. :::note This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). ::: More information can be found at [Ory Kratos User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
1001
+ # Initialize Verification Flow for Browser Clients
1002
+ # This endpoint initializes a browser-based account verification flow. Once initialized, the browser will be redirected to &#x60;selfservice.flows.verification.ui_url&#x60; with the flow ID set as the query parameter &#x60;?flow&#x3D;&#x60;. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
937
1003
  # @param [Hash] opts the optional parameters
938
1004
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
939
- def initialize_self_service_settings_via_browser_flow_with_http_info(opts = {})
1005
+ def initialize_self_service_verification_for_browsers_with_http_info(opts = {})
940
1006
  if @api_client.config.debugging
941
- @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_settings_via_browser_flow ...'
1007
+ @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_verification_for_browsers ...'
942
1008
  end
943
1009
  # resource path
944
- local_var_path = '/self-service/settings/browser'
1010
+ local_var_path = '/self-service/verification/browser'
945
1011
 
946
1012
  # query parameters
947
1013
  query_params = opts[:query_params] || {}
@@ -961,10 +1027,10 @@ module OryHydraClient
961
1027
  return_type = opts[:debug_return_type]
962
1028
 
963
1029
  # auth_names
964
- auth_names = opts[:debug_auth_names] || ['sessionToken']
1030
+ auth_names = opts[:debug_auth_names] || []
965
1031
 
966
1032
  new_options = opts.merge(
967
- :operation => :"PublicApi.initialize_self_service_settings_via_browser_flow",
1033
+ :operation => :"PublicApi.initialize_self_service_verification_for_browsers",
968
1034
  :header_params => header_params,
969
1035
  :query_params => query_params,
970
1036
  :form_params => form_params,
@@ -975,27 +1041,27 @@ module OryHydraClient
975
1041
 
976
1042
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
977
1043
  if @api_client.config.debugging
978
- @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_settings_via_browser_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1044
+ @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_verification_for_browsers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
979
1045
  end
980
1046
  return data, status_code, headers
981
1047
  end
982
1048
 
983
- # Initialize Verification Flow for API Clients
1049
+ # Initialize Verification Flow for Native Apps and API clients
984
1050
  # This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. To fetch an existing verification flow call `/self-service/verification/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
985
1051
  # @param [Hash] opts the optional parameters
986
1052
  # @return [VerificationFlow]
987
- def initialize_self_service_verification_via_api_flow(opts = {})
988
- data, _status_code, _headers = initialize_self_service_verification_via_api_flow_with_http_info(opts)
1053
+ def initialize_self_service_verification_for_native_apps(opts = {})
1054
+ data, _status_code, _headers = initialize_self_service_verification_for_native_apps_with_http_info(opts)
989
1055
  data
990
1056
  end
991
1057
 
992
- # Initialize Verification Flow for API Clients
1058
+ # Initialize Verification Flow for Native Apps and API clients
993
1059
  # This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. To fetch an existing verification flow call &#x60;/self-service/verification/flows?flow&#x3D;&lt;flow_id&gt;&#x60;. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
994
1060
  # @param [Hash] opts the optional parameters
995
1061
  # @return [Array<(VerificationFlow, Integer, Hash)>] VerificationFlow data, response status code and response headers
996
- def initialize_self_service_verification_via_api_flow_with_http_info(opts = {})
1062
+ def initialize_self_service_verification_for_native_apps_with_http_info(opts = {})
997
1063
  if @api_client.config.debugging
998
- @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_verification_via_api_flow ...'
1064
+ @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_verification_for_native_apps ...'
999
1065
  end
1000
1066
  # resource path
1001
1067
  local_var_path = '/self-service/verification/api'
@@ -1021,7 +1087,7 @@ module OryHydraClient
1021
1087
  auth_names = opts[:debug_auth_names] || []
1022
1088
 
1023
1089
  new_options = opts.merge(
1024
- :operation => :"PublicApi.initialize_self_service_verification_via_api_flow",
1090
+ :operation => :"PublicApi.initialize_self_service_verification_for_native_apps",
1025
1091
  :header_params => header_params,
1026
1092
  :query_params => query_params,
1027
1093
  :form_params => form_params,
@@ -1032,64 +1098,7 @@ module OryHydraClient
1032
1098
 
1033
1099
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1034
1100
  if @api_client.config.debugging
1035
- @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_verification_via_api_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1036
- end
1037
- return data, status_code, headers
1038
- end
1039
-
1040
- # Initialize Verification Flow for Browser Clients
1041
- # This endpoint initializes a browser-based account verification flow. Once initialized, the browser will be redirected to `selfservice.flows.verification.ui_url` with the flow ID set as the query parameter `?flow=`. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
1042
- # @param [Hash] opts the optional parameters
1043
- # @return [nil]
1044
- def initialize_self_service_verification_via_browser_flow(opts = {})
1045
- initialize_self_service_verification_via_browser_flow_with_http_info(opts)
1046
- nil
1047
- end
1048
-
1049
- # Initialize Verification Flow for Browser Clients
1050
- # This endpoint initializes a browser-based account verification flow. Once initialized, the browser will be redirected to &#x60;selfservice.flows.verification.ui_url&#x60; with the flow ID set as the query parameter &#x60;?flow&#x3D;&#x60;. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
1051
- # @param [Hash] opts the optional parameters
1052
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1053
- def initialize_self_service_verification_via_browser_flow_with_http_info(opts = {})
1054
- if @api_client.config.debugging
1055
- @api_client.config.logger.debug 'Calling API: PublicApi.initialize_self_service_verification_via_browser_flow ...'
1056
- end
1057
- # resource path
1058
- local_var_path = '/self-service/verification/browser'
1059
-
1060
- # query parameters
1061
- query_params = opts[:query_params] || {}
1062
-
1063
- # header parameters
1064
- header_params = opts[:header_params] || {}
1065
- # HTTP header 'Accept' (if needed)
1066
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1067
-
1068
- # form parameters
1069
- form_params = opts[:form_params] || {}
1070
-
1071
- # http body (model)
1072
- post_body = opts[:debug_body]
1073
-
1074
- # return_type
1075
- return_type = opts[:debug_return_type]
1076
-
1077
- # auth_names
1078
- auth_names = opts[:debug_auth_names] || []
1079
-
1080
- new_options = opts.merge(
1081
- :operation => :"PublicApi.initialize_self_service_verification_via_browser_flow",
1082
- :header_params => header_params,
1083
- :query_params => query_params,
1084
- :form_params => form_params,
1085
- :body => post_body,
1086
- :auth_names => auth_names,
1087
- :return_type => return_type
1088
- )
1089
-
1090
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1091
- if @api_client.config.debugging
1092
- @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_verification_via_browser_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1101
+ @api_client.config.logger.debug "API called: PublicApi#initialize_self_service_verification_for_native_apps\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1093
1102
  end
1094
1103
  return data, status_code, headers
1095
1104
  end
@@ -1434,6 +1443,7 @@ module OryHydraClient
1434
1443
  # Use this endpoint to complete a settings flow by sending an identity's updated password. This endpoint behaves differently for API and browser flows. API-initiated flows expect `application/json` to be sent in the body and respond with HTTP 200 and an application/json body with the session token on success; HTTP 302 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. HTTP 401 when the endpoint is called without a valid session token. HTTP 403 when `selfservice.flows.settings.privileged_session_max_age` was reached. Implies that the user needs to re-authenticate. Browser flows expect `application/x-www-form-urlencoded` to be sent in the body and responds with a HTTP 302 redirect to the post/after settings URL or the `return_to` value if it was set and if the flow succeeded; a HTTP 302 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise. a HTTP 302 redirect to the login endpoint when `selfservice.flows.settings.privileged_session_max_age` was reached. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
1435
1444
  # @param flow [String] The Settings Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/settings?flow&#x3D;abcde&#x60;).
1436
1445
  # @param [Hash] opts the optional parameters
1446
+ # @option opts [String] :x_session_token The Session Token of the Identity performing the settings flow.
1437
1447
  # @option opts [SubmitSelfServiceSettingsFlow] :submit_self_service_settings_flow
1438
1448
  # @return [SettingsViaApiResponse]
1439
1449
  def submit_self_service_settings_flow(flow, opts = {})
@@ -1445,6 +1455,7 @@ module OryHydraClient
1445
1455
  # Use this endpoint to complete a settings flow by sending an identity&#39;s updated password. This endpoint behaves differently for API and browser flows. API-initiated flows expect &#x60;application/json&#x60; to be sent in the body and respond with HTTP 200 and an application/json body with the session token on success; HTTP 302 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. HTTP 401 when the endpoint is called without a valid session token. HTTP 403 when &#x60;selfservice.flows.settings.privileged_session_max_age&#x60; was reached. Implies that the user needs to re-authenticate. Browser flows expect &#x60;application/x-www-form-urlencoded&#x60; to be sent in the body and responds with a HTTP 302 redirect to the post/after settings URL or the &#x60;return_to&#x60; value if it was set and if the flow succeeded; a HTTP 302 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise. a HTTP 302 redirect to the login endpoint when &#x60;selfservice.flows.settings.privileged_session_max_age&#x60; was reached. More information can be found at [Ory Kratos User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
1446
1456
  # @param flow [String] The Settings Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/settings?flow&#x3D;abcde&#x60;).
1447
1457
  # @param [Hash] opts the optional parameters
1458
+ # @option opts [String] :x_session_token The Session Token of the Identity performing the settings flow.
1448
1459
  # @option opts [SubmitSelfServiceSettingsFlow] :submit_self_service_settings_flow
1449
1460
  # @return [Array<(SettingsViaApiResponse, Integer, Hash)>] SettingsViaApiResponse data, response status code and response headers
1450
1461
  def submit_self_service_settings_flow_with_http_info(flow, opts = {})
@@ -1468,6 +1479,7 @@ module OryHydraClient
1468
1479
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1469
1480
  # HTTP header 'Content-Type'
1470
1481
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
1482
+ header_params[:'X-Session-Token'] = opts[:'x_session_token'] if !opts[:'x_session_token'].nil?
1471
1483
 
1472
1484
  # form parameters
1473
1485
  form_params = opts[:form_params] || {}
@@ -1567,25 +1579,23 @@ module OryHydraClient
1567
1579
  end
1568
1580
 
1569
1581
  # Check Who the Current HTTP Session Belongs To
1570
- # 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.
1582
+ # 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: AJAX calls. Remember to send credentials and set up CORS correctly! Reverse proxies and API Gateways Server-side calls - use the `X-Session-Token` header!
1571
1583
  # @param [Hash] opts the optional parameters
1572
- # @option opts [String] :cookie
1573
- # @option opts [String] :authorization
1584
+ # @option opts [String] :x_session_token
1574
1585
  # @return [Session]
1575
- def whoami(opts = {})
1576
- data, _status_code, _headers = whoami_with_http_info(opts)
1586
+ def to_session(opts = {})
1587
+ data, _status_code, _headers = to_session_with_http_info(opts)
1577
1588
  data
1578
1589
  end
1579
1590
 
1580
1591
  # Check Who the Current HTTP Session Belongs To
1581
- # 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.
1592
+ # 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: AJAX calls. Remember to send credentials and set up CORS correctly! Reverse proxies and API Gateways Server-side calls - use the &#x60;X-Session-Token&#x60; header!
1582
1593
  # @param [Hash] opts the optional parameters
1583
- # @option opts [String] :cookie
1584
- # @option opts [String] :authorization
1594
+ # @option opts [String] :x_session_token
1585
1595
  # @return [Array<(Session, Integer, Hash)>] Session data, response status code and response headers
1586
- def whoami_with_http_info(opts = {})
1596
+ def to_session_with_http_info(opts = {})
1587
1597
  if @api_client.config.debugging
1588
- @api_client.config.logger.debug 'Calling API: PublicApi.whoami ...'
1598
+ @api_client.config.logger.debug 'Calling API: PublicApi.to_session ...'
1589
1599
  end
1590
1600
  # resource path
1591
1601
  local_var_path = '/sessions/whoami'
@@ -1597,8 +1607,7 @@ module OryHydraClient
1597
1607
  header_params = opts[:header_params] || {}
1598
1608
  # HTTP header 'Accept' (if needed)
1599
1609
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1600
- header_params[:'Cookie'] = opts[:'cookie'] if !opts[:'cookie'].nil?
1601
- header_params[:'Authorization'] = opts[:'authorization'] if !opts[:'authorization'].nil?
1610
+ header_params[:'X-Session-Token'] = opts[:'x_session_token'] if !opts[:'x_session_token'].nil?
1602
1611
 
1603
1612
  # form parameters
1604
1613
  form_params = opts[:form_params] || {}
@@ -1610,10 +1619,10 @@ module OryHydraClient
1610
1619
  return_type = opts[:debug_return_type] || 'Session'
1611
1620
 
1612
1621
  # auth_names
1613
- auth_names = opts[:debug_auth_names] || ['sessionToken']
1622
+ auth_names = opts[:debug_auth_names] || ['sessionCookie']
1614
1623
 
1615
1624
  new_options = opts.merge(
1616
- :operation => :"PublicApi.whoami",
1625
+ :operation => :"PublicApi.to_session",
1617
1626
  :header_params => header_params,
1618
1627
  :query_params => query_params,
1619
1628
  :form_params => form_params,
@@ -1624,7 +1633,7 @@ module OryHydraClient
1624
1633
 
1625
1634
  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1626
1635
  if @api_client.config.debugging
1627
- @api_client.config.logger.debug "API called: PublicApi#whoami\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1636
+ @api_client.config.logger.debug "API called: PublicApi#to_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1628
1637
  end
1629
1638
  return data, status_code, headers
1630
1639
  end