ory-client 0.0.1.alpha12 → 0.0.1.alpha16

Sign up to get free protection for your applications and to get access to all the features.
Files changed (196) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +79 -97
  3. data/docs/AdminCreateIdentityBody.md +20 -0
  4. data/docs/AdminCreateSelfServiceRecoveryLinkBody.md +20 -0
  5. data/docs/AdminUpdateIdentityBody.md +22 -0
  6. data/docs/Identity.md +6 -0
  7. data/docs/IdentityState.md +15 -0
  8. data/docs/MetadataApi.md +254 -0
  9. data/docs/SelfServiceError.md +24 -0
  10. data/docs/SelfServiceLoginFlow.md +36 -0
  11. data/docs/SelfServiceLogoutUrl.md +18 -0
  12. data/docs/SelfServiceRecoveryFlow.md +32 -0
  13. data/docs/SelfServiceRecoveryFlowState.md +15 -0
  14. data/docs/SelfServiceRecoveryLink.md +20 -0
  15. data/docs/SelfServiceRegistrationFlow.md +30 -0
  16. data/docs/SelfServiceSettingsFlow.md +34 -0
  17. data/docs/SelfServiceSettingsFlowState.md +15 -0
  18. data/docs/SelfServiceVerificationFlow.md +32 -0
  19. data/docs/SelfServiceVerificationFlowState.md +15 -0
  20. data/docs/Session.md +4 -4
  21. data/docs/SubmitSelfServiceLoginFlowBody.md +76 -0
  22. data/docs/SubmitSelfServiceLoginFlowWithOidcMethodBody.md +22 -0
  23. data/docs/SubmitSelfServiceLoginFlowWithPasswordMethodBody.md +24 -0
  24. data/docs/SubmitSelfServiceLogoutFlowWithoutBrowserBody.md +18 -0
  25. data/docs/SubmitSelfServiceRecoveryFlowBody.md +75 -0
  26. data/docs/SubmitSelfServiceRecoveryFlowWithLinkMethodBody.md +22 -0
  27. data/docs/SubmitSelfServiceRegistrationFlowBody.md +76 -0
  28. data/docs/SubmitSelfServiceRegistrationFlowWithOidcMethodBody.md +22 -0
  29. data/docs/SubmitSelfServiceRegistrationFlowWithPasswordMethodBody.md +24 -0
  30. data/docs/SubmitSelfServiceSettingsFlowBody.md +79 -0
  31. data/docs/SubmitSelfServiceSettingsFlowWithOidcMethodBody.md +24 -0
  32. data/docs/SubmitSelfServiceSettingsFlowWithPasswordMethodBody.md +22 -0
  33. data/docs/SubmitSelfServiceSettingsFlowWithProfileMethodBody.md +22 -0
  34. data/docs/SubmitSelfServiceVerificationFlowBody.md +75 -0
  35. data/docs/SubmitSelfServiceVerificationFlowWithLinkMethodBody.md +22 -0
  36. data/docs/SuccessfulSelfServiceLoginWithoutBrowser.md +20 -0
  37. data/docs/SuccessfulSelfServiceRegistrationWithoutBrowser.md +22 -0
  38. data/docs/SuccessfulSelfServiceSettingsWithoutBrowser.md +20 -0
  39. data/docs/V0alpha1Api.md +2172 -0
  40. data/lib/ory-client.rb +36 -26
  41. data/lib/ory-client/api/default_api.rb +1 -1
  42. data/lib/ory-client/api/metadata_api.rb +248 -0
  43. data/lib/ory-client/api/v0alpha1_api.rb +2054 -0
  44. data/lib/ory-client/api_client.rb +1 -1
  45. data/lib/ory-client/api_error.rb +1 -1
  46. data/lib/ory-client/configuration.rb +2 -16
  47. data/lib/ory-client/models/admin_create_identity_body.rb +239 -0
  48. data/lib/ory-client/models/admin_create_self_service_recovery_link_body.rb +250 -0
  49. data/lib/ory-client/models/admin_update_identity_body.rb +248 -0
  50. data/lib/ory-client/models/authenticate_ok_body.rb +1 -1
  51. data/lib/ory-client/models/container_change_response_item.rb +1 -1
  52. data/lib/ory-client/models/container_create_created_body.rb +1 -1
  53. data/lib/ory-client/models/container_top_ok_body.rb +1 -1
  54. data/lib/ory-client/models/container_update_ok_body.rb +1 -1
  55. data/lib/ory-client/models/container_wait_ok_body.rb +1 -1
  56. data/lib/ory-client/models/container_wait_ok_body_error.rb +1 -1
  57. data/lib/ory-client/models/create_identity.rb +1 -1
  58. data/lib/ory-client/models/create_recovery_link.rb +1 -1
  59. data/lib/ory-client/models/error_response.rb +1 -1
  60. data/lib/ory-client/models/generic_error.rb +1 -1
  61. data/lib/ory-client/models/graph_driver_data.rb +1 -1
  62. data/lib/ory-client/models/health_not_ready_status.rb +1 -1
  63. data/lib/ory-client/models/health_status.rb +1 -1
  64. data/lib/ory-client/models/id_response.rb +1 -1
  65. data/lib/ory-client/models/identity.rb +32 -2
  66. data/lib/ory-client/models/identity_credentials.rb +1 -1
  67. data/lib/ory-client/models/identity_state.rb +37 -0
  68. data/lib/ory-client/models/image_delete_response_item.rb +1 -1
  69. data/lib/ory-client/models/image_summary.rb +1 -1
  70. data/lib/ory-client/models/inline_response200.rb +1 -1
  71. data/lib/ory-client/models/inline_response2001.rb +1 -1
  72. data/lib/ory-client/models/inline_response503.rb +1 -1
  73. data/lib/ory-client/models/json_error.rb +1 -1
  74. data/lib/ory-client/models/login_flow.rb +1 -1
  75. data/lib/ory-client/models/login_via_api_response.rb +1 -1
  76. data/lib/ory-client/models/meta.rb +1 -1
  77. data/lib/ory-client/models/plugin.rb +1 -1
  78. data/lib/ory-client/models/plugin_config.rb +1 -1
  79. data/lib/ory-client/models/plugin_config_args.rb +1 -1
  80. data/lib/ory-client/models/plugin_config_interface.rb +1 -1
  81. data/lib/ory-client/models/plugin_config_linux.rb +1 -1
  82. data/lib/ory-client/models/plugin_config_network.rb +1 -1
  83. data/lib/ory-client/models/plugin_config_rootfs.rb +1 -1
  84. data/lib/ory-client/models/plugin_config_user.rb +1 -1
  85. data/lib/ory-client/models/plugin_device.rb +1 -1
  86. data/lib/ory-client/models/plugin_env.rb +1 -1
  87. data/lib/ory-client/models/plugin_interface_type.rb +1 -1
  88. data/lib/ory-client/models/plugin_mount.rb +1 -1
  89. data/lib/ory-client/models/plugin_settings.rb +1 -1
  90. data/lib/ory-client/models/port.rb +1 -1
  91. data/lib/ory-client/models/recovery_address.rb +1 -1
  92. data/lib/ory-client/models/recovery_flow.rb +1 -1
  93. data/lib/ory-client/models/recovery_link.rb +1 -1
  94. data/lib/ory-client/models/registration_flow.rb +1 -1
  95. data/lib/ory-client/models/registration_via_api_response.rb +1 -1
  96. data/lib/ory-client/models/revoke_session.rb +1 -1
  97. data/lib/ory-client/models/self_service_error.rb +252 -0
  98. data/lib/ory-client/models/self_service_error_container.rb +1 -1
  99. data/lib/ory-client/models/self_service_login_flow.rb +338 -0
  100. data/lib/ory-client/models/self_service_logout_url.rb +219 -0
  101. data/lib/ory-client/models/self_service_recovery_flow.rb +317 -0
  102. data/lib/ory-client/models/self_service_recovery_flow_state.rb +38 -0
  103. data/lib/ory-client/models/self_service_recovery_link.rb +234 -0
  104. data/lib/ory-client/models/self_service_registration_flow.rb +302 -0
  105. data/lib/ory-client/models/self_service_settings_flow.rb +331 -0
  106. data/lib/ory-client/models/self_service_settings_flow_state.rb +37 -0
  107. data/lib/ory-client/models/self_service_verification_flow.rb +307 -0
  108. data/lib/ory-client/models/self_service_verification_flow_state.rb +38 -0
  109. data/lib/ory-client/models/service_update_response.rb +1 -1
  110. data/lib/ory-client/models/session.rb +6 -16
  111. data/lib/ory-client/models/settings_flow.rb +1 -1
  112. data/lib/ory-client/models/settings_profile_form_config.rb +1 -1
  113. data/lib/ory-client/models/settings_via_api_response.rb +1 -1
  114. data/lib/ory-client/models/submit_self_service_browser_settings_oidc_flow_payload.rb +1 -1
  115. data/lib/ory-client/models/submit_self_service_login_flow.rb +1 -1
  116. data/lib/ory-client/models/submit_self_service_login_flow_body.rb +54 -0
  117. data/lib/ory-client/models/submit_self_service_login_flow_with_oidc_method_body.rb +250 -0
  118. data/lib/ory-client/models/submit_self_service_login_flow_with_password_method.rb +1 -1
  119. data/lib/ory-client/models/submit_self_service_login_flow_with_password_method_body.rb +298 -0
  120. data/lib/ory-client/models/submit_self_service_logout_flow_without_browser_body.rb +225 -0
  121. data/lib/ory-client/models/submit_self_service_recovery_flow_body.rb +53 -0
  122. data/lib/ory-client/models/submit_self_service_recovery_flow_with_link_method.rb +1 -1
  123. data/lib/ory-client/models/submit_self_service_recovery_flow_with_link_method_body.rb +283 -0
  124. data/lib/ory-client/models/submit_self_service_registration_flow.rb +1 -1
  125. data/lib/ory-client/models/submit_self_service_registration_flow_body.rb +54 -0
  126. data/lib/ory-client/models/submit_self_service_registration_flow_with_oidc_method_body.rb +250 -0
  127. data/lib/ory-client/models/submit_self_service_registration_flow_with_password_method.rb +1 -1
  128. data/lib/ory-client/models/submit_self_service_registration_flow_with_password_method_body.rb +299 -0
  129. data/lib/ory-client/models/submit_self_service_settings_flow.rb +1 -1
  130. data/lib/ory-client/models/submit_self_service_settings_flow_body.rb +56 -0
  131. data/lib/ory-client/models/submit_self_service_settings_flow_with_oidc_method_body.rb +255 -0
  132. data/lib/ory-client/models/submit_self_service_settings_flow_with_password_method.rb +1 -1
  133. data/lib/ory-client/models/submit_self_service_settings_flow_with_password_method_body.rb +283 -0
  134. data/lib/ory-client/models/submit_self_service_settings_flow_with_profile_method.rb +1 -1
  135. data/lib/ory-client/models/submit_self_service_settings_flow_with_profile_method_body.rb +250 -0
  136. data/lib/ory-client/models/submit_self_service_verification_flow_body.rb +54 -0
  137. data/lib/ory-client/models/submit_self_service_verification_flow_with_link_method.rb +1 -1
  138. data/lib/ory-client/models/submit_self_service_verification_flow_with_link_method_body.rb +283 -0
  139. data/lib/ory-client/models/successful_self_service_login_without_browser.rb +234 -0
  140. data/lib/ory-client/models/successful_self_service_registration_without_browser.rb +243 -0
  141. data/lib/ory-client/models/successful_self_service_settings_without_browser.rb +238 -0
  142. data/lib/ory-client/models/ui_container.rb +1 -1
  143. data/lib/ory-client/models/ui_node.rb +1 -1
  144. data/lib/ory-client/models/ui_node_anchor_attributes.rb +1 -1
  145. data/lib/ory-client/models/ui_node_attributes.rb +1 -1
  146. data/lib/ory-client/models/ui_node_image_attributes.rb +1 -1
  147. data/lib/ory-client/models/ui_node_input_attributes.rb +1 -1
  148. data/lib/ory-client/models/ui_node_text_attributes.rb +1 -1
  149. data/lib/ory-client/models/ui_text.rb +1 -1
  150. data/lib/ory-client/models/update_identity.rb +1 -1
  151. data/lib/ory-client/models/verifiable_identity_address.rb +1 -1
  152. data/lib/ory-client/models/verification_flow.rb +1 -1
  153. data/lib/ory-client/models/version.rb +1 -1
  154. data/lib/ory-client/models/volume.rb +1 -1
  155. data/lib/ory-client/models/volume_usage_data.rb +1 -1
  156. data/lib/ory-client/version.rb +2 -2
  157. data/ory-client.gemspec +1 -1
  158. data/spec/api/metadata_api_spec.rb +79 -0
  159. data/spec/api/v0alpha1_api_spec.rb +429 -0
  160. data/spec/api_client_spec.rb +1 -1
  161. data/spec/configuration_spec.rb +1 -1
  162. data/spec/models/admin_create_identity_body_spec.rb +40 -0
  163. data/spec/models/admin_create_self_service_recovery_link_body_spec.rb +40 -0
  164. data/spec/models/admin_update_identity_body_spec.rb +46 -0
  165. data/spec/models/identity_state_spec.rb +28 -0
  166. data/spec/models/self_service_error_spec.rb +52 -0
  167. data/spec/models/self_service_login_flow_spec.rb +88 -0
  168. data/spec/models/self_service_logout_url_spec.rb +34 -0
  169. data/spec/models/self_service_recovery_flow_spec.rb +76 -0
  170. data/spec/models/self_service_recovery_flow_state_spec.rb +28 -0
  171. data/spec/models/self_service_recovery_link_spec.rb +40 -0
  172. data/spec/models/self_service_registration_flow_spec.rb +70 -0
  173. data/spec/models/self_service_settings_flow_spec.rb +82 -0
  174. data/spec/models/self_service_settings_flow_state_spec.rb +28 -0
  175. data/spec/models/self_service_verification_flow_spec.rb +76 -0
  176. data/spec/models/self_service_verification_flow_state_spec.rb +28 -0
  177. data/spec/models/submit_self_service_login_flow_body_spec.rb +43 -0
  178. data/spec/models/submit_self_service_login_flow_with_oidc_method_body_spec.rb +46 -0
  179. data/spec/models/submit_self_service_login_flow_with_password_method_body_spec.rb +56 -0
  180. data/spec/models/submit_self_service_logout_flow_without_browser_body_spec.rb +34 -0
  181. data/spec/models/submit_self_service_recovery_flow_body_spec.rb +43 -0
  182. data/spec/models/submit_self_service_recovery_flow_with_link_method_body_spec.rb +50 -0
  183. data/spec/models/submit_self_service_registration_flow_body_spec.rb +43 -0
  184. data/spec/models/submit_self_service_registration_flow_with_oidc_method_body_spec.rb +46 -0
  185. data/spec/models/submit_self_service_registration_flow_with_password_method_body_spec.rb +56 -0
  186. data/spec/models/submit_self_service_settings_flow_body_spec.rb +43 -0
  187. data/spec/models/submit_self_service_settings_flow_with_oidc_method_body_spec.rb +52 -0
  188. data/spec/models/submit_self_service_settings_flow_with_password_method_body_spec.rb +50 -0
  189. data/spec/models/submit_self_service_settings_flow_with_profile_method_body_spec.rb +46 -0
  190. data/spec/models/submit_self_service_verification_flow_body_spec.rb +43 -0
  191. data/spec/models/submit_self_service_verification_flow_with_link_method_body_spec.rb +50 -0
  192. data/spec/models/successful_self_service_login_without_browser_spec.rb +40 -0
  193. data/spec/models/successful_self_service_registration_without_browser_spec.rb +46 -0
  194. data/spec/models/successful_self_service_settings_without_browser_spec.rb +40 -0
  195. data/spec/spec_helper.rb +1 -1
  196. metadata +142 -2
@@ -0,0 +1,429 @@
1
+ =begin
2
+ #Ory APIs
3
+
4
+ #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
5
+
6
+ The version of the OpenAPI document: v0.0.1-alpha.16
7
+ Contact: support@ory.sh
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.1.1
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+
16
+ # Unit tests for OryHydraClient::V0alpha1Api
17
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
18
+ # Please update as you see appropriate
19
+ describe 'V0alpha1Api' do
20
+ before do
21
+ # run before each test
22
+ @api_instance = OryHydraClient::V0alpha1Api.new
23
+ end
24
+
25
+ after do
26
+ # run after each test
27
+ end
28
+
29
+ describe 'test an instance of V0alpha1Api' do
30
+ it 'should create an instance of V0alpha1Api' do
31
+ expect(@api_instance).to be_instance_of(OryHydraClient::V0alpha1Api)
32
+ end
33
+ end
34
+
35
+ # unit tests for admin_create_identity
36
+ # Create an Identity
37
+ # This endpoint creates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
38
+ # @param [Hash] opts the optional parameters
39
+ # @option opts [AdminCreateIdentityBody] :admin_create_identity_body
40
+ # @return [Identity]
41
+ describe 'admin_create_identity test' do
42
+ it 'should work' do
43
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
44
+ end
45
+ end
46
+
47
+ # unit tests for admin_create_self_service_recovery_link
48
+ # Create a Recovery Link
49
+ # This endpoint creates a recovery link which should be given to the user in order for them to recover (or activate) their account.
50
+ # @param [Hash] opts the optional parameters
51
+ # @option opts [AdminCreateSelfServiceRecoveryLinkBody] :admin_create_self_service_recovery_link_body
52
+ # @return [SelfServiceRecoveryLink]
53
+ describe 'admin_create_self_service_recovery_link test' do
54
+ it 'should work' do
55
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
56
+ end
57
+ end
58
+
59
+ # unit tests for admin_delete_identity
60
+ # Delete an Identity
61
+ # Calling this endpoint irrecoverably and permanently deletes the identity given its ID. This action can not be undone. This endpoint returns 204 when the identity was deleted or when the identity was not found, in which case it is assumed that is has been deleted already. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
62
+ # @param id ID is the identity's ID.
63
+ # @param [Hash] opts the optional parameters
64
+ # @return [nil]
65
+ describe 'admin_delete_identity test' do
66
+ it 'should work' do
67
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
68
+ end
69
+ end
70
+
71
+ # unit tests for admin_get_identity
72
+ # Get an Identity
73
+ # Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
74
+ # @param id ID must be set to the ID of identity you want to get
75
+ # @param [Hash] opts the optional parameters
76
+ # @return [Identity]
77
+ describe 'admin_get_identity test' do
78
+ it 'should work' do
79
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
80
+ end
81
+ end
82
+
83
+ # unit tests for admin_list_identities
84
+ # List Identities
85
+ # Lists all identities. Does not support search at the moment. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
86
+ # @param [Hash] opts the optional parameters
87
+ # @option opts [Integer] :per_page Items per Page This is the number of items per page.
88
+ # @option opts [Integer] :page Pagination Page
89
+ # @return [Array<Identity>]
90
+ describe 'admin_list_identities test' do
91
+ it 'should work' do
92
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
93
+ end
94
+ end
95
+
96
+ # unit tests for admin_update_identity
97
+ # Update an Identity
98
+ # This endpoint updates an identity. It is NOT possible to set an identity&#39;s credentials (password, ...) using this method! A way to achieve that will be introduced in the future. The full identity payload (except credentials) is expected. This endpoint does not support patching. Learn how identities work in [Ory Kratos&#39; User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
99
+ # @param id ID must be set to the ID of identity you want to update
100
+ # @param [Hash] opts the optional parameters
101
+ # @option opts [AdminUpdateIdentityBody] :admin_update_identity_body
102
+ # @return [Identity]
103
+ describe 'admin_update_identity test' do
104
+ it 'should work' do
105
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
106
+ end
107
+ end
108
+
109
+ # unit tests for create_self_service_logout_flow_url_for_browsers
110
+ # Create a Logout URL for Browsers
111
+ # This endpoint initializes a browser-based user logout flow and a URL which can be used to log out the user. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). For API clients you can call the &#x60;/self-service/logout/api&#x60; URL directly with the Ory Session Token. The URL is only valid for the currently signed in user. If no user is signed in, this endpoint returns a 401 error. When calling this endpoint from a backend, please ensure to properly forward the HTTP cookies.
112
+ # @param [Hash] opts the optional parameters
113
+ # @option opts [String] :cookie HTTP Cookies If you call this endpoint from a backend, please include the original Cookie header in the request.
114
+ # @return [SelfServiceLogoutUrl]
115
+ describe 'create_self_service_logout_flow_url_for_browsers test' do
116
+ it 'should work' do
117
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
118
+ end
119
+ end
120
+
121
+ # unit tests for get_json_schema
122
+ # Get a JSON Schema
123
+ # @param id ID must be set to the ID of schema you want to get
124
+ # @param [Hash] opts the optional parameters
125
+ # @return [Object]
126
+ describe 'get_json_schema test' do
127
+ it 'should work' do
128
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
129
+ end
130
+ end
131
+
132
+ # unit tests for get_self_service_error
133
+ # Get Self-Service Errors
134
+ # 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;?id&#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).
135
+ # @param id Error is the error&#39;s ID
136
+ # @param [Hash] opts the optional parameters
137
+ # @return [SelfServiceError]
138
+ describe 'get_self_service_error test' do
139
+ it 'should work' do
140
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
141
+ end
142
+ end
143
+
144
+ # unit tests for get_self_service_login_flow
145
+ # Get Login Flow
146
+ # This endpoint returns a login flow&#39;s context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request&#39;s HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: &#x60;&#x60;&#x60;js pseudo-code example router.get(&#39;/login&#39;, async function (req, res) { const flow &#x3D; await client.getSelfServiceLoginFlow(req.header(&#39;cookie&#39;), req.query[&#39;flow&#39;]) res.render(&#39;login&#39;, flow) }) &#x60;&#x60;&#x60; 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
+ # @param id The Login Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/login?flow&#x3D;abcde&#x60;).
148
+ # @param [Hash] opts the optional parameters
149
+ # @option opts [String] :cookie HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.
150
+ # @return [SelfServiceLoginFlow]
151
+ describe 'get_self_service_login_flow test' do
152
+ it 'should work' do
153
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
154
+ end
155
+ end
156
+
157
+ # unit tests for get_self_service_recovery_flow
158
+ # Get Recovery Flow
159
+ # This endpoint returns a recovery flow&#39;s context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request&#39;s HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: &#x60;&#x60;&#x60;js pseudo-code example router.get(&#39;/recovery&#39;, async function (req, res) { const flow &#x3D; await client.getSelfServiceRecoveryFlow(req.header(&#39;Cookie&#39;), req.query[&#39;flow&#39;]) res.render(&#39;recovery&#39;, flow) }) &#x60;&#x60;&#x60; More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
160
+ # @param id The Flow ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/recovery?flow&#x3D;abcde&#x60;).
161
+ # @param [Hash] opts the optional parameters
162
+ # @option opts [String] :cookie HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.
163
+ # @return [SelfServiceRecoveryFlow]
164
+ describe 'get_self_service_recovery_flow test' do
165
+ it 'should work' do
166
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
167
+ end
168
+ end
169
+
170
+ # unit tests for get_self_service_registration_flow
171
+ # Get Registration Flow
172
+ # This endpoint returns a registration flow&#39;s context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request&#39;s HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: &#x60;&#x60;&#x60;js pseudo-code example router.get(&#39;/registration&#39;, async function (req, res) { const flow &#x3D; await client.getSelfServiceRegistrationFlow(req.header(&#39;cookie&#39;), req.query[&#39;flow&#39;]) res.render(&#39;registration&#39;, flow) }) &#x60;&#x60;&#x60; 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).
173
+ # @param id The Registration Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/registration?flow&#x3D;abcde&#x60;).
174
+ # @param [Hash] opts the optional parameters
175
+ # @option opts [String] :cookie HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.
176
+ # @return [SelfServiceRegistrationFlow]
177
+ describe 'get_self_service_registration_flow test' do
178
+ it 'should work' do
179
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
180
+ end
181
+ end
182
+
183
+ # unit tests for get_self_service_settings_flow
184
+ # Get Settings Flow
185
+ # 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).
186
+ # @param id 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;).
187
+ # @param [Hash] opts the optional parameters
188
+ # @option opts [String] :x_session_token The Session Token When using the SDK in an app without a browser, please include the session token here.
189
+ # @option opts [String] :cookie HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. You only need to do this for browser- based flows.
190
+ # @return [SelfServiceSettingsFlow]
191
+ describe 'get_self_service_settings_flow test' do
192
+ it 'should work' do
193
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
194
+ end
195
+ end
196
+
197
+ # unit tests for get_self_service_verification_flow
198
+ # Get Verification Flow
199
+ # This endpoint returns a verification flow&#39;s context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request&#39;s HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: &#x60;&#x60;&#x60;js pseudo-code example router.get(&#39;/recovery&#39;, async function (req, res) { const flow &#x3D; await client.getSelfServiceVerificationFlow(req.header(&#39;cookie&#39;), req.query[&#39;flow&#39;]) res.render(&#39;verification&#39;, flow) }) 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).
200
+ # @param id The Flow ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/verification?flow&#x3D;abcde&#x60;).
201
+ # @param [Hash] opts the optional parameters
202
+ # @option opts [String] :cookie HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.
203
+ # @return [SelfServiceVerificationFlow]
204
+ describe 'get_self_service_verification_flow test' do
205
+ it 'should work' do
206
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
207
+ end
208
+ end
209
+
210
+ # unit tests for initialize_self_service_login_flow_for_browsers
211
+ # Initialize Login Flow for Browsers
212
+ # This endpoint initializes a browser-based user login flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for browser-based flows. If this endpoint is opened as a link in the browser, it 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. If this endpoint is called via an AJAX request, the response contains the login flow without a redirect. This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
213
+ # @param [Hash] opts the optional parameters
214
+ # @option opts [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.
215
+ # @return [SelfServiceLoginFlow]
216
+ describe 'initialize_self_service_login_flow_for_browsers test' do
217
+ it 'should work' do
218
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
219
+ end
220
+ end
221
+
222
+ # unit tests for initialize_self_service_login_flow_without_browser
223
+ # Initialize Login Flow for APIs, Services, Apps, ...
224
+ # This endpoint initiates a login flow for API clients that do not use a browser, 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;. 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).
225
+ # @param [Hash] opts the optional parameters
226
+ # @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.
227
+ # @return [SelfServiceLoginFlow]
228
+ describe 'initialize_self_service_login_flow_without_browser test' do
229
+ it 'should work' do
230
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
231
+ end
232
+ end
233
+
234
+ # unit tests for initialize_self_service_recovery_flow_for_browsers
235
+ # Initialize Recovery Flow for Browsers
236
+ # 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. If this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects or a 400 bad request error if the user is already authenticated. This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
237
+ # @param [Hash] opts the optional parameters
238
+ # @return [SelfServiceRecoveryFlow]
239
+ describe 'initialize_self_service_recovery_flow_for_browsers test' do
240
+ it 'should work' do
241
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
242
+ end
243
+ end
244
+
245
+ # unit tests for initialize_self_service_recovery_flow_without_browser
246
+ # Initialize Recovery Flow for APIs, Services, Apps, ...
247
+ # 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;. 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).
248
+ # @param [Hash] opts the optional parameters
249
+ # @return [SelfServiceRecoveryFlow]
250
+ describe 'initialize_self_service_recovery_flow_without_browser test' do
251
+ it 'should work' do
252
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
253
+ end
254
+ end
255
+
256
+ # unit tests for initialize_self_service_registration_flow_for_browsers
257
+ # Initialize Registration Flow for Browsers
258
+ # This endpoint initializes a browser-based user registration flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for browser-based flows. :::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: If this endpoint is opened as a link in the browser, it 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;. If this endpoint is called via an AJAX request, the response contains the registration flow without a redirect. This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. 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).
259
+ # @param [Hash] opts the optional parameters
260
+ # @return [SelfServiceRegistrationFlow]
261
+ describe 'initialize_self_service_registration_flow_for_browsers test' do
262
+ it 'should work' do
263
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
264
+ end
265
+ end
266
+
267
+ # unit tests for initialize_self_service_registration_flow_without_browser
268
+ # Initialize Registration Flow for APIs, Services, Apps, ...
269
+ # 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;. 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).
270
+ # @param [Hash] opts the optional parameters
271
+ # @return [SelfServiceRegistrationFlow]
272
+ describe 'initialize_self_service_registration_flow_without_browser test' do
273
+ it 'should work' do
274
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
275
+ end
276
+ end
277
+
278
+ # unit tests for initialize_self_service_settings_flow_for_browsers
279
+ # Initialize Settings Flow for Browsers
280
+ # 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. If this endpoint is opened as a link in the browser, it 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 user session was set, the browser will be redirected to the login endpoint. If this endpoint is called via an AJAX request, the response contains the settings flow without any redirects or a 403 forbidden error if no valid session was set. This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
281
+ # @param [Hash] opts the optional parameters
282
+ # @option opts [String] :cookie The Session Cookie of the Identity performing the settings flow.
283
+ # @return [SelfServiceSettingsFlow]
284
+ describe 'initialize_self_service_settings_flow_for_browsers test' do
285
+ it 'should work' do
286
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
287
+ end
288
+ end
289
+
290
+ # unit tests for initialize_self_service_settings_flow_without_browser
291
+ # Initialize Settings Flow for APIs, Services, Apps, ...
292
+ # 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;. 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).
293
+ # @param [Hash] opts the optional parameters
294
+ # @option opts [String] :x_session_token The Session Token of the Identity performing the settings flow.
295
+ # @return [SelfServiceSettingsFlow]
296
+ describe 'initialize_self_service_settings_flow_without_browser test' do
297
+ it 'should work' do
298
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
299
+ end
300
+ end
301
+
302
+ # unit tests for initialize_self_service_verification_flow_for_browsers
303
+ # Initialize Verification Flow for Browser Clients
304
+ # 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;. If this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects. 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).
305
+ # @param [Hash] opts the optional parameters
306
+ # @return [SelfServiceVerificationFlow]
307
+ describe 'initialize_self_service_verification_flow_for_browsers test' do
308
+ it 'should work' do
309
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
310
+ end
311
+ end
312
+
313
+ # unit tests for initialize_self_service_verification_flow_without_browser
314
+ # Initialize Verification Flow for APIs, Services, Apps, ...
315
+ # 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;. 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).
316
+ # @param [Hash] opts the optional parameters
317
+ # @return [SelfServiceVerificationFlow]
318
+ describe 'initialize_self_service_verification_flow_without_browser test' do
319
+ it 'should work' do
320
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
321
+ end
322
+ end
323
+
324
+ # unit tests for submit_self_service_login_flow
325
+ # Submit a Login Flow
326
+ # :::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: Use this endpoint to complete a login flow. This endpoint behaves differently for API and browser flows. API flows expect &#x60;application/json&#x60; to be sent in the body and responds with HTTP 200 and a application/json body with the session token on success; HTTP 302 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. Browser flows expect a Content-Type of &#x60;application/x-www-form-urlencoded&#x60; or &#x60;application/json&#x60; to be sent in the body and respond with a HTTP 302 redirect to the post/after login URL or the &#x60;return_to&#x60; value if it was set and if the login succeeded; a HTTP 302 redirect to the login UI URL with the flow ID containing the validation errors otherwise. Browser flows with an accept header of &#x60;application/json&#x60; will not redirect but instead respond with HTTP 200 and a application/json body with the signed in identity and a &#x60;Set-Cookie&#x60; header on success; HTTP 302 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. 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).
327
+ # @param flow The Login Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/login?flow&#x3D;abcde&#x60;).
328
+ # @param [Hash] opts the optional parameters
329
+ # @option opts [SubmitSelfServiceLoginFlowBody] :submit_self_service_login_flow_body
330
+ # @return [SuccessfulSelfServiceLoginWithoutBrowser]
331
+ describe 'submit_self_service_login_flow test' do
332
+ it 'should work' do
333
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
334
+ end
335
+ end
336
+
337
+ # unit tests for submit_self_service_logout_flow
338
+ # Complete Self-Service Logout
339
+ # This endpoint logs out an identity in a self-service manner. If the &#x60;Accept&#x60; HTTP header is not set to &#x60;application/json&#x60;, the browser will be redirected (HTTP 302 Found) to the &#x60;return_to&#x60; parameter of the initial request or fall back to &#x60;urls.default_return_to&#x60;. If the &#x60;Accept&#x60; HTTP header is set to &#x60;application/json&#x60;, a 204 No Content response will be sent on successful logout instead. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). For API clients you can call the &#x60;/self-service/logout/api&#x60; URL directly with the Ory Session Token. More information can be found at [Ory Kratos User Logout Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-logout).
340
+ # @param [Hash] opts the optional parameters
341
+ # @option opts [String] :token A Valid Logout Token If you do not have a logout token because you only have a session cookie, call &#x60;/self-service/logout/urls&#x60; to generate a URL for this endpoint.
342
+ # @return [nil]
343
+ describe 'submit_self_service_logout_flow test' do
344
+ it 'should work' do
345
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
346
+ end
347
+ end
348
+
349
+ # unit tests for submit_self_service_logout_flow_without_browser
350
+ # Perform Logout for APIs, Services, Apps, ...
351
+ # Use this endpoint to log out an identity using an Ory Session Token. If the Ory Session Token was successfully revoked, the server returns a 204 No Content response. A 204 No Content response is also sent when the Ory Session Token has been revoked already before. If the Ory Session Token is malformed or does not exist a 403 Forbidden response will be returned. This endpoint does not remove any HTTP Cookies - use the Browser-Based Self-Service Logout Flow instead.
352
+ # @param submit_self_service_logout_flow_without_browser_body
353
+ # @param [Hash] opts the optional parameters
354
+ # @return [nil]
355
+ describe 'submit_self_service_logout_flow_without_browser test' do
356
+ it 'should work' do
357
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
358
+ end
359
+ end
360
+
361
+ # unit tests for submit_self_service_recovery_flow
362
+ # Complete Recovery Flow
363
+ # Use this endpoint to complete a recovery flow. This endpoint behaves differently for API and browser flows and has several states: &#x60;choose_method&#x60; expects &#x60;flow&#x60; (in the URL query) and &#x60;email&#x60; (in the body) to be sent and works with API- and Browser-initiated flows. For API clients and Browser clients with HTTP Header &#x60;Accept: application/json&#x60; it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid. and a HTTP 302 Found redirect with a fresh recovery flow if the flow was otherwise invalid (e.g. expired). For Browser clients without HTTP Header &#x60;Accept&#x60; or with &#x60;Accept: text/*&#x60; it returns a HTTP 302 Found redirect to the Recovery UI URL with the Recovery Flow ID appended. &#x60;sent_email&#x60; is the success state after &#x60;choose_method&#x60; for the &#x60;link&#x60; method and allows the user to request another recovery email. It works for both API and Browser-initiated flows and returns the same responses as the flow in &#x60;choose_method&#x60; state. &#x60;passed_challenge&#x60; expects a &#x60;token&#x60; to be sent in the URL query and given the nature of the flow (\&quot;sending a recovery link\&quot;) does not have any API capabilities. The server responds with a HTTP 302 Found redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Recover UI URL with a new Recovery Flow ID which contains an error message that the recovery link was invalid. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
364
+ # @param flow The Recovery Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/recovery?flow&#x3D;abcde&#x60;).
365
+ # @param [Hash] opts the optional parameters
366
+ # @option opts [String] :token Recovery Token The recovery token which completes the recovery request. If the token is invalid (e.g. expired) an error will be shown to the end-user. This parameter is usually set in a link and not used by any direct API call.
367
+ # @option opts [SubmitSelfServiceRecoveryFlowBody] :submit_self_service_recovery_flow_body
368
+ # @return [SelfServiceRecoveryFlow]
369
+ describe 'submit_self_service_recovery_flow test' do
370
+ it 'should work' do
371
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
372
+ end
373
+ end
374
+
375
+ # unit tests for submit_self_service_registration_flow
376
+ # Submit a Registration Flow
377
+ # Use this endpoint to complete a registration flow by sending an identity&#39;s traits and password. This endpoint behaves differently for API and browser flows. API flows expect &#x60;application/json&#x60; to be sent in the body and respond with HTTP 200 and a application/json body with the created identity success - if the session hook is configured the &#x60;session&#x60; and &#x60;session_token&#x60; will also be included; HTTP 302 redirect to a fresh registration flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. Browser flows expect a Content-Type of &#x60;application/x-www-form-urlencoded&#x60; or &#x60;application/json&#x60; to be sent in the body and respond with a HTTP 302 redirect to the post/after registration URL or the &#x60;return_to&#x60; value if it was set and if the registration succeeded; a HTTP 302 redirect to the registration UI URL with the flow ID containing the validation errors otherwise. Browser flows with an accept header of &#x60;application/json&#x60; will not redirect but instead respond with HTTP 200 and a application/json body with the signed in identity and a &#x60;Set-Cookie&#x60; header on success; HTTP 302 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. 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).
378
+ # @param flow The Registration Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/registration?flow&#x3D;abcde&#x60;).
379
+ # @param [Hash] opts the optional parameters
380
+ # @option opts [SubmitSelfServiceRegistrationFlowBody] :submit_self_service_registration_flow_body
381
+ # @return [SuccessfulSelfServiceRegistrationWithoutBrowser]
382
+ describe 'submit_self_service_registration_flow test' do
383
+ it 'should work' do
384
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
385
+ end
386
+ end
387
+
388
+ # unit tests for submit_self_service_settings_flow
389
+ # Complete Settings Flow
390
+ # 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 without HTTP Header &#x60;Accept&#x60; or with &#x60;Accept: text/*&#x60; respond 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. Browser flows with HTTP Header &#x60;Accept: application/json&#x60; respond with HTTP 200 and a application/json body with the signed in identity and a &#x60;Set-Cookie&#x60; header on success; HTTP 302 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 403 when the page is accessed without a session cookie. HTTP 400 on form validation errors. More information can be found at [Ory Kratos User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
391
+ # @param flow 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;).
392
+ # @param [Hash] opts the optional parameters
393
+ # @option opts [String] :x_session_token The Session Token of the Identity performing the settings flow.
394
+ # @option opts [SubmitSelfServiceSettingsFlowBody] :submit_self_service_settings_flow_body
395
+ # @return [SuccessfulSelfServiceSettingsWithoutBrowser]
396
+ describe 'submit_self_service_settings_flow test' do
397
+ it 'should work' do
398
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
399
+ end
400
+ end
401
+
402
+ # unit tests for submit_self_service_verification_flow
403
+ # Complete Verification Flow
404
+ # Use this endpoint to complete a verification flow. This endpoint behaves differently for API and browser flows and has several states: &#x60;choose_method&#x60; expects &#x60;flow&#x60; (in the URL query) and &#x60;email&#x60; (in the body) to be sent and works with API- and Browser-initiated flows. For API clients and Browser clients with HTTP Header &#x60;Accept: application/json&#x60; it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid and a HTTP 302 Found redirect with a fresh verification flow if the flow was otherwise invalid (e.g. expired). For Browser clients without HTTP Header &#x60;Accept&#x60; or with &#x60;Accept: text/*&#x60; it returns a HTTP 302 Found redirect to the Verification UI URL with the Verification Flow ID appended. &#x60;sent_email&#x60; is the success state after &#x60;choose_method&#x60; when using the &#x60;link&#x60; method and allows the user to request another verification email. It works for both API and Browser-initiated flows and returns the same responses as the flow in &#x60;choose_method&#x60; state. &#x60;passed_challenge&#x60; expects a &#x60;token&#x60; to be sent in the URL query and given the nature of the flow (\&quot;sending a verification link\&quot;) does not have any API capabilities. The server responds with a HTTP 302 Found redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Verification UI URL with a new Verification Flow ID which contains an error message that the verification link was invalid. More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
405
+ # @param flow The Verification Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/verification?flow&#x3D;abcde&#x60;).
406
+ # @param [Hash] opts the optional parameters
407
+ # @option opts [String] :token Verification Token The verification token which completes the verification request. If the token is invalid (e.g. expired) an error will be shown to the end-user. This parameter is usually set in a link and not used by any direct API call.
408
+ # @option opts [SubmitSelfServiceVerificationFlowBody] :submit_self_service_verification_flow_body
409
+ # @return [SelfServiceVerificationFlow]
410
+ describe 'submit_self_service_verification_flow test' do
411
+ it 'should work' do
412
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
413
+ end
414
+ end
415
+
416
+ # unit tests for to_session
417
+ # Check Who the Current HTTP Session Belongs To
418
+ # 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. If you call this endpoint from a server-side application, you must forward the HTTP Cookie Header to this endpoint: &#x60;&#x60;&#x60;js pseudo-code example router.get(&#39;/protected-endpoint&#39;, async function (req, res) { const session &#x3D; await client.toSession(undefined, req.header(&#39;cookie&#39;)) console.log(session) }) &#x60;&#x60;&#x60; When calling this endpoint from a non-browser application (e.g. mobile app) you must include the session token: &#x60;&#x60;&#x60;js pseudo-code example ... const session &#x3D; await client.toSession(\&quot;the-session-token\&quot;) console.log(session) &#x60;&#x60;&#x60; 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! This endpoint authenticates users by checking if the &#x60;Cookie&#x60; HTTP header was set containing an Ory Kratos Session Cookie; if the &#x60;Authorization: bearer &lt;ory-session-token&gt;&#x60; HTTP header was set with a valid Ory Kratos Session Token; if the &#x60;X-Session-Token&#x60; HTTP header was set with a valid Ory Kratos Session Token. If none of these headers are set or the cooke or token are invalid, the endpoint returns a HTTP 401 status code.
419
+ # @param [Hash] opts the optional parameters
420
+ # @option opts [String] :x_session_token Set the Session Token when calling from non-browser clients. A session token has a format of &#x60;MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj&#x60;.
421
+ # @option opts [String] :cookie Set the Cookie Header. This is especially useful when calling this endpoint from a server-side application. In that scenario you must include the HTTP Cookie Header which originally was included in the request to your server. An example of a session in the HTTP Cookie Header is: &#x60;ory_kratos_session&#x3D;a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f&#x3D;&#x3D;&#x60;. It is ok if more than one cookie are included here as all other cookies will be ignored.
422
+ # @return [Session]
423
+ describe 'to_session test' do
424
+ it 'should work' do
425
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
426
+ end
427
+ end
428
+
429
+ end
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
5
5
 
6
- The version of the OpenAPI document: v0.0.1-alpha.12
6
+ The version of the OpenAPI document: v0.0.1-alpha.16
7
7
  Contact: support@ory.sh
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.1
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
5
5
 
6
- The version of the OpenAPI document: v0.0.1-alpha.12
6
+ The version of the OpenAPI document: v0.0.1-alpha.16
7
7
  Contact: support@ory.sh
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.1
@@ -0,0 +1,40 @@
1
+ =begin
2
+ #Ory APIs
3
+
4
+ #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
5
+
6
+ The version of the OpenAPI document: v0.0.1-alpha.16
7
+ Contact: support@ory.sh
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.1.1
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for OryHydraClient::AdminCreateIdentityBody
18
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
+ # Please update as you see appropriate
20
+ describe OryHydraClient::AdminCreateIdentityBody do
21
+ let(:instance) { OryHydraClient::AdminCreateIdentityBody.new }
22
+
23
+ describe 'test an instance of AdminCreateIdentityBody' do
24
+ it 'should create an instance of AdminCreateIdentityBody' do
25
+ expect(instance).to be_instance_of(OryHydraClient::AdminCreateIdentityBody)
26
+ end
27
+ end
28
+ describe 'test attribute "schema_id"' do
29
+ it 'should work' do
30
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
31
+ end
32
+ end
33
+
34
+ describe 'test attribute "traits"' do
35
+ it 'should work' do
36
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
37
+ end
38
+ end
39
+
40
+ end