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

Sign up to get free protection for your applications and to get access to all the features.
Files changed (221) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +135 -145
  3. data/docs/AdminCreateIdentityBody.md +20 -0
  4. data/docs/AdminCreateSelfServiceRecoveryLinkBody.md +20 -0
  5. data/docs/AdminUpdateIdentityBody.md +22 -0
  6. data/docs/AuthenticateOKBody.md +2 -2
  7. data/docs/ContainerChangeResponseItem.md +2 -2
  8. data/docs/ContainerCreateCreatedBody.md +2 -2
  9. data/docs/ContainerTopOKBody.md +2 -2
  10. data/docs/ContainerUpdateOKBody.md +2 -2
  11. data/docs/ContainerWaitOKBody.md +2 -2
  12. data/docs/ContainerWaitOKBodyError.md +2 -2
  13. data/docs/ErrorResponse.md +2 -2
  14. data/docs/GenericError.md +3 -3
  15. data/docs/GraphDriverData.md +2 -2
  16. data/docs/HealthNotReadyStatus.md +2 -2
  17. data/docs/HealthStatus.md +2 -2
  18. data/docs/IdResponse.md +2 -2
  19. data/docs/Identity.md +8 -2
  20. data/docs/IdentityCredentials.md +2 -2
  21. data/docs/IdentityState.md +15 -0
  22. data/docs/ImageDeleteResponseItem.md +2 -2
  23. data/docs/ImageSummary.md +2 -2
  24. data/docs/InlineResponse200.md +2 -2
  25. data/docs/InlineResponse2001.md +2 -2
  26. data/docs/InlineResponse503.md +2 -2
  27. data/docs/JsonError.md +2 -2
  28. data/docs/Meta.md +2 -2
  29. data/docs/MetadataApi.md +254 -0
  30. data/docs/Plugin.md +2 -2
  31. data/docs/PluginConfig.md +2 -2
  32. data/docs/PluginConfigArgs.md +2 -2
  33. data/docs/PluginConfigInterface.md +2 -2
  34. data/docs/PluginConfigLinux.md +2 -2
  35. data/docs/PluginConfigNetwork.md +2 -2
  36. data/docs/PluginConfigRootfs.md +2 -2
  37. data/docs/PluginConfigUser.md +2 -2
  38. data/docs/PluginDevice.md +2 -2
  39. data/docs/PluginEnv.md +2 -2
  40. data/docs/PluginInterfaceType.md +2 -2
  41. data/docs/PluginMount.md +2 -2
  42. data/docs/PluginSettings.md +2 -2
  43. data/docs/Port.md +2 -2
  44. data/docs/RecoveryAddress.md +2 -2
  45. data/docs/SelfServiceError.md +24 -0
  46. data/docs/SelfServiceLoginFlow.md +36 -0
  47. data/docs/SelfServiceLogoutUrl.md +18 -0
  48. data/docs/SelfServiceRecoveryFlow.md +32 -0
  49. data/docs/SelfServiceRecoveryFlowState.md +15 -0
  50. data/docs/SelfServiceRecoveryLink.md +20 -0
  51. data/docs/SelfServiceRegistrationFlow.md +30 -0
  52. data/docs/SelfServiceSettingsFlow.md +34 -0
  53. data/docs/SelfServiceSettingsFlowState.md +15 -0
  54. data/docs/SelfServiceVerificationFlow.md +32 -0
  55. data/docs/SelfServiceVerificationFlowState.md +15 -0
  56. data/docs/ServiceUpdateResponse.md +2 -2
  57. data/docs/Session.md +6 -6
  58. data/docs/SettingsProfileFormConfig.md +2 -2
  59. data/docs/SubmitSelfServiceLoginFlowBody.md +76 -0
  60. data/docs/SubmitSelfServiceLoginFlowWithOidcMethodBody.md +22 -0
  61. data/docs/SubmitSelfServiceLoginFlowWithPasswordMethodBody.md +24 -0
  62. data/docs/SubmitSelfServiceLogoutFlowWithoutBrowserBody.md +18 -0
  63. data/docs/SubmitSelfServiceRecoveryFlowBody.md +75 -0
  64. data/docs/SubmitSelfServiceRecoveryFlowWithLinkMethodBody.md +22 -0
  65. data/docs/SubmitSelfServiceRegistrationFlowBody.md +76 -0
  66. data/docs/SubmitSelfServiceRegistrationFlowWithOidcMethodBody.md +22 -0
  67. data/docs/SubmitSelfServiceRegistrationFlowWithPasswordMethodBody.md +24 -0
  68. data/docs/SubmitSelfServiceSettingsFlowBody.md +79 -0
  69. data/docs/SubmitSelfServiceSettingsFlowWithOidcMethodBody.md +24 -0
  70. data/docs/SubmitSelfServiceSettingsFlowWithPasswordMethodBody.md +22 -0
  71. data/docs/SubmitSelfServiceSettingsFlowWithProfileMethodBody.md +22 -0
  72. data/docs/SubmitSelfServiceVerificationFlowBody.md +75 -0
  73. data/docs/SubmitSelfServiceVerificationFlowWithLinkMethodBody.md +22 -0
  74. data/docs/SuccessfulSelfServiceLoginWithoutBrowser.md +20 -0
  75. data/docs/SuccessfulSelfServiceRegistrationWithoutBrowser.md +22 -0
  76. data/docs/SuccessfulSelfServiceSettingsWithoutBrowser.md +20 -0
  77. data/docs/UiContainer.md +2 -2
  78. data/docs/UiNode.md +2 -2
  79. data/docs/UiNodeAnchorAttributes.md +2 -2
  80. data/docs/UiNodeAttributes.md +4 -4
  81. data/docs/UiNodeImageAttributes.md +2 -2
  82. data/docs/UiNodeInputAttributes.md +3 -3
  83. data/docs/UiNodeTextAttributes.md +2 -2
  84. data/docs/UiText.md +2 -2
  85. data/docs/V0alpha1Api.md +2177 -0
  86. data/docs/VerifiableIdentityAddress.md +2 -2
  87. data/docs/Version.md +2 -2
  88. data/docs/Volume.md +2 -2
  89. data/docs/VolumeUsageData.md +2 -2
  90. data/lib/ory-kratos-client/api/metadata_api.rb +248 -0
  91. data/lib/ory-kratos-client/api/v0alpha1_api.rb +2054 -0
  92. data/lib/ory-kratos-client/api_client.rb +4 -4
  93. data/lib/ory-kratos-client/api_error.rb +3 -3
  94. data/lib/ory-kratos-client/configuration.rb +5 -19
  95. data/lib/ory-kratos-client/models/admin_create_identity_body.rb +239 -0
  96. data/lib/ory-kratos-client/models/admin_create_self_service_recovery_link_body.rb +250 -0
  97. data/lib/ory-kratos-client/models/admin_update_identity_body.rb +248 -0
  98. data/lib/ory-kratos-client/models/authenticate_ok_body.rb +6 -6
  99. data/lib/ory-kratos-client/models/container_change_response_item.rb +6 -6
  100. data/lib/ory-kratos-client/models/container_create_created_body.rb +6 -6
  101. data/lib/ory-kratos-client/models/container_top_ok_body.rb +6 -6
  102. data/lib/ory-kratos-client/models/container_update_ok_body.rb +6 -6
  103. data/lib/ory-kratos-client/models/container_wait_ok_body.rb +6 -6
  104. data/lib/ory-kratos-client/models/container_wait_ok_body_error.rb +6 -6
  105. data/lib/ory-kratos-client/models/error_response.rb +6 -6
  106. data/lib/ory-kratos-client/models/generic_error.rb +8 -10
  107. data/lib/ory-kratos-client/models/graph_driver_data.rb +6 -6
  108. data/lib/ory-kratos-client/models/health_not_ready_status.rb +6 -6
  109. data/lib/ory-kratos-client/models/health_status.rb +6 -6
  110. data/lib/ory-kratos-client/models/id_response.rb +6 -6
  111. data/lib/ory-kratos-client/models/identity.rb +37 -7
  112. data/lib/ory-kratos-client/models/identity_credentials.rb +6 -6
  113. data/lib/ory-kratos-client/models/identity_state.rb +37 -0
  114. data/lib/ory-kratos-client/models/image_delete_response_item.rb +6 -6
  115. data/lib/ory-kratos-client/models/image_summary.rb +6 -6
  116. data/lib/ory-kratos-client/models/inline_response200.rb +6 -6
  117. data/lib/ory-kratos-client/models/inline_response2001.rb +6 -6
  118. data/lib/ory-kratos-client/models/inline_response503.rb +6 -6
  119. data/lib/ory-kratos-client/models/json_error.rb +6 -6
  120. data/lib/ory-kratos-client/models/meta.rb +6 -6
  121. data/lib/ory-kratos-client/models/plugin.rb +6 -6
  122. data/lib/ory-kratos-client/models/plugin_config.rb +6 -6
  123. data/lib/ory-kratos-client/models/plugin_config_args.rb +6 -6
  124. data/lib/ory-kratos-client/models/plugin_config_interface.rb +6 -6
  125. data/lib/ory-kratos-client/models/plugin_config_linux.rb +6 -6
  126. data/lib/ory-kratos-client/models/plugin_config_network.rb +6 -6
  127. data/lib/ory-kratos-client/models/plugin_config_rootfs.rb +6 -6
  128. data/lib/ory-kratos-client/models/plugin_config_user.rb +6 -6
  129. data/lib/ory-kratos-client/models/plugin_device.rb +6 -6
  130. data/lib/ory-kratos-client/models/plugin_env.rb +6 -6
  131. data/lib/ory-kratos-client/models/plugin_interface_type.rb +6 -6
  132. data/lib/ory-kratos-client/models/plugin_mount.rb +6 -6
  133. data/lib/ory-kratos-client/models/plugin_settings.rb +6 -6
  134. data/lib/ory-kratos-client/models/port.rb +6 -6
  135. data/lib/ory-kratos-client/models/recovery_address.rb +6 -6
  136. data/lib/ory-kratos-client/models/self_service_error.rb +252 -0
  137. data/lib/ory-kratos-client/models/self_service_login_flow.rb +338 -0
  138. data/lib/ory-kratos-client/models/self_service_logout_url.rb +219 -0
  139. data/lib/ory-kratos-client/models/self_service_recovery_flow.rb +317 -0
  140. data/lib/ory-kratos-client/models/self_service_recovery_flow_state.rb +38 -0
  141. data/lib/ory-kratos-client/models/self_service_recovery_link.rb +234 -0
  142. data/lib/ory-kratos-client/models/self_service_registration_flow.rb +302 -0
  143. data/lib/ory-kratos-client/models/self_service_settings_flow.rb +331 -0
  144. data/lib/ory-kratos-client/models/self_service_settings_flow_state.rb +37 -0
  145. data/lib/ory-kratos-client/models/self_service_verification_flow.rb +307 -0
  146. data/lib/ory-kratos-client/models/self_service_verification_flow_state.rb +38 -0
  147. data/lib/ory-kratos-client/models/service_update_response.rb +6 -6
  148. data/lib/ory-kratos-client/models/session.rb +11 -21
  149. data/lib/ory-kratos-client/models/settings_profile_form_config.rb +6 -6
  150. data/lib/ory-kratos-client/models/submit_self_service_login_flow_body.rb +54 -0
  151. data/lib/ory-kratos-client/models/submit_self_service_login_flow_with_oidc_method_body.rb +250 -0
  152. data/lib/ory-kratos-client/models/submit_self_service_login_flow_with_password_method_body.rb +298 -0
  153. data/lib/ory-kratos-client/models/submit_self_service_logout_flow_without_browser_body.rb +225 -0
  154. data/lib/ory-kratos-client/models/submit_self_service_recovery_flow_body.rb +53 -0
  155. data/lib/ory-kratos-client/models/submit_self_service_recovery_flow_with_link_method_body.rb +283 -0
  156. data/lib/ory-kratos-client/models/submit_self_service_registration_flow_body.rb +54 -0
  157. data/lib/ory-kratos-client/models/submit_self_service_registration_flow_with_oidc_method_body.rb +250 -0
  158. data/lib/ory-kratos-client/models/submit_self_service_registration_flow_with_password_method_body.rb +299 -0
  159. data/lib/ory-kratos-client/models/submit_self_service_settings_flow_body.rb +56 -0
  160. data/lib/ory-kratos-client/models/submit_self_service_settings_flow_with_oidc_method_body.rb +255 -0
  161. data/lib/ory-kratos-client/models/submit_self_service_settings_flow_with_password_method_body.rb +283 -0
  162. data/lib/ory-kratos-client/models/submit_self_service_settings_flow_with_profile_method_body.rb +250 -0
  163. data/lib/ory-kratos-client/models/submit_self_service_verification_flow_body.rb +54 -0
  164. data/lib/ory-kratos-client/models/submit_self_service_verification_flow_with_link_method_body.rb +283 -0
  165. data/lib/ory-kratos-client/models/successful_self_service_login_without_browser.rb +234 -0
  166. data/lib/ory-kratos-client/models/successful_self_service_registration_without_browser.rb +243 -0
  167. data/lib/ory-kratos-client/models/successful_self_service_settings_without_browser.rb +238 -0
  168. data/lib/ory-kratos-client/models/ui_container.rb +6 -6
  169. data/lib/ory-kratos-client/models/ui_node.rb +6 -6
  170. data/lib/ory-kratos-client/models/ui_node_anchor_attributes.rb +6 -6
  171. data/lib/ory-kratos-client/models/ui_node_attributes.rb +4 -4
  172. data/lib/ory-kratos-client/models/ui_node_image_attributes.rb +6 -6
  173. data/lib/ory-kratos-client/models/ui_node_input_attributes.rb +9 -7
  174. data/lib/ory-kratos-client/models/ui_node_text_attributes.rb +6 -6
  175. data/lib/ory-kratos-client/models/ui_text.rb +6 -6
  176. data/lib/ory-kratos-client/models/verifiable_identity_address.rb +6 -6
  177. data/lib/ory-kratos-client/models/version.rb +6 -6
  178. data/lib/ory-kratos-client/models/volume.rb +6 -6
  179. data/lib/ory-kratos-client/models/volume_usage_data.rb +6 -6
  180. data/lib/ory-kratos-client/version.rb +4 -4
  181. data/lib/ory-kratos-client.rb +39 -31
  182. data/ory-kratos-client.gemspec +3 -3
  183. data/spec/api/metadata_api_spec.rb +79 -0
  184. data/spec/api/v0alpha1_api_spec.rb +429 -0
  185. data/spec/api_client_spec.rb +31 -31
  186. data/spec/configuration_spec.rb +5 -5
  187. data/spec/models/admin_create_identity_body_spec.rb +40 -0
  188. data/spec/models/admin_create_self_service_recovery_link_body_spec.rb +40 -0
  189. data/spec/models/admin_update_identity_body_spec.rb +46 -0
  190. data/spec/models/identity_state_spec.rb +28 -0
  191. data/spec/models/self_service_error_spec.rb +52 -0
  192. data/spec/models/self_service_login_flow_spec.rb +88 -0
  193. data/spec/models/self_service_logout_url_spec.rb +34 -0
  194. data/spec/models/self_service_recovery_flow_spec.rb +76 -0
  195. data/spec/models/self_service_recovery_flow_state_spec.rb +28 -0
  196. data/spec/models/self_service_recovery_link_spec.rb +40 -0
  197. data/spec/models/self_service_registration_flow_spec.rb +70 -0
  198. data/spec/models/self_service_settings_flow_spec.rb +82 -0
  199. data/spec/models/self_service_settings_flow_state_spec.rb +28 -0
  200. data/spec/models/self_service_verification_flow_spec.rb +76 -0
  201. data/spec/models/self_service_verification_flow_state_spec.rb +28 -0
  202. data/spec/models/submit_self_service_login_flow_body_spec.rb +43 -0
  203. data/spec/models/submit_self_service_login_flow_with_oidc_method_body_spec.rb +46 -0
  204. data/spec/models/submit_self_service_login_flow_with_password_method_body_spec.rb +56 -0
  205. data/spec/models/submit_self_service_logout_flow_without_browser_body_spec.rb +34 -0
  206. data/spec/models/submit_self_service_recovery_flow_body_spec.rb +43 -0
  207. data/spec/models/submit_self_service_recovery_flow_with_link_method_body_spec.rb +50 -0
  208. data/spec/models/submit_self_service_registration_flow_body_spec.rb +43 -0
  209. data/spec/models/submit_self_service_registration_flow_with_oidc_method_body_spec.rb +46 -0
  210. data/spec/models/submit_self_service_registration_flow_with_password_method_body_spec.rb +56 -0
  211. data/spec/models/submit_self_service_settings_flow_body_spec.rb +43 -0
  212. data/spec/models/submit_self_service_settings_flow_with_oidc_method_body_spec.rb +52 -0
  213. data/spec/models/submit_self_service_settings_flow_with_password_method_body_spec.rb +50 -0
  214. data/spec/models/submit_self_service_settings_flow_with_profile_method_body_spec.rb +46 -0
  215. data/spec/models/submit_self_service_verification_flow_body_spec.rb +43 -0
  216. data/spec/models/submit_self_service_verification_flow_with_link_method_body_spec.rb +50 -0
  217. data/spec/models/successful_self_service_login_without_browser_spec.rb +40 -0
  218. data/spec/models/successful_self_service_registration_without_browser_spec.rb +46 -0
  219. data/spec/models/successful_self_service_settings_without_browser_spec.rb +40 -0
  220. data/spec/spec_helper.rb +2 -2
  221. metadata +145 -5
@@ -1,4 +1,4 @@
1
- # OryHydraClient::UiNodeImageAttributes
1
+ # OryKratosClient::UiNodeImageAttributes
2
2
 
3
3
  ## Properties
4
4
 
@@ -11,7 +11,7 @@
11
11
  ```ruby
12
12
  require 'ory-kratos-client'
13
13
 
14
- instance = OryHydraClient::UiNodeImageAttributes.new(
14
+ instance = OryKratosClient::UiNodeImageAttributes.new(
15
15
  src: null
16
16
  )
17
17
  ```
@@ -1,4 +1,4 @@
1
- # OryHydraClient::UiNodeInputAttributes
1
+ # OryKratosClient::UiNodeInputAttributes
2
2
 
3
3
  ## Properties
4
4
 
@@ -10,14 +10,14 @@
10
10
  | **pattern** | **String** | The input's pattern. | [optional] |
11
11
  | **required** | **Boolean** | Mark this input field as required. | [optional] |
12
12
  | **type** | **String** | | |
13
- | **value** | [**UiNodeInputAttributesValue**](UiNodeInputAttributesValue.md) | | [optional] |
13
+ | **value** | [**AnyType**](.md) | The input's value. | [optional] |
14
14
 
15
15
  ## Example
16
16
 
17
17
  ```ruby
18
18
  require 'ory-kratos-client'
19
19
 
20
- instance = OryHydraClient::UiNodeInputAttributes.new(
20
+ instance = OryKratosClient::UiNodeInputAttributes.new(
21
21
  disabled: null,
22
22
  label: null,
23
23
  name: null,
@@ -1,4 +1,4 @@
1
- # OryHydraClient::UiNodeTextAttributes
1
+ # OryKratosClient::UiNodeTextAttributes
2
2
 
3
3
  ## Properties
4
4
 
@@ -11,7 +11,7 @@
11
11
  ```ruby
12
12
  require 'ory-kratos-client'
13
13
 
14
- instance = OryHydraClient::UiNodeTextAttributes.new(
14
+ instance = OryKratosClient::UiNodeTextAttributes.new(
15
15
  text: null
16
16
  )
17
17
  ```
data/docs/UiText.md CHANGED
@@ -1,4 +1,4 @@
1
- # OryHydraClient::UiText
1
+ # OryKratosClient::UiText
2
2
 
3
3
  ## Properties
4
4
 
@@ -14,7 +14,7 @@
14
14
  ```ruby
15
15
  require 'ory-kratos-client'
16
16
 
17
- instance = OryHydraClient::UiText.new(
17
+ instance = OryKratosClient::UiText.new(
18
18
  context: null,
19
19
  id: null,
20
20
  text: null,
@@ -0,0 +1,2177 @@
1
+ # OryKratosClient::V0alpha1Api
2
+
3
+ All URIs are relative to *http://localhost*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**admin_create_identity**](V0alpha1Api.md#admin_create_identity) | **POST** /identities | Create an Identity |
8
+ | [**admin_create_self_service_recovery_link**](V0alpha1Api.md#admin_create_self_service_recovery_link) | **POST** /recovery/link | Create a Recovery Link |
9
+ | [**admin_delete_identity**](V0alpha1Api.md#admin_delete_identity) | **DELETE** /identities/{id} | Delete an Identity |
10
+ | [**admin_get_identity**](V0alpha1Api.md#admin_get_identity) | **GET** /identities/{id} | Get an Identity |
11
+ | [**admin_list_identities**](V0alpha1Api.md#admin_list_identities) | **GET** /identities | List Identities |
12
+ | [**admin_update_identity**](V0alpha1Api.md#admin_update_identity) | **PUT** /identities/{id} | Update an Identity |
13
+ | [**create_self_service_logout_flow_url_for_browsers**](V0alpha1Api.md#create_self_service_logout_flow_url_for_browsers) | **GET** /self-service/logout/browser | Create a Logout URL for Browsers |
14
+ | [**get_json_schema**](V0alpha1Api.md#get_json_schema) | **GET** /schemas/{id} | |
15
+ | [**get_self_service_error**](V0alpha1Api.md#get_self_service_error) | **GET** /self-service/errors | Get Self-Service Errors |
16
+ | [**get_self_service_login_flow**](V0alpha1Api.md#get_self_service_login_flow) | **GET** /self-service/login/flows | Get Login Flow |
17
+ | [**get_self_service_recovery_flow**](V0alpha1Api.md#get_self_service_recovery_flow) | **GET** /self-service/recovery/flows | Get Recovery Flow |
18
+ | [**get_self_service_registration_flow**](V0alpha1Api.md#get_self_service_registration_flow) | **GET** /self-service/registration/flows | Get Registration Flow |
19
+ | [**get_self_service_settings_flow**](V0alpha1Api.md#get_self_service_settings_flow) | **GET** /self-service/settings/flows | Get Settings Flow |
20
+ | [**get_self_service_verification_flow**](V0alpha1Api.md#get_self_service_verification_flow) | **GET** /self-service/verification/flows | Get Verification Flow |
21
+ | [**initialize_self_service_login_flow_for_browsers**](V0alpha1Api.md#initialize_self_service_login_flow_for_browsers) | **GET** /self-service/login/browser | Initialize Login Flow for Browsers |
22
+ | [**initialize_self_service_login_flow_without_browser**](V0alpha1Api.md#initialize_self_service_login_flow_without_browser) | **GET** /self-service/login/api | Initialize Login Flow for APIs, Services, Apps, ... |
23
+ | [**initialize_self_service_recovery_flow_for_browsers**](V0alpha1Api.md#initialize_self_service_recovery_flow_for_browsers) | **GET** /self-service/recovery/browser | Initialize Recovery Flow for Browsers |
24
+ | [**initialize_self_service_recovery_flow_without_browser**](V0alpha1Api.md#initialize_self_service_recovery_flow_without_browser) | **GET** /self-service/recovery/api | Initialize Recovery Flow for APIs, Services, Apps, ... |
25
+ | [**initialize_self_service_registration_flow_for_browsers**](V0alpha1Api.md#initialize_self_service_registration_flow_for_browsers) | **GET** /self-service/registration/browser | Initialize Registration Flow for Browsers |
26
+ | [**initialize_self_service_registration_flow_without_browser**](V0alpha1Api.md#initialize_self_service_registration_flow_without_browser) | **GET** /self-service/registration/api | Initialize Registration Flow for APIs, Services, Apps, ... |
27
+ | [**initialize_self_service_settings_flow_for_browsers**](V0alpha1Api.md#initialize_self_service_settings_flow_for_browsers) | **GET** /self-service/settings/browser | Initialize Settings Flow for Browsers |
28
+ | [**initialize_self_service_settings_flow_without_browser**](V0alpha1Api.md#initialize_self_service_settings_flow_without_browser) | **GET** /self-service/settings/api | Initialize Settings Flow for APIs, Services, Apps, ... |
29
+ | [**initialize_self_service_verification_flow_for_browsers**](V0alpha1Api.md#initialize_self_service_verification_flow_for_browsers) | **GET** /self-service/verification/browser | Initialize Verification Flow for Browser Clients |
30
+ | [**initialize_self_service_verification_flow_without_browser**](V0alpha1Api.md#initialize_self_service_verification_flow_without_browser) | **GET** /self-service/verification/api | Initialize Verification Flow for APIs, Services, Apps, ... |
31
+ | [**submit_self_service_login_flow**](V0alpha1Api.md#submit_self_service_login_flow) | **POST** /self-service/login | Submit a Login Flow |
32
+ | [**submit_self_service_logout_flow**](V0alpha1Api.md#submit_self_service_logout_flow) | **GET** /self-service/logout | Complete Self-Service Logout |
33
+ | [**submit_self_service_logout_flow_without_browser**](V0alpha1Api.md#submit_self_service_logout_flow_without_browser) | **DELETE** /self-service/logout/api | Perform Logout for APIs, Services, Apps, ... |
34
+ | [**submit_self_service_recovery_flow**](V0alpha1Api.md#submit_self_service_recovery_flow) | **POST** /self-service/recovery | Complete Recovery Flow |
35
+ | [**submit_self_service_registration_flow**](V0alpha1Api.md#submit_self_service_registration_flow) | **POST** /self-service/registration | Submit a Registration Flow |
36
+ | [**submit_self_service_settings_flow**](V0alpha1Api.md#submit_self_service_settings_flow) | **POST** /self-service/settings | Complete Settings Flow |
37
+ | [**submit_self_service_verification_flow**](V0alpha1Api.md#submit_self_service_verification_flow) | **POST** /self-service/verification | Complete Verification Flow |
38
+ | [**to_session**](V0alpha1Api.md#to_session) | **GET** /sessions/whoami | Check Who the Current HTTP Session Belongs To |
39
+
40
+
41
+ ## admin_create_identity
42
+
43
+ > <Identity> admin_create_identity(opts)
44
+
45
+ Create an Identity
46
+
47
+ 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).
48
+
49
+ ### Examples
50
+
51
+ ```ruby
52
+ require 'time'
53
+ require 'ory-kratos-client'
54
+ # setup authorization
55
+ OryKratosClient.configure do |config|
56
+ # Configure API key authorization: oryAccessToken
57
+ config.api_key['oryAccessToken'] = 'YOUR API KEY'
58
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
59
+ # config.api_key_prefix['oryAccessToken'] = 'Bearer'
60
+ end
61
+
62
+ api_instance = OryKratosClient::V0alpha1Api.new
63
+ opts = {
64
+ admin_create_identity_body: OryKratosClient::AdminCreateIdentityBody.new({schema_id: 'schema_id_example', traits: 3.56}) # AdminCreateIdentityBody |
65
+ }
66
+
67
+ begin
68
+ # Create an Identity
69
+ result = api_instance.admin_create_identity(opts)
70
+ p result
71
+ rescue OryKratosClient::ApiError => e
72
+ puts "Error when calling V0alpha1Api->admin_create_identity: #{e}"
73
+ end
74
+ ```
75
+
76
+ #### Using the admin_create_identity_with_http_info variant
77
+
78
+ This returns an Array which contains the response data, status code and headers.
79
+
80
+ > <Array(<Identity>, Integer, Hash)> admin_create_identity_with_http_info(opts)
81
+
82
+ ```ruby
83
+ begin
84
+ # Create an Identity
85
+ data, status_code, headers = api_instance.admin_create_identity_with_http_info(opts)
86
+ p status_code # => 2xx
87
+ p headers # => { ... }
88
+ p data # => <Identity>
89
+ rescue OryKratosClient::ApiError => e
90
+ puts "Error when calling V0alpha1Api->admin_create_identity_with_http_info: #{e}"
91
+ end
92
+ ```
93
+
94
+ ### Parameters
95
+
96
+ | Name | Type | Description | Notes |
97
+ | ---- | ---- | ----------- | ----- |
98
+ | **admin_create_identity_body** | [**AdminCreateIdentityBody**](AdminCreateIdentityBody.md) | | [optional] |
99
+
100
+ ### Return type
101
+
102
+ [**Identity**](Identity.md)
103
+
104
+ ### Authorization
105
+
106
+ [oryAccessToken](../README.md#oryAccessToken)
107
+
108
+ ### HTTP request headers
109
+
110
+ - **Content-Type**: application/json
111
+ - **Accept**: application/json
112
+
113
+
114
+ ## admin_create_self_service_recovery_link
115
+
116
+ > <SelfServiceRecoveryLink> admin_create_self_service_recovery_link(opts)
117
+
118
+ Create a Recovery Link
119
+
120
+ This endpoint creates a recovery link which should be given to the user in order for them to recover (or activate) their account.
121
+
122
+ ### Examples
123
+
124
+ ```ruby
125
+ require 'time'
126
+ require 'ory-kratos-client'
127
+
128
+ api_instance = OryKratosClient::V0alpha1Api.new
129
+ opts = {
130
+ admin_create_self_service_recovery_link_body: OryKratosClient::AdminCreateSelfServiceRecoveryLinkBody.new({identity_id: 'identity_id_example'}) # AdminCreateSelfServiceRecoveryLinkBody |
131
+ }
132
+
133
+ begin
134
+ # Create a Recovery Link
135
+ result = api_instance.admin_create_self_service_recovery_link(opts)
136
+ p result
137
+ rescue OryKratosClient::ApiError => e
138
+ puts "Error when calling V0alpha1Api->admin_create_self_service_recovery_link: #{e}"
139
+ end
140
+ ```
141
+
142
+ #### Using the admin_create_self_service_recovery_link_with_http_info variant
143
+
144
+ This returns an Array which contains the response data, status code and headers.
145
+
146
+ > <Array(<SelfServiceRecoveryLink>, Integer, Hash)> admin_create_self_service_recovery_link_with_http_info(opts)
147
+
148
+ ```ruby
149
+ begin
150
+ # Create a Recovery Link
151
+ data, status_code, headers = api_instance.admin_create_self_service_recovery_link_with_http_info(opts)
152
+ p status_code # => 2xx
153
+ p headers # => { ... }
154
+ p data # => <SelfServiceRecoveryLink>
155
+ rescue OryKratosClient::ApiError => e
156
+ puts "Error when calling V0alpha1Api->admin_create_self_service_recovery_link_with_http_info: #{e}"
157
+ end
158
+ ```
159
+
160
+ ### Parameters
161
+
162
+ | Name | Type | Description | Notes |
163
+ | ---- | ---- | ----------- | ----- |
164
+ | **admin_create_self_service_recovery_link_body** | [**AdminCreateSelfServiceRecoveryLinkBody**](AdminCreateSelfServiceRecoveryLinkBody.md) | | [optional] |
165
+
166
+ ### Return type
167
+
168
+ [**SelfServiceRecoveryLink**](SelfServiceRecoveryLink.md)
169
+
170
+ ### Authorization
171
+
172
+ No authorization required
173
+
174
+ ### HTTP request headers
175
+
176
+ - **Content-Type**: application/json
177
+ - **Accept**: application/json
178
+
179
+
180
+ ## admin_delete_identity
181
+
182
+ > admin_delete_identity(id)
183
+
184
+ Delete an Identity
185
+
186
+ 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).
187
+
188
+ ### Examples
189
+
190
+ ```ruby
191
+ require 'time'
192
+ require 'ory-kratos-client'
193
+ # setup authorization
194
+ OryKratosClient.configure do |config|
195
+ # Configure API key authorization: oryAccessToken
196
+ config.api_key['oryAccessToken'] = 'YOUR API KEY'
197
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
198
+ # config.api_key_prefix['oryAccessToken'] = 'Bearer'
199
+ end
200
+
201
+ api_instance = OryKratosClient::V0alpha1Api.new
202
+ id = 'id_example' # String | ID is the identity's ID.
203
+
204
+ begin
205
+ # Delete an Identity
206
+ api_instance.admin_delete_identity(id)
207
+ rescue OryKratosClient::ApiError => e
208
+ puts "Error when calling V0alpha1Api->admin_delete_identity: #{e}"
209
+ end
210
+ ```
211
+
212
+ #### Using the admin_delete_identity_with_http_info variant
213
+
214
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
215
+
216
+ > <Array(nil, Integer, Hash)> admin_delete_identity_with_http_info(id)
217
+
218
+ ```ruby
219
+ begin
220
+ # Delete an Identity
221
+ data, status_code, headers = api_instance.admin_delete_identity_with_http_info(id)
222
+ p status_code # => 2xx
223
+ p headers # => { ... }
224
+ p data # => nil
225
+ rescue OryKratosClient::ApiError => e
226
+ puts "Error when calling V0alpha1Api->admin_delete_identity_with_http_info: #{e}"
227
+ end
228
+ ```
229
+
230
+ ### Parameters
231
+
232
+ | Name | Type | Description | Notes |
233
+ | ---- | ---- | ----------- | ----- |
234
+ | **id** | **String** | ID is the identity&#39;s ID. | |
235
+
236
+ ### Return type
237
+
238
+ nil (empty response body)
239
+
240
+ ### Authorization
241
+
242
+ [oryAccessToken](../README.md#oryAccessToken)
243
+
244
+ ### HTTP request headers
245
+
246
+ - **Content-Type**: Not defined
247
+ - **Accept**: application/json
248
+
249
+
250
+ ## admin_get_identity
251
+
252
+ > <Identity> admin_get_identity(id)
253
+
254
+ Get an Identity
255
+
256
+ Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
257
+
258
+ ### Examples
259
+
260
+ ```ruby
261
+ require 'time'
262
+ require 'ory-kratos-client'
263
+ # setup authorization
264
+ OryKratosClient.configure do |config|
265
+ # Configure API key authorization: oryAccessToken
266
+ config.api_key['oryAccessToken'] = 'YOUR API KEY'
267
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
268
+ # config.api_key_prefix['oryAccessToken'] = 'Bearer'
269
+ end
270
+
271
+ api_instance = OryKratosClient::V0alpha1Api.new
272
+ id = 'id_example' # String | ID must be set to the ID of identity you want to get
273
+
274
+ begin
275
+ # Get an Identity
276
+ result = api_instance.admin_get_identity(id)
277
+ p result
278
+ rescue OryKratosClient::ApiError => e
279
+ puts "Error when calling V0alpha1Api->admin_get_identity: #{e}"
280
+ end
281
+ ```
282
+
283
+ #### Using the admin_get_identity_with_http_info variant
284
+
285
+ This returns an Array which contains the response data, status code and headers.
286
+
287
+ > <Array(<Identity>, Integer, Hash)> admin_get_identity_with_http_info(id)
288
+
289
+ ```ruby
290
+ begin
291
+ # Get an Identity
292
+ data, status_code, headers = api_instance.admin_get_identity_with_http_info(id)
293
+ p status_code # => 2xx
294
+ p headers # => { ... }
295
+ p data # => <Identity>
296
+ rescue OryKratosClient::ApiError => e
297
+ puts "Error when calling V0alpha1Api->admin_get_identity_with_http_info: #{e}"
298
+ end
299
+ ```
300
+
301
+ ### Parameters
302
+
303
+ | Name | Type | Description | Notes |
304
+ | ---- | ---- | ----------- | ----- |
305
+ | **id** | **String** | ID must be set to the ID of identity you want to get | |
306
+
307
+ ### Return type
308
+
309
+ [**Identity**](Identity.md)
310
+
311
+ ### Authorization
312
+
313
+ [oryAccessToken](../README.md#oryAccessToken)
314
+
315
+ ### HTTP request headers
316
+
317
+ - **Content-Type**: Not defined
318
+ - **Accept**: application/json
319
+
320
+
321
+ ## admin_list_identities
322
+
323
+ > <Array<Identity>> admin_list_identities(opts)
324
+
325
+ List Identities
326
+
327
+ 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).
328
+
329
+ ### Examples
330
+
331
+ ```ruby
332
+ require 'time'
333
+ require 'ory-kratos-client'
334
+ # setup authorization
335
+ OryKratosClient.configure do |config|
336
+ # Configure API key authorization: oryAccessToken
337
+ config.api_key['oryAccessToken'] = 'YOUR API KEY'
338
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
339
+ # config.api_key_prefix['oryAccessToken'] = 'Bearer'
340
+ end
341
+
342
+ api_instance = OryKratosClient::V0alpha1Api.new
343
+ opts = {
344
+ per_page: 789, # Integer | Items per Page This is the number of items per page.
345
+ page: 789 # Integer | Pagination Page
346
+ }
347
+
348
+ begin
349
+ # List Identities
350
+ result = api_instance.admin_list_identities(opts)
351
+ p result
352
+ rescue OryKratosClient::ApiError => e
353
+ puts "Error when calling V0alpha1Api->admin_list_identities: #{e}"
354
+ end
355
+ ```
356
+
357
+ #### Using the admin_list_identities_with_http_info variant
358
+
359
+ This returns an Array which contains the response data, status code and headers.
360
+
361
+ > <Array(<Array<Identity>>, Integer, Hash)> admin_list_identities_with_http_info(opts)
362
+
363
+ ```ruby
364
+ begin
365
+ # List Identities
366
+ data, status_code, headers = api_instance.admin_list_identities_with_http_info(opts)
367
+ p status_code # => 2xx
368
+ p headers # => { ... }
369
+ p data # => <Array<Identity>>
370
+ rescue OryKratosClient::ApiError => e
371
+ puts "Error when calling V0alpha1Api->admin_list_identities_with_http_info: #{e}"
372
+ end
373
+ ```
374
+
375
+ ### Parameters
376
+
377
+ | Name | Type | Description | Notes |
378
+ | ---- | ---- | ----------- | ----- |
379
+ | **per_page** | **Integer** | Items per Page This is the number of items per page. | [optional][default to 100] |
380
+ | **page** | **Integer** | Pagination Page | [optional][default to 0] |
381
+
382
+ ### Return type
383
+
384
+ [**Array&lt;Identity&gt;**](Identity.md)
385
+
386
+ ### Authorization
387
+
388
+ [oryAccessToken](../README.md#oryAccessToken)
389
+
390
+ ### HTTP request headers
391
+
392
+ - **Content-Type**: Not defined
393
+ - **Accept**: application/json
394
+
395
+
396
+ ## admin_update_identity
397
+
398
+ > <Identity> admin_update_identity(id, opts)
399
+
400
+ Update an Identity
401
+
402
+ This endpoint updates 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. The full identity payload (except credentials) is expected. This endpoint does not support patching. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
403
+
404
+ ### Examples
405
+
406
+ ```ruby
407
+ require 'time'
408
+ require 'ory-kratos-client'
409
+ # setup authorization
410
+ OryKratosClient.configure do |config|
411
+ # Configure API key authorization: oryAccessToken
412
+ config.api_key['oryAccessToken'] = 'YOUR API KEY'
413
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
414
+ # config.api_key_prefix['oryAccessToken'] = 'Bearer'
415
+ end
416
+
417
+ api_instance = OryKratosClient::V0alpha1Api.new
418
+ id = 'id_example' # String | ID must be set to the ID of identity you want to update
419
+ opts = {
420
+ admin_update_identity_body: OryKratosClient::AdminUpdateIdentityBody.new({state: OryKratosClient::IdentityState::ACTIVE, traits: 3.56}) # AdminUpdateIdentityBody |
421
+ }
422
+
423
+ begin
424
+ # Update an Identity
425
+ result = api_instance.admin_update_identity(id, opts)
426
+ p result
427
+ rescue OryKratosClient::ApiError => e
428
+ puts "Error when calling V0alpha1Api->admin_update_identity: #{e}"
429
+ end
430
+ ```
431
+
432
+ #### Using the admin_update_identity_with_http_info variant
433
+
434
+ This returns an Array which contains the response data, status code and headers.
435
+
436
+ > <Array(<Identity>, Integer, Hash)> admin_update_identity_with_http_info(id, opts)
437
+
438
+ ```ruby
439
+ begin
440
+ # Update an Identity
441
+ data, status_code, headers = api_instance.admin_update_identity_with_http_info(id, opts)
442
+ p status_code # => 2xx
443
+ p headers # => { ... }
444
+ p data # => <Identity>
445
+ rescue OryKratosClient::ApiError => e
446
+ puts "Error when calling V0alpha1Api->admin_update_identity_with_http_info: #{e}"
447
+ end
448
+ ```
449
+
450
+ ### Parameters
451
+
452
+ | Name | Type | Description | Notes |
453
+ | ---- | ---- | ----------- | ----- |
454
+ | **id** | **String** | ID must be set to the ID of identity you want to update | |
455
+ | **admin_update_identity_body** | [**AdminUpdateIdentityBody**](AdminUpdateIdentityBody.md) | | [optional] |
456
+
457
+ ### Return type
458
+
459
+ [**Identity**](Identity.md)
460
+
461
+ ### Authorization
462
+
463
+ [oryAccessToken](../README.md#oryAccessToken)
464
+
465
+ ### HTTP request headers
466
+
467
+ - **Content-Type**: application/json
468
+ - **Accept**: application/json
469
+
470
+
471
+ ## create_self_service_logout_flow_url_for_browsers
472
+
473
+ > <SelfServiceLogoutUrl> create_self_service_logout_flow_url_for_browsers(opts)
474
+
475
+ Create a Logout URL for Browsers
476
+
477
+ 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 `/self-service/logout/api` 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.
478
+
479
+ ### Examples
480
+
481
+ ```ruby
482
+ require 'time'
483
+ require 'ory-kratos-client'
484
+
485
+ api_instance = OryKratosClient::V0alpha1Api.new
486
+ opts = {
487
+ cookie: 'cookie_example' # String | HTTP Cookies If you call this endpoint from a backend, please include the original Cookie header in the request.
488
+ }
489
+
490
+ begin
491
+ # Create a Logout URL for Browsers
492
+ result = api_instance.create_self_service_logout_flow_url_for_browsers(opts)
493
+ p result
494
+ rescue OryKratosClient::ApiError => e
495
+ puts "Error when calling V0alpha1Api->create_self_service_logout_flow_url_for_browsers: #{e}"
496
+ end
497
+ ```
498
+
499
+ #### Using the create_self_service_logout_flow_url_for_browsers_with_http_info variant
500
+
501
+ This returns an Array which contains the response data, status code and headers.
502
+
503
+ > <Array(<SelfServiceLogoutUrl>, Integer, Hash)> create_self_service_logout_flow_url_for_browsers_with_http_info(opts)
504
+
505
+ ```ruby
506
+ begin
507
+ # Create a Logout URL for Browsers
508
+ data, status_code, headers = api_instance.create_self_service_logout_flow_url_for_browsers_with_http_info(opts)
509
+ p status_code # => 2xx
510
+ p headers # => { ... }
511
+ p data # => <SelfServiceLogoutUrl>
512
+ rescue OryKratosClient::ApiError => e
513
+ puts "Error when calling V0alpha1Api->create_self_service_logout_flow_url_for_browsers_with_http_info: #{e}"
514
+ end
515
+ ```
516
+
517
+ ### Parameters
518
+
519
+ | Name | Type | Description | Notes |
520
+ | ---- | ---- | ----------- | ----- |
521
+ | **cookie** | **String** | HTTP Cookies If you call this endpoint from a backend, please include the original Cookie header in the request. | [optional] |
522
+
523
+ ### Return type
524
+
525
+ [**SelfServiceLogoutUrl**](SelfServiceLogoutUrl.md)
526
+
527
+ ### Authorization
528
+
529
+ No authorization required
530
+
531
+ ### HTTP request headers
532
+
533
+ - **Content-Type**: Not defined
534
+ - **Accept**: application/json
535
+
536
+
537
+ ## get_json_schema
538
+
539
+ > Object get_json_schema(id)
540
+
541
+
542
+
543
+ Get a JSON Schema
544
+
545
+ ### Examples
546
+
547
+ ```ruby
548
+ require 'time'
549
+ require 'ory-kratos-client'
550
+
551
+ api_instance = OryKratosClient::V0alpha1Api.new
552
+ id = 'id_example' # String | ID must be set to the ID of schema you want to get
553
+
554
+ begin
555
+
556
+ result = api_instance.get_json_schema(id)
557
+ p result
558
+ rescue OryKratosClient::ApiError => e
559
+ puts "Error when calling V0alpha1Api->get_json_schema: #{e}"
560
+ end
561
+ ```
562
+
563
+ #### Using the get_json_schema_with_http_info variant
564
+
565
+ This returns an Array which contains the response data, status code and headers.
566
+
567
+ > <Array(Object, Integer, Hash)> get_json_schema_with_http_info(id)
568
+
569
+ ```ruby
570
+ begin
571
+
572
+ data, status_code, headers = api_instance.get_json_schema_with_http_info(id)
573
+ p status_code # => 2xx
574
+ p headers # => { ... }
575
+ p data # => Object
576
+ rescue OryKratosClient::ApiError => e
577
+ puts "Error when calling V0alpha1Api->get_json_schema_with_http_info: #{e}"
578
+ end
579
+ ```
580
+
581
+ ### Parameters
582
+
583
+ | Name | Type | Description | Notes |
584
+ | ---- | ---- | ----------- | ----- |
585
+ | **id** | **String** | ID must be set to the ID of schema you want to get | |
586
+
587
+ ### Return type
588
+
589
+ **Object**
590
+
591
+ ### Authorization
592
+
593
+ No authorization required
594
+
595
+ ### HTTP request headers
596
+
597
+ - **Content-Type**: Not defined
598
+ - **Accept**: application/json
599
+
600
+
601
+ ## get_self_service_error
602
+
603
+ > <SelfServiceError> get_self_service_error(id)
604
+
605
+ Get Self-Service Errors
606
+
607
+ 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: `?id=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).
608
+
609
+ ### Examples
610
+
611
+ ```ruby
612
+ require 'time'
613
+ require 'ory-kratos-client'
614
+
615
+ api_instance = OryKratosClient::V0alpha1Api.new
616
+ id = 'id_example' # String | Error is the error's ID
617
+
618
+ begin
619
+ # Get Self-Service Errors
620
+ result = api_instance.get_self_service_error(id)
621
+ p result
622
+ rescue OryKratosClient::ApiError => e
623
+ puts "Error when calling V0alpha1Api->get_self_service_error: #{e}"
624
+ end
625
+ ```
626
+
627
+ #### Using the get_self_service_error_with_http_info variant
628
+
629
+ This returns an Array which contains the response data, status code and headers.
630
+
631
+ > <Array(<SelfServiceError>, Integer, Hash)> get_self_service_error_with_http_info(id)
632
+
633
+ ```ruby
634
+ begin
635
+ # Get Self-Service Errors
636
+ data, status_code, headers = api_instance.get_self_service_error_with_http_info(id)
637
+ p status_code # => 2xx
638
+ p headers # => { ... }
639
+ p data # => <SelfServiceError>
640
+ rescue OryKratosClient::ApiError => e
641
+ puts "Error when calling V0alpha1Api->get_self_service_error_with_http_info: #{e}"
642
+ end
643
+ ```
644
+
645
+ ### Parameters
646
+
647
+ | Name | Type | Description | Notes |
648
+ | ---- | ---- | ----------- | ----- |
649
+ | **id** | **String** | Error is the error&#39;s ID | |
650
+
651
+ ### Return type
652
+
653
+ [**SelfServiceError**](SelfServiceError.md)
654
+
655
+ ### Authorization
656
+
657
+ No authorization required
658
+
659
+ ### HTTP request headers
660
+
661
+ - **Content-Type**: Not defined
662
+ - **Accept**: application/json
663
+
664
+
665
+ ## get_self_service_login_flow
666
+
667
+ > <SelfServiceLoginFlow> get_self_service_login_flow(id, opts)
668
+
669
+ Get Login Flow
670
+
671
+ This endpoint returns a login flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request'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: ```js pseudo-code example router.get('/login', async function (req, res) { const flow = await client.getSelfServiceLoginFlow(req.header('cookie'), req.query['flow']) res.render('login', flow) }) ``` 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).
672
+
673
+ ### Examples
674
+
675
+ ```ruby
676
+ require 'time'
677
+ require 'ory-kratos-client'
678
+
679
+ api_instance = OryKratosClient::V0alpha1Api.new
680
+ id = 'id_example' # String | The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`).
681
+ opts = {
682
+ cookie: 'cookie_example' # String | HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.
683
+ }
684
+
685
+ begin
686
+ # Get Login Flow
687
+ result = api_instance.get_self_service_login_flow(id, opts)
688
+ p result
689
+ rescue OryKratosClient::ApiError => e
690
+ puts "Error when calling V0alpha1Api->get_self_service_login_flow: #{e}"
691
+ end
692
+ ```
693
+
694
+ #### Using the get_self_service_login_flow_with_http_info variant
695
+
696
+ This returns an Array which contains the response data, status code and headers.
697
+
698
+ > <Array(<SelfServiceLoginFlow>, Integer, Hash)> get_self_service_login_flow_with_http_info(id, opts)
699
+
700
+ ```ruby
701
+ begin
702
+ # Get Login Flow
703
+ data, status_code, headers = api_instance.get_self_service_login_flow_with_http_info(id, opts)
704
+ p status_code # => 2xx
705
+ p headers # => { ... }
706
+ p data # => <SelfServiceLoginFlow>
707
+ rescue OryKratosClient::ApiError => e
708
+ puts "Error when calling V0alpha1Api->get_self_service_login_flow_with_http_info: #{e}"
709
+ end
710
+ ```
711
+
712
+ ### Parameters
713
+
714
+ | Name | Type | Description | Notes |
715
+ | ---- | ---- | ----------- | ----- |
716
+ | **id** | **String** | The Login Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/login?flow&#x3D;abcde&#x60;). | |
717
+ | **cookie** | **String** | HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. | [optional] |
718
+
719
+ ### Return type
720
+
721
+ [**SelfServiceLoginFlow**](SelfServiceLoginFlow.md)
722
+
723
+ ### Authorization
724
+
725
+ No authorization required
726
+
727
+ ### HTTP request headers
728
+
729
+ - **Content-Type**: Not defined
730
+ - **Accept**: application/json
731
+
732
+
733
+ ## get_self_service_recovery_flow
734
+
735
+ > <SelfServiceRecoveryFlow> get_self_service_recovery_flow(id, opts)
736
+
737
+ Get Recovery Flow
738
+
739
+ This endpoint returns a recovery flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request'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: ```js pseudo-code example router.get('/recovery', async function (req, res) { const flow = await client.getSelfServiceRecoveryFlow(req.header('Cookie'), req.query['flow']) res.render('recovery', flow) }) ``` More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
740
+
741
+ ### Examples
742
+
743
+ ```ruby
744
+ require 'time'
745
+ require 'ory-kratos-client'
746
+
747
+ api_instance = OryKratosClient::V0alpha1Api.new
748
+ id = 'id_example' # String | The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`).
749
+ opts = {
750
+ cookie: 'cookie_example' # String | HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.
751
+ }
752
+
753
+ begin
754
+ # Get Recovery Flow
755
+ result = api_instance.get_self_service_recovery_flow(id, opts)
756
+ p result
757
+ rescue OryKratosClient::ApiError => e
758
+ puts "Error when calling V0alpha1Api->get_self_service_recovery_flow: #{e}"
759
+ end
760
+ ```
761
+
762
+ #### Using the get_self_service_recovery_flow_with_http_info variant
763
+
764
+ This returns an Array which contains the response data, status code and headers.
765
+
766
+ > <Array(<SelfServiceRecoveryFlow>, Integer, Hash)> get_self_service_recovery_flow_with_http_info(id, opts)
767
+
768
+ ```ruby
769
+ begin
770
+ # Get Recovery Flow
771
+ data, status_code, headers = api_instance.get_self_service_recovery_flow_with_http_info(id, opts)
772
+ p status_code # => 2xx
773
+ p headers # => { ... }
774
+ p data # => <SelfServiceRecoveryFlow>
775
+ rescue OryKratosClient::ApiError => e
776
+ puts "Error when calling V0alpha1Api->get_self_service_recovery_flow_with_http_info: #{e}"
777
+ end
778
+ ```
779
+
780
+ ### Parameters
781
+
782
+ | Name | Type | Description | Notes |
783
+ | ---- | ---- | ----------- | ----- |
784
+ | **id** | **String** | The Flow ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/recovery?flow&#x3D;abcde&#x60;). | |
785
+ | **cookie** | **String** | HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. | [optional] |
786
+
787
+ ### Return type
788
+
789
+ [**SelfServiceRecoveryFlow**](SelfServiceRecoveryFlow.md)
790
+
791
+ ### Authorization
792
+
793
+ No authorization required
794
+
795
+ ### HTTP request headers
796
+
797
+ - **Content-Type**: Not defined
798
+ - **Accept**: application/json
799
+
800
+
801
+ ## get_self_service_registration_flow
802
+
803
+ > <SelfServiceRegistrationFlow> get_self_service_registration_flow(id, opts)
804
+
805
+ Get Registration Flow
806
+
807
+ This endpoint returns a registration flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request'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: ```js pseudo-code example router.get('/registration', async function (req, res) { const flow = await client.getSelfServiceRegistrationFlow(req.header('cookie'), req.query['flow']) res.render('registration', flow) }) ``` 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).
808
+
809
+ ### Examples
810
+
811
+ ```ruby
812
+ require 'time'
813
+ require 'ory-kratos-client'
814
+
815
+ api_instance = OryKratosClient::V0alpha1Api.new
816
+ id = 'id_example' # String | The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
817
+ opts = {
818
+ cookie: 'cookie_example' # String | HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.
819
+ }
820
+
821
+ begin
822
+ # Get Registration Flow
823
+ result = api_instance.get_self_service_registration_flow(id, opts)
824
+ p result
825
+ rescue OryKratosClient::ApiError => e
826
+ puts "Error when calling V0alpha1Api->get_self_service_registration_flow: #{e}"
827
+ end
828
+ ```
829
+
830
+ #### Using the get_self_service_registration_flow_with_http_info variant
831
+
832
+ This returns an Array which contains the response data, status code and headers.
833
+
834
+ > <Array(<SelfServiceRegistrationFlow>, Integer, Hash)> get_self_service_registration_flow_with_http_info(id, opts)
835
+
836
+ ```ruby
837
+ begin
838
+ # Get Registration Flow
839
+ data, status_code, headers = api_instance.get_self_service_registration_flow_with_http_info(id, opts)
840
+ p status_code # => 2xx
841
+ p headers # => { ... }
842
+ p data # => <SelfServiceRegistrationFlow>
843
+ rescue OryKratosClient::ApiError => e
844
+ puts "Error when calling V0alpha1Api->get_self_service_registration_flow_with_http_info: #{e}"
845
+ end
846
+ ```
847
+
848
+ ### Parameters
849
+
850
+ | Name | Type | Description | Notes |
851
+ | ---- | ---- | ----------- | ----- |
852
+ | **id** | **String** | The Registration Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/registration?flow&#x3D;abcde&#x60;). | |
853
+ | **cookie** | **String** | HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. | [optional] |
854
+
855
+ ### Return type
856
+
857
+ [**SelfServiceRegistrationFlow**](SelfServiceRegistrationFlow.md)
858
+
859
+ ### Authorization
860
+
861
+ No authorization required
862
+
863
+ ### HTTP request headers
864
+
865
+ - **Content-Type**: Not defined
866
+ - **Accept**: application/json
867
+
868
+
869
+ ## get_self_service_settings_flow
870
+
871
+ > <SelfServiceSettingsFlow> get_self_service_settings_flow(id, opts)
872
+
873
+ Get Settings Flow
874
+
875
+ 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).
876
+
877
+ ### Examples
878
+
879
+ ```ruby
880
+ require 'time'
881
+ require 'ory-kratos-client'
882
+
883
+ api_instance = OryKratosClient::V0alpha1Api.new
884
+ id = 'id_example' # String | ID is the Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`).
885
+ opts = {
886
+ x_session_token: 'x_session_token_example', # String | The Session Token When using the SDK in an app without a browser, please include the session token here.
887
+ cookie: 'cookie_example' # String | 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.
888
+ }
889
+
890
+ begin
891
+ # Get Settings Flow
892
+ result = api_instance.get_self_service_settings_flow(id, opts)
893
+ p result
894
+ rescue OryKratosClient::ApiError => e
895
+ puts "Error when calling V0alpha1Api->get_self_service_settings_flow: #{e}"
896
+ end
897
+ ```
898
+
899
+ #### Using the get_self_service_settings_flow_with_http_info variant
900
+
901
+ This returns an Array which contains the response data, status code and headers.
902
+
903
+ > <Array(<SelfServiceSettingsFlow>, Integer, Hash)> get_self_service_settings_flow_with_http_info(id, opts)
904
+
905
+ ```ruby
906
+ begin
907
+ # Get Settings Flow
908
+ data, status_code, headers = api_instance.get_self_service_settings_flow_with_http_info(id, opts)
909
+ p status_code # => 2xx
910
+ p headers # => { ... }
911
+ p data # => <SelfServiceSettingsFlow>
912
+ rescue OryKratosClient::ApiError => e
913
+ puts "Error when calling V0alpha1Api->get_self_service_settings_flow_with_http_info: #{e}"
914
+ end
915
+ ```
916
+
917
+ ### Parameters
918
+
919
+ | Name | Type | Description | Notes |
920
+ | ---- | ---- | ----------- | ----- |
921
+ | **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;). | |
922
+ | **x_session_token** | **String** | The Session Token When using the SDK in an app without a browser, please include the session token here. | [optional] |
923
+ | **cookie** | **String** | 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. | [optional] |
924
+
925
+ ### Return type
926
+
927
+ [**SelfServiceSettingsFlow**](SelfServiceSettingsFlow.md)
928
+
929
+ ### Authorization
930
+
931
+ No authorization required
932
+
933
+ ### HTTP request headers
934
+
935
+ - **Content-Type**: Not defined
936
+ - **Accept**: application/json
937
+
938
+
939
+ ## get_self_service_verification_flow
940
+
941
+ > <SelfServiceVerificationFlow> get_self_service_verification_flow(id, opts)
942
+
943
+ Get Verification Flow
944
+
945
+ This endpoint returns a verification flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request'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: ```js pseudo-code example router.get('/recovery', async function (req, res) { const flow = await client.getSelfServiceVerificationFlow(req.header('cookie'), req.query['flow']) res.render('verification', 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).
946
+
947
+ ### Examples
948
+
949
+ ```ruby
950
+ require 'time'
951
+ require 'ory-kratos-client'
952
+
953
+ api_instance = OryKratosClient::V0alpha1Api.new
954
+ id = 'id_example' # String | The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`).
955
+ opts = {
956
+ cookie: 'cookie_example' # String | HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.
957
+ }
958
+
959
+ begin
960
+ # Get Verification Flow
961
+ result = api_instance.get_self_service_verification_flow(id, opts)
962
+ p result
963
+ rescue OryKratosClient::ApiError => e
964
+ puts "Error when calling V0alpha1Api->get_self_service_verification_flow: #{e}"
965
+ end
966
+ ```
967
+
968
+ #### Using the get_self_service_verification_flow_with_http_info variant
969
+
970
+ This returns an Array which contains the response data, status code and headers.
971
+
972
+ > <Array(<SelfServiceVerificationFlow>, Integer, Hash)> get_self_service_verification_flow_with_http_info(id, opts)
973
+
974
+ ```ruby
975
+ begin
976
+ # Get Verification Flow
977
+ data, status_code, headers = api_instance.get_self_service_verification_flow_with_http_info(id, opts)
978
+ p status_code # => 2xx
979
+ p headers # => { ... }
980
+ p data # => <SelfServiceVerificationFlow>
981
+ rescue OryKratosClient::ApiError => e
982
+ puts "Error when calling V0alpha1Api->get_self_service_verification_flow_with_http_info: #{e}"
983
+ end
984
+ ```
985
+
986
+ ### Parameters
987
+
988
+ | Name | Type | Description | Notes |
989
+ | ---- | ---- | ----------- | ----- |
990
+ | **id** | **String** | The Flow ID The value for this parameter comes from &#x60;request&#x60; URL Query parameter sent to your application (e.g. &#x60;/verification?flow&#x3D;abcde&#x60;). | |
991
+ | **cookie** | **String** | HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. | [optional] |
992
+
993
+ ### Return type
994
+
995
+ [**SelfServiceVerificationFlow**](SelfServiceVerificationFlow.md)
996
+
997
+ ### Authorization
998
+
999
+ No authorization required
1000
+
1001
+ ### HTTP request headers
1002
+
1003
+ - **Content-Type**: Not defined
1004
+ - **Accept**: application/json
1005
+
1006
+
1007
+ ## initialize_self_service_login_flow_for_browsers
1008
+
1009
+ > <SelfServiceLoginFlow> initialize_self_service_login_flow_for_browsers(opts)
1010
+
1011
+ Initialize Login Flow for Browsers
1012
+
1013
+ 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 `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. 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).
1014
+
1015
+ ### Examples
1016
+
1017
+ ```ruby
1018
+ require 'time'
1019
+ require 'ory-kratos-client'
1020
+
1021
+ api_instance = OryKratosClient::V0alpha1Api.new
1022
+ opts = {
1023
+ refresh: true # Boolean | 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.
1024
+ }
1025
+
1026
+ begin
1027
+ # Initialize Login Flow for Browsers
1028
+ result = api_instance.initialize_self_service_login_flow_for_browsers(opts)
1029
+ p result
1030
+ rescue OryKratosClient::ApiError => e
1031
+ puts "Error when calling V0alpha1Api->initialize_self_service_login_flow_for_browsers: #{e}"
1032
+ end
1033
+ ```
1034
+
1035
+ #### Using the initialize_self_service_login_flow_for_browsers_with_http_info variant
1036
+
1037
+ This returns an Array which contains the response data, status code and headers.
1038
+
1039
+ > <Array(<SelfServiceLoginFlow>, Integer, Hash)> initialize_self_service_login_flow_for_browsers_with_http_info(opts)
1040
+
1041
+ ```ruby
1042
+ begin
1043
+ # Initialize Login Flow for Browsers
1044
+ data, status_code, headers = api_instance.initialize_self_service_login_flow_for_browsers_with_http_info(opts)
1045
+ p status_code # => 2xx
1046
+ p headers # => { ... }
1047
+ p data # => <SelfServiceLoginFlow>
1048
+ rescue OryKratosClient::ApiError => e
1049
+ puts "Error when calling V0alpha1Api->initialize_self_service_login_flow_for_browsers_with_http_info: #{e}"
1050
+ end
1051
+ ```
1052
+
1053
+ ### Parameters
1054
+
1055
+ | Name | Type | Description | Notes |
1056
+ | ---- | ---- | ----------- | ----- |
1057
+ | **refresh** | **Boolean** | 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. | [optional] |
1058
+
1059
+ ### Return type
1060
+
1061
+ [**SelfServiceLoginFlow**](SelfServiceLoginFlow.md)
1062
+
1063
+ ### Authorization
1064
+
1065
+ No authorization required
1066
+
1067
+ ### HTTP request headers
1068
+
1069
+ - **Content-Type**: Not defined
1070
+ - **Accept**: application/json
1071
+
1072
+
1073
+ ## initialize_self_service_login_flow_without_browser
1074
+
1075
+ > <SelfServiceLoginFlow> initialize_self_service_login_flow_without_browser(opts)
1076
+
1077
+ Initialize Login Flow for APIs, Services, Apps, ...
1078
+
1079
+ 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 `?refresh=true` is set. To fetch an existing login flow call `/self-service/login/flows?flow=<flow_id>`. 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).
1080
+
1081
+ ### Examples
1082
+
1083
+ ```ruby
1084
+ require 'time'
1085
+ require 'ory-kratos-client'
1086
+
1087
+ api_instance = OryKratosClient::V0alpha1Api.new
1088
+ opts = {
1089
+ refresh: true # Boolean | 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.
1090
+ }
1091
+
1092
+ begin
1093
+ # Initialize Login Flow for APIs, Services, Apps, ...
1094
+ result = api_instance.initialize_self_service_login_flow_without_browser(opts)
1095
+ p result
1096
+ rescue OryKratosClient::ApiError => e
1097
+ puts "Error when calling V0alpha1Api->initialize_self_service_login_flow_without_browser: #{e}"
1098
+ end
1099
+ ```
1100
+
1101
+ #### Using the initialize_self_service_login_flow_without_browser_with_http_info variant
1102
+
1103
+ This returns an Array which contains the response data, status code and headers.
1104
+
1105
+ > <Array(<SelfServiceLoginFlow>, Integer, Hash)> initialize_self_service_login_flow_without_browser_with_http_info(opts)
1106
+
1107
+ ```ruby
1108
+ begin
1109
+ # Initialize Login Flow for APIs, Services, Apps, ...
1110
+ data, status_code, headers = api_instance.initialize_self_service_login_flow_without_browser_with_http_info(opts)
1111
+ p status_code # => 2xx
1112
+ p headers # => { ... }
1113
+ p data # => <SelfServiceLoginFlow>
1114
+ rescue OryKratosClient::ApiError => e
1115
+ puts "Error when calling V0alpha1Api->initialize_self_service_login_flow_without_browser_with_http_info: #{e}"
1116
+ end
1117
+ ```
1118
+
1119
+ ### Parameters
1120
+
1121
+ | Name | Type | Description | Notes |
1122
+ | ---- | ---- | ----------- | ----- |
1123
+ | **refresh** | **Boolean** | 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. | [optional] |
1124
+
1125
+ ### Return type
1126
+
1127
+ [**SelfServiceLoginFlow**](SelfServiceLoginFlow.md)
1128
+
1129
+ ### Authorization
1130
+
1131
+ No authorization required
1132
+
1133
+ ### HTTP request headers
1134
+
1135
+ - **Content-Type**: Not defined
1136
+ - **Accept**: application/json
1137
+
1138
+
1139
+ ## initialize_self_service_recovery_flow_for_browsers
1140
+
1141
+ > <SelfServiceRecoveryFlow> initialize_self_service_recovery_flow_for_browsers
1142
+
1143
+ Initialize Recovery Flow for Browsers
1144
+
1145
+ 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. 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).
1146
+
1147
+ ### Examples
1148
+
1149
+ ```ruby
1150
+ require 'time'
1151
+ require 'ory-kratos-client'
1152
+
1153
+ api_instance = OryKratosClient::V0alpha1Api.new
1154
+
1155
+ begin
1156
+ # Initialize Recovery Flow for Browsers
1157
+ result = api_instance.initialize_self_service_recovery_flow_for_browsers
1158
+ p result
1159
+ rescue OryKratosClient::ApiError => e
1160
+ puts "Error when calling V0alpha1Api->initialize_self_service_recovery_flow_for_browsers: #{e}"
1161
+ end
1162
+ ```
1163
+
1164
+ #### Using the initialize_self_service_recovery_flow_for_browsers_with_http_info variant
1165
+
1166
+ This returns an Array which contains the response data, status code and headers.
1167
+
1168
+ > <Array(<SelfServiceRecoveryFlow>, Integer, Hash)> initialize_self_service_recovery_flow_for_browsers_with_http_info
1169
+
1170
+ ```ruby
1171
+ begin
1172
+ # Initialize Recovery Flow for Browsers
1173
+ data, status_code, headers = api_instance.initialize_self_service_recovery_flow_for_browsers_with_http_info
1174
+ p status_code # => 2xx
1175
+ p headers # => { ... }
1176
+ p data # => <SelfServiceRecoveryFlow>
1177
+ rescue OryKratosClient::ApiError => e
1178
+ puts "Error when calling V0alpha1Api->initialize_self_service_recovery_flow_for_browsers_with_http_info: #{e}"
1179
+ end
1180
+ ```
1181
+
1182
+ ### Parameters
1183
+
1184
+ This endpoint does not need any parameter.
1185
+
1186
+ ### Return type
1187
+
1188
+ [**SelfServiceRecoveryFlow**](SelfServiceRecoveryFlow.md)
1189
+
1190
+ ### Authorization
1191
+
1192
+ No authorization required
1193
+
1194
+ ### HTTP request headers
1195
+
1196
+ - **Content-Type**: Not defined
1197
+ - **Accept**: application/json
1198
+
1199
+
1200
+ ## initialize_self_service_recovery_flow_without_browser
1201
+
1202
+ > <SelfServiceRecoveryFlow> initialize_self_service_recovery_flow_without_browser
1203
+
1204
+ Initialize Recovery Flow for APIs, Services, Apps, ...
1205
+
1206
+ 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>`. 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).
1207
+
1208
+ ### Examples
1209
+
1210
+ ```ruby
1211
+ require 'time'
1212
+ require 'ory-kratos-client'
1213
+
1214
+ api_instance = OryKratosClient::V0alpha1Api.new
1215
+
1216
+ begin
1217
+ # Initialize Recovery Flow for APIs, Services, Apps, ...
1218
+ result = api_instance.initialize_self_service_recovery_flow_without_browser
1219
+ p result
1220
+ rescue OryKratosClient::ApiError => e
1221
+ puts "Error when calling V0alpha1Api->initialize_self_service_recovery_flow_without_browser: #{e}"
1222
+ end
1223
+ ```
1224
+
1225
+ #### Using the initialize_self_service_recovery_flow_without_browser_with_http_info variant
1226
+
1227
+ This returns an Array which contains the response data, status code and headers.
1228
+
1229
+ > <Array(<SelfServiceRecoveryFlow>, Integer, Hash)> initialize_self_service_recovery_flow_without_browser_with_http_info
1230
+
1231
+ ```ruby
1232
+ begin
1233
+ # Initialize Recovery Flow for APIs, Services, Apps, ...
1234
+ data, status_code, headers = api_instance.initialize_self_service_recovery_flow_without_browser_with_http_info
1235
+ p status_code # => 2xx
1236
+ p headers # => { ... }
1237
+ p data # => <SelfServiceRecoveryFlow>
1238
+ rescue OryKratosClient::ApiError => e
1239
+ puts "Error when calling V0alpha1Api->initialize_self_service_recovery_flow_without_browser_with_http_info: #{e}"
1240
+ end
1241
+ ```
1242
+
1243
+ ### Parameters
1244
+
1245
+ This endpoint does not need any parameter.
1246
+
1247
+ ### Return type
1248
+
1249
+ [**SelfServiceRecoveryFlow**](SelfServiceRecoveryFlow.md)
1250
+
1251
+ ### Authorization
1252
+
1253
+ No authorization required
1254
+
1255
+ ### HTTP request headers
1256
+
1257
+ - **Content-Type**: Not defined
1258
+ - **Accept**: application/json
1259
+
1260
+
1261
+ ## initialize_self_service_registration_flow_for_browsers
1262
+
1263
+ > <SelfServiceRegistrationFlow> initialize_self_service_registration_flow_for_browsers
1264
+
1265
+ Initialize Registration Flow for Browsers
1266
+
1267
+ 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 `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`. 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).
1268
+
1269
+ ### Examples
1270
+
1271
+ ```ruby
1272
+ require 'time'
1273
+ require 'ory-kratos-client'
1274
+
1275
+ api_instance = OryKratosClient::V0alpha1Api.new
1276
+
1277
+ begin
1278
+ # Initialize Registration Flow for Browsers
1279
+ result = api_instance.initialize_self_service_registration_flow_for_browsers
1280
+ p result
1281
+ rescue OryKratosClient::ApiError => e
1282
+ puts "Error when calling V0alpha1Api->initialize_self_service_registration_flow_for_browsers: #{e}"
1283
+ end
1284
+ ```
1285
+
1286
+ #### Using the initialize_self_service_registration_flow_for_browsers_with_http_info variant
1287
+
1288
+ This returns an Array which contains the response data, status code and headers.
1289
+
1290
+ > <Array(<SelfServiceRegistrationFlow>, Integer, Hash)> initialize_self_service_registration_flow_for_browsers_with_http_info
1291
+
1292
+ ```ruby
1293
+ begin
1294
+ # Initialize Registration Flow for Browsers
1295
+ data, status_code, headers = api_instance.initialize_self_service_registration_flow_for_browsers_with_http_info
1296
+ p status_code # => 2xx
1297
+ p headers # => { ... }
1298
+ p data # => <SelfServiceRegistrationFlow>
1299
+ rescue OryKratosClient::ApiError => e
1300
+ puts "Error when calling V0alpha1Api->initialize_self_service_registration_flow_for_browsers_with_http_info: #{e}"
1301
+ end
1302
+ ```
1303
+
1304
+ ### Parameters
1305
+
1306
+ This endpoint does not need any parameter.
1307
+
1308
+ ### Return type
1309
+
1310
+ [**SelfServiceRegistrationFlow**](SelfServiceRegistrationFlow.md)
1311
+
1312
+ ### Authorization
1313
+
1314
+ No authorization required
1315
+
1316
+ ### HTTP request headers
1317
+
1318
+ - **Content-Type**: Not defined
1319
+ - **Accept**: application/json
1320
+
1321
+
1322
+ ## initialize_self_service_registration_flow_without_browser
1323
+
1324
+ > <SelfServiceRegistrationFlow> initialize_self_service_registration_flow_without_browser
1325
+
1326
+ Initialize Registration Flow for APIs, Services, Apps, ...
1327
+
1328
+ 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>`. 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).
1329
+
1330
+ ### Examples
1331
+
1332
+ ```ruby
1333
+ require 'time'
1334
+ require 'ory-kratos-client'
1335
+
1336
+ api_instance = OryKratosClient::V0alpha1Api.new
1337
+
1338
+ begin
1339
+ # Initialize Registration Flow for APIs, Services, Apps, ...
1340
+ result = api_instance.initialize_self_service_registration_flow_without_browser
1341
+ p result
1342
+ rescue OryKratosClient::ApiError => e
1343
+ puts "Error when calling V0alpha1Api->initialize_self_service_registration_flow_without_browser: #{e}"
1344
+ end
1345
+ ```
1346
+
1347
+ #### Using the initialize_self_service_registration_flow_without_browser_with_http_info variant
1348
+
1349
+ This returns an Array which contains the response data, status code and headers.
1350
+
1351
+ > <Array(<SelfServiceRegistrationFlow>, Integer, Hash)> initialize_self_service_registration_flow_without_browser_with_http_info
1352
+
1353
+ ```ruby
1354
+ begin
1355
+ # Initialize Registration Flow for APIs, Services, Apps, ...
1356
+ data, status_code, headers = api_instance.initialize_self_service_registration_flow_without_browser_with_http_info
1357
+ p status_code # => 2xx
1358
+ p headers # => { ... }
1359
+ p data # => <SelfServiceRegistrationFlow>
1360
+ rescue OryKratosClient::ApiError => e
1361
+ puts "Error when calling V0alpha1Api->initialize_self_service_registration_flow_without_browser_with_http_info: #{e}"
1362
+ end
1363
+ ```
1364
+
1365
+ ### Parameters
1366
+
1367
+ This endpoint does not need any parameter.
1368
+
1369
+ ### Return type
1370
+
1371
+ [**SelfServiceRegistrationFlow**](SelfServiceRegistrationFlow.md)
1372
+
1373
+ ### Authorization
1374
+
1375
+ No authorization required
1376
+
1377
+ ### HTTP request headers
1378
+
1379
+ - **Content-Type**: Not defined
1380
+ - **Accept**: application/json
1381
+
1382
+
1383
+ ## initialize_self_service_settings_flow_for_browsers
1384
+
1385
+ > <SelfServiceSettingsFlow> initialize_self_service_settings_flow_for_browsers(opts)
1386
+
1387
+ Initialize Settings Flow for Browsers
1388
+
1389
+ 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. If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. 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 & Profile Management Documentation](../self-service/flows/user-settings).
1390
+
1391
+ ### Examples
1392
+
1393
+ ```ruby
1394
+ require 'time'
1395
+ require 'ory-kratos-client'
1396
+
1397
+ api_instance = OryKratosClient::V0alpha1Api.new
1398
+ opts = {
1399
+ cookie: 'cookie_example' # String | The Session Cookie of the Identity performing the settings flow.
1400
+ }
1401
+
1402
+ begin
1403
+ # Initialize Settings Flow for Browsers
1404
+ result = api_instance.initialize_self_service_settings_flow_for_browsers(opts)
1405
+ p result
1406
+ rescue OryKratosClient::ApiError => e
1407
+ puts "Error when calling V0alpha1Api->initialize_self_service_settings_flow_for_browsers: #{e}"
1408
+ end
1409
+ ```
1410
+
1411
+ #### Using the initialize_self_service_settings_flow_for_browsers_with_http_info variant
1412
+
1413
+ This returns an Array which contains the response data, status code and headers.
1414
+
1415
+ > <Array(<SelfServiceSettingsFlow>, Integer, Hash)> initialize_self_service_settings_flow_for_browsers_with_http_info(opts)
1416
+
1417
+ ```ruby
1418
+ begin
1419
+ # Initialize Settings Flow for Browsers
1420
+ data, status_code, headers = api_instance.initialize_self_service_settings_flow_for_browsers_with_http_info(opts)
1421
+ p status_code # => 2xx
1422
+ p headers # => { ... }
1423
+ p data # => <SelfServiceSettingsFlow>
1424
+ rescue OryKratosClient::ApiError => e
1425
+ puts "Error when calling V0alpha1Api->initialize_self_service_settings_flow_for_browsers_with_http_info: #{e}"
1426
+ end
1427
+ ```
1428
+
1429
+ ### Parameters
1430
+
1431
+ | Name | Type | Description | Notes |
1432
+ | ---- | ---- | ----------- | ----- |
1433
+ | **cookie** | **String** | The Session Cookie of the Identity performing the settings flow. | [optional] |
1434
+
1435
+ ### Return type
1436
+
1437
+ [**SelfServiceSettingsFlow**](SelfServiceSettingsFlow.md)
1438
+
1439
+ ### Authorization
1440
+
1441
+ No authorization required
1442
+
1443
+ ### HTTP request headers
1444
+
1445
+ - **Content-Type**: Not defined
1446
+ - **Accept**: application/json
1447
+
1448
+
1449
+ ## initialize_self_service_settings_flow_without_browser
1450
+
1451
+ > <SelfServiceSettingsFlow> initialize_self_service_settings_flow_without_browser(opts)
1452
+
1453
+ Initialize Settings Flow for APIs, Services, Apps, ...
1454
+
1455
+ 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>`. 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).
1456
+
1457
+ ### Examples
1458
+
1459
+ ```ruby
1460
+ require 'time'
1461
+ require 'ory-kratos-client'
1462
+
1463
+ api_instance = OryKratosClient::V0alpha1Api.new
1464
+ opts = {
1465
+ x_session_token: 'x_session_token_example' # String | The Session Token of the Identity performing the settings flow.
1466
+ }
1467
+
1468
+ begin
1469
+ # Initialize Settings Flow for APIs, Services, Apps, ...
1470
+ result = api_instance.initialize_self_service_settings_flow_without_browser(opts)
1471
+ p result
1472
+ rescue OryKratosClient::ApiError => e
1473
+ puts "Error when calling V0alpha1Api->initialize_self_service_settings_flow_without_browser: #{e}"
1474
+ end
1475
+ ```
1476
+
1477
+ #### Using the initialize_self_service_settings_flow_without_browser_with_http_info variant
1478
+
1479
+ This returns an Array which contains the response data, status code and headers.
1480
+
1481
+ > <Array(<SelfServiceSettingsFlow>, Integer, Hash)> initialize_self_service_settings_flow_without_browser_with_http_info(opts)
1482
+
1483
+ ```ruby
1484
+ begin
1485
+ # Initialize Settings Flow for APIs, Services, Apps, ...
1486
+ data, status_code, headers = api_instance.initialize_self_service_settings_flow_without_browser_with_http_info(opts)
1487
+ p status_code # => 2xx
1488
+ p headers # => { ... }
1489
+ p data # => <SelfServiceSettingsFlow>
1490
+ rescue OryKratosClient::ApiError => e
1491
+ puts "Error when calling V0alpha1Api->initialize_self_service_settings_flow_without_browser_with_http_info: #{e}"
1492
+ end
1493
+ ```
1494
+
1495
+ ### Parameters
1496
+
1497
+ | Name | Type | Description | Notes |
1498
+ | ---- | ---- | ----------- | ----- |
1499
+ | **x_session_token** | **String** | The Session Token of the Identity performing the settings flow. | [optional] |
1500
+
1501
+ ### Return type
1502
+
1503
+ [**SelfServiceSettingsFlow**](SelfServiceSettingsFlow.md)
1504
+
1505
+ ### Authorization
1506
+
1507
+ No authorization required
1508
+
1509
+ ### HTTP request headers
1510
+
1511
+ - **Content-Type**: Not defined
1512
+ - **Accept**: application/json
1513
+
1514
+
1515
+ ## initialize_self_service_verification_flow_for_browsers
1516
+
1517
+ > <SelfServiceVerificationFlow> initialize_self_service_verification_flow_for_browsers
1518
+
1519
+ Initialize Verification Flow for Browser Clients
1520
+
1521
+ 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=`. 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).
1522
+
1523
+ ### Examples
1524
+
1525
+ ```ruby
1526
+ require 'time'
1527
+ require 'ory-kratos-client'
1528
+
1529
+ api_instance = OryKratosClient::V0alpha1Api.new
1530
+
1531
+ begin
1532
+ # Initialize Verification Flow for Browser Clients
1533
+ result = api_instance.initialize_self_service_verification_flow_for_browsers
1534
+ p result
1535
+ rescue OryKratosClient::ApiError => e
1536
+ puts "Error when calling V0alpha1Api->initialize_self_service_verification_flow_for_browsers: #{e}"
1537
+ end
1538
+ ```
1539
+
1540
+ #### Using the initialize_self_service_verification_flow_for_browsers_with_http_info variant
1541
+
1542
+ This returns an Array which contains the response data, status code and headers.
1543
+
1544
+ > <Array(<SelfServiceVerificationFlow>, Integer, Hash)> initialize_self_service_verification_flow_for_browsers_with_http_info
1545
+
1546
+ ```ruby
1547
+ begin
1548
+ # Initialize Verification Flow for Browser Clients
1549
+ data, status_code, headers = api_instance.initialize_self_service_verification_flow_for_browsers_with_http_info
1550
+ p status_code # => 2xx
1551
+ p headers # => { ... }
1552
+ p data # => <SelfServiceVerificationFlow>
1553
+ rescue OryKratosClient::ApiError => e
1554
+ puts "Error when calling V0alpha1Api->initialize_self_service_verification_flow_for_browsers_with_http_info: #{e}"
1555
+ end
1556
+ ```
1557
+
1558
+ ### Parameters
1559
+
1560
+ This endpoint does not need any parameter.
1561
+
1562
+ ### Return type
1563
+
1564
+ [**SelfServiceVerificationFlow**](SelfServiceVerificationFlow.md)
1565
+
1566
+ ### Authorization
1567
+
1568
+ No authorization required
1569
+
1570
+ ### HTTP request headers
1571
+
1572
+ - **Content-Type**: Not defined
1573
+ - **Accept**: application/json
1574
+
1575
+
1576
+ ## initialize_self_service_verification_flow_without_browser
1577
+
1578
+ > <SelfServiceVerificationFlow> initialize_self_service_verification_flow_without_browser
1579
+
1580
+ Initialize Verification Flow for APIs, Services, Apps, ...
1581
+
1582
+ 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>`. 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).
1583
+
1584
+ ### Examples
1585
+
1586
+ ```ruby
1587
+ require 'time'
1588
+ require 'ory-kratos-client'
1589
+
1590
+ api_instance = OryKratosClient::V0alpha1Api.new
1591
+
1592
+ begin
1593
+ # Initialize Verification Flow for APIs, Services, Apps, ...
1594
+ result = api_instance.initialize_self_service_verification_flow_without_browser
1595
+ p result
1596
+ rescue OryKratosClient::ApiError => e
1597
+ puts "Error when calling V0alpha1Api->initialize_self_service_verification_flow_without_browser: #{e}"
1598
+ end
1599
+ ```
1600
+
1601
+ #### Using the initialize_self_service_verification_flow_without_browser_with_http_info variant
1602
+
1603
+ This returns an Array which contains the response data, status code and headers.
1604
+
1605
+ > <Array(<SelfServiceVerificationFlow>, Integer, Hash)> initialize_self_service_verification_flow_without_browser_with_http_info
1606
+
1607
+ ```ruby
1608
+ begin
1609
+ # Initialize Verification Flow for APIs, Services, Apps, ...
1610
+ data, status_code, headers = api_instance.initialize_self_service_verification_flow_without_browser_with_http_info
1611
+ p status_code # => 2xx
1612
+ p headers # => { ... }
1613
+ p data # => <SelfServiceVerificationFlow>
1614
+ rescue OryKratosClient::ApiError => e
1615
+ puts "Error when calling V0alpha1Api->initialize_self_service_verification_flow_without_browser_with_http_info: #{e}"
1616
+ end
1617
+ ```
1618
+
1619
+ ### Parameters
1620
+
1621
+ This endpoint does not need any parameter.
1622
+
1623
+ ### Return type
1624
+
1625
+ [**SelfServiceVerificationFlow**](SelfServiceVerificationFlow.md)
1626
+
1627
+ ### Authorization
1628
+
1629
+ No authorization required
1630
+
1631
+ ### HTTP request headers
1632
+
1633
+ - **Content-Type**: Not defined
1634
+ - **Accept**: application/json
1635
+
1636
+
1637
+ ## submit_self_service_login_flow
1638
+
1639
+ > <SuccessfulSelfServiceLoginWithoutBrowser> submit_self_service_login_flow(flow, opts)
1640
+
1641
+ Submit a Login Flow
1642
+
1643
+ :::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 `application/json` to be sent in the body and responds with HTTP 200 and a application/json body with the session token on success; HTTP 302 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. Browser flows expect a Content-Type of `application/x-www-form-urlencoded` or `application/json` to be sent in the body and respond with a HTTP 302 redirect to the post/after login URL or the `return_to` value if it was set and if the login succeeded; a HTTP 302 redirect to the login UI URL with the flow ID containing the validation errors otherwise. Browser flows with an accept header of `application/json` will not redirect but instead respond with HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` 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).
1644
+
1645
+ ### Examples
1646
+
1647
+ ```ruby
1648
+ require 'time'
1649
+ require 'ory-kratos-client'
1650
+
1651
+ api_instance = OryKratosClient::V0alpha1Api.new
1652
+ flow = 'flow_example' # String | The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`).
1653
+ opts = {
1654
+ submit_self_service_login_flow_body: OryKratosClient::SubmitSelfServiceLoginFlowWithPasswordMethodBody.new({method: 'password', password: 'password_example', password_identifier: 'password_identifier_example'}) # SubmitSelfServiceLoginFlowBody |
1655
+ }
1656
+
1657
+ begin
1658
+ # Submit a Login Flow
1659
+ result = api_instance.submit_self_service_login_flow(flow, opts)
1660
+ p result
1661
+ rescue OryKratosClient::ApiError => e
1662
+ puts "Error when calling V0alpha1Api->submit_self_service_login_flow: #{e}"
1663
+ end
1664
+ ```
1665
+
1666
+ #### Using the submit_self_service_login_flow_with_http_info variant
1667
+
1668
+ This returns an Array which contains the response data, status code and headers.
1669
+
1670
+ > <Array(<SuccessfulSelfServiceLoginWithoutBrowser>, Integer, Hash)> submit_self_service_login_flow_with_http_info(flow, opts)
1671
+
1672
+ ```ruby
1673
+ begin
1674
+ # Submit a Login Flow
1675
+ data, status_code, headers = api_instance.submit_self_service_login_flow_with_http_info(flow, opts)
1676
+ p status_code # => 2xx
1677
+ p headers # => { ... }
1678
+ p data # => <SuccessfulSelfServiceLoginWithoutBrowser>
1679
+ rescue OryKratosClient::ApiError => e
1680
+ puts "Error when calling V0alpha1Api->submit_self_service_login_flow_with_http_info: #{e}"
1681
+ end
1682
+ ```
1683
+
1684
+ ### Parameters
1685
+
1686
+ | Name | Type | Description | Notes |
1687
+ | ---- | ---- | ----------- | ----- |
1688
+ | **flow** | **String** | The Login Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/login?flow&#x3D;abcde&#x60;). | |
1689
+ | **submit_self_service_login_flow_body** | [**SubmitSelfServiceLoginFlowBody**](SubmitSelfServiceLoginFlowBody.md) | | [optional] |
1690
+
1691
+ ### Return type
1692
+
1693
+ [**SuccessfulSelfServiceLoginWithoutBrowser**](SuccessfulSelfServiceLoginWithoutBrowser.md)
1694
+
1695
+ ### Authorization
1696
+
1697
+ No authorization required
1698
+
1699
+ ### HTTP request headers
1700
+
1701
+ - **Content-Type**: application/json, application/x-www-form-urlencoded
1702
+ - **Accept**: application/json
1703
+
1704
+
1705
+ ## submit_self_service_logout_flow
1706
+
1707
+ > submit_self_service_logout_flow(opts)
1708
+
1709
+ Complete Self-Service Logout
1710
+
1711
+ This endpoint logs out an identity in a self-service manner. If the `Accept` HTTP header is not set to `application/json`, the browser will be redirected (HTTP 302 Found) to the `return_to` parameter of the initial request or fall back to `urls.default_return_to`. If the `Accept` HTTP header is set to `application/json`, 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 `/self-service/logout/api` 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).
1712
+
1713
+ ### Examples
1714
+
1715
+ ```ruby
1716
+ require 'time'
1717
+ require 'ory-kratos-client'
1718
+
1719
+ api_instance = OryKratosClient::V0alpha1Api.new
1720
+ opts = {
1721
+ token: 'token_example' # String | A Valid Logout Token If you do not have a logout token because you only have a session cookie, call `/self-service/logout/urls` to generate a URL for this endpoint.
1722
+ }
1723
+
1724
+ begin
1725
+ # Complete Self-Service Logout
1726
+ api_instance.submit_self_service_logout_flow(opts)
1727
+ rescue OryKratosClient::ApiError => e
1728
+ puts "Error when calling V0alpha1Api->submit_self_service_logout_flow: #{e}"
1729
+ end
1730
+ ```
1731
+
1732
+ #### Using the submit_self_service_logout_flow_with_http_info variant
1733
+
1734
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1735
+
1736
+ > <Array(nil, Integer, Hash)> submit_self_service_logout_flow_with_http_info(opts)
1737
+
1738
+ ```ruby
1739
+ begin
1740
+ # Complete Self-Service Logout
1741
+ data, status_code, headers = api_instance.submit_self_service_logout_flow_with_http_info(opts)
1742
+ p status_code # => 2xx
1743
+ p headers # => { ... }
1744
+ p data # => nil
1745
+ rescue OryKratosClient::ApiError => e
1746
+ puts "Error when calling V0alpha1Api->submit_self_service_logout_flow_with_http_info: #{e}"
1747
+ end
1748
+ ```
1749
+
1750
+ ### Parameters
1751
+
1752
+ | Name | Type | Description | Notes |
1753
+ | ---- | ---- | ----------- | ----- |
1754
+ | **token** | **String** | 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. | [optional] |
1755
+
1756
+ ### Return type
1757
+
1758
+ nil (empty response body)
1759
+
1760
+ ### Authorization
1761
+
1762
+ No authorization required
1763
+
1764
+ ### HTTP request headers
1765
+
1766
+ - **Content-Type**: Not defined
1767
+ - **Accept**: application/json
1768
+
1769
+
1770
+ ## submit_self_service_logout_flow_without_browser
1771
+
1772
+ > submit_self_service_logout_flow_without_browser(submit_self_service_logout_flow_without_browser_body)
1773
+
1774
+ Perform Logout for APIs, Services, Apps, ...
1775
+
1776
+ 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.
1777
+
1778
+ ### Examples
1779
+
1780
+ ```ruby
1781
+ require 'time'
1782
+ require 'ory-kratos-client'
1783
+
1784
+ api_instance = OryKratosClient::V0alpha1Api.new
1785
+ submit_self_service_logout_flow_without_browser_body = OryKratosClient::SubmitSelfServiceLogoutFlowWithoutBrowserBody.new({session_token: 'session_token_example'}) # SubmitSelfServiceLogoutFlowWithoutBrowserBody |
1786
+
1787
+ begin
1788
+ # Perform Logout for APIs, Services, Apps, ...
1789
+ api_instance.submit_self_service_logout_flow_without_browser(submit_self_service_logout_flow_without_browser_body)
1790
+ rescue OryKratosClient::ApiError => e
1791
+ puts "Error when calling V0alpha1Api->submit_self_service_logout_flow_without_browser: #{e}"
1792
+ end
1793
+ ```
1794
+
1795
+ #### Using the submit_self_service_logout_flow_without_browser_with_http_info variant
1796
+
1797
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1798
+
1799
+ > <Array(nil, Integer, Hash)> submit_self_service_logout_flow_without_browser_with_http_info(submit_self_service_logout_flow_without_browser_body)
1800
+
1801
+ ```ruby
1802
+ begin
1803
+ # Perform Logout for APIs, Services, Apps, ...
1804
+ data, status_code, headers = api_instance.submit_self_service_logout_flow_without_browser_with_http_info(submit_self_service_logout_flow_without_browser_body)
1805
+ p status_code # => 2xx
1806
+ p headers # => { ... }
1807
+ p data # => nil
1808
+ rescue OryKratosClient::ApiError => e
1809
+ puts "Error when calling V0alpha1Api->submit_self_service_logout_flow_without_browser_with_http_info: #{e}"
1810
+ end
1811
+ ```
1812
+
1813
+ ### Parameters
1814
+
1815
+ | Name | Type | Description | Notes |
1816
+ | ---- | ---- | ----------- | ----- |
1817
+ | **submit_self_service_logout_flow_without_browser_body** | [**SubmitSelfServiceLogoutFlowWithoutBrowserBody**](SubmitSelfServiceLogoutFlowWithoutBrowserBody.md) | | |
1818
+
1819
+ ### Return type
1820
+
1821
+ nil (empty response body)
1822
+
1823
+ ### Authorization
1824
+
1825
+ No authorization required
1826
+
1827
+ ### HTTP request headers
1828
+
1829
+ - **Content-Type**: application/json
1830
+ - **Accept**: application/json
1831
+
1832
+
1833
+ ## submit_self_service_recovery_flow
1834
+
1835
+ > <SelfServiceRecoveryFlow> submit_self_service_recovery_flow(flow, opts)
1836
+
1837
+ Complete Recovery Flow
1838
+
1839
+ Use this endpoint to complete a recovery flow. This endpoint behaves differently for API and browser flows and has several states: `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. For API clients and Browser clients with HTTP Header `Accept: application/json` 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 `Accept` or with `Accept: text/*` it returns a HTTP 302 Found redirect to the Recovery UI URL with the Recovery Flow ID appended. `sent_email` is the success state after `choose_method` for the `link` method and allows the user to request another recovery email. It works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state. `passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a recovery link\") does not have any API capabilities. The server responds with a HTTP 302 Found redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Recover UI URL with a new Recovery Flow ID which contains an error message that the recovery link was invalid. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
1840
+
1841
+ ### Examples
1842
+
1843
+ ```ruby
1844
+ require 'time'
1845
+ require 'ory-kratos-client'
1846
+
1847
+ api_instance = OryKratosClient::V0alpha1Api.new
1848
+ flow = 'flow_example' # String | The Recovery Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`).
1849
+ opts = {
1850
+ token: 'token_example', # String | 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.
1851
+ submit_self_service_recovery_flow_body: OryKratosClient::SubmitSelfServiceRecoveryFlowWithLinkMethodBody.new({email: 'email_example', method: 'link'}) # SubmitSelfServiceRecoveryFlowBody |
1852
+ }
1853
+
1854
+ begin
1855
+ # Complete Recovery Flow
1856
+ result = api_instance.submit_self_service_recovery_flow(flow, opts)
1857
+ p result
1858
+ rescue OryKratosClient::ApiError => e
1859
+ puts "Error when calling V0alpha1Api->submit_self_service_recovery_flow: #{e}"
1860
+ end
1861
+ ```
1862
+
1863
+ #### Using the submit_self_service_recovery_flow_with_http_info variant
1864
+
1865
+ This returns an Array which contains the response data, status code and headers.
1866
+
1867
+ > <Array(<SelfServiceRecoveryFlow>, Integer, Hash)> submit_self_service_recovery_flow_with_http_info(flow, opts)
1868
+
1869
+ ```ruby
1870
+ begin
1871
+ # Complete Recovery Flow
1872
+ data, status_code, headers = api_instance.submit_self_service_recovery_flow_with_http_info(flow, opts)
1873
+ p status_code # => 2xx
1874
+ p headers # => { ... }
1875
+ p data # => <SelfServiceRecoveryFlow>
1876
+ rescue OryKratosClient::ApiError => e
1877
+ puts "Error when calling V0alpha1Api->submit_self_service_recovery_flow_with_http_info: #{e}"
1878
+ end
1879
+ ```
1880
+
1881
+ ### Parameters
1882
+
1883
+ | Name | Type | Description | Notes |
1884
+ | ---- | ---- | ----------- | ----- |
1885
+ | **flow** | **String** | 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;). | |
1886
+ | **token** | **String** | 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. | [optional] |
1887
+ | **submit_self_service_recovery_flow_body** | [**SubmitSelfServiceRecoveryFlowBody**](SubmitSelfServiceRecoveryFlowBody.md) | | [optional] |
1888
+
1889
+ ### Return type
1890
+
1891
+ [**SelfServiceRecoveryFlow**](SelfServiceRecoveryFlow.md)
1892
+
1893
+ ### Authorization
1894
+
1895
+ No authorization required
1896
+
1897
+ ### HTTP request headers
1898
+
1899
+ - **Content-Type**: application/json, application/x-www-form-urlencoded
1900
+ - **Accept**: application/json
1901
+
1902
+
1903
+ ## submit_self_service_registration_flow
1904
+
1905
+ > <SuccessfulSelfServiceRegistrationWithoutBrowser> submit_self_service_registration_flow(flow, opts)
1906
+
1907
+ Submit a Registration Flow
1908
+
1909
+ Use this endpoint to complete a registration flow by sending an identity's traits and password. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and respond with HTTP 200 and a application/json body with the created identity success - if the session hook is configured the `session` and `session_token` will also be included; HTTP 302 redirect to a fresh registration flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. Browser flows expect a Content-Type of `application/x-www-form-urlencoded` or `application/json` to be sent in the body and respond with a HTTP 302 redirect to the post/after registration URL or the `return_to` value if it was set and if the registration succeeded; a HTTP 302 redirect to the registration UI URL with the flow ID containing the validation errors otherwise. Browser flows with an accept header of `application/json` will not redirect but instead respond with HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` 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).
1910
+
1911
+ ### Examples
1912
+
1913
+ ```ruby
1914
+ require 'time'
1915
+ require 'ory-kratos-client'
1916
+
1917
+ api_instance = OryKratosClient::V0alpha1Api.new
1918
+ flow = 'flow_example' # String | The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
1919
+ opts = {
1920
+ submit_self_service_registration_flow_body: OryKratosClient::SubmitSelfServiceRegistrationFlowWithPasswordMethodBody.new({method: 'password', password: 'password_example', traits: 3.56}) # SubmitSelfServiceRegistrationFlowBody |
1921
+ }
1922
+
1923
+ begin
1924
+ # Submit a Registration Flow
1925
+ result = api_instance.submit_self_service_registration_flow(flow, opts)
1926
+ p result
1927
+ rescue OryKratosClient::ApiError => e
1928
+ puts "Error when calling V0alpha1Api->submit_self_service_registration_flow: #{e}"
1929
+ end
1930
+ ```
1931
+
1932
+ #### Using the submit_self_service_registration_flow_with_http_info variant
1933
+
1934
+ This returns an Array which contains the response data, status code and headers.
1935
+
1936
+ > <Array(<SuccessfulSelfServiceRegistrationWithoutBrowser>, Integer, Hash)> submit_self_service_registration_flow_with_http_info(flow, opts)
1937
+
1938
+ ```ruby
1939
+ begin
1940
+ # Submit a Registration Flow
1941
+ data, status_code, headers = api_instance.submit_self_service_registration_flow_with_http_info(flow, opts)
1942
+ p status_code # => 2xx
1943
+ p headers # => { ... }
1944
+ p data # => <SuccessfulSelfServiceRegistrationWithoutBrowser>
1945
+ rescue OryKratosClient::ApiError => e
1946
+ puts "Error when calling V0alpha1Api->submit_self_service_registration_flow_with_http_info: #{e}"
1947
+ end
1948
+ ```
1949
+
1950
+ ### Parameters
1951
+
1952
+ | Name | Type | Description | Notes |
1953
+ | ---- | ---- | ----------- | ----- |
1954
+ | **flow** | **String** | The Registration Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/registration?flow&#x3D;abcde&#x60;). | |
1955
+ | **submit_self_service_registration_flow_body** | [**SubmitSelfServiceRegistrationFlowBody**](SubmitSelfServiceRegistrationFlowBody.md) | | [optional] |
1956
+
1957
+ ### Return type
1958
+
1959
+ [**SuccessfulSelfServiceRegistrationWithoutBrowser**](SuccessfulSelfServiceRegistrationWithoutBrowser.md)
1960
+
1961
+ ### Authorization
1962
+
1963
+ No authorization required
1964
+
1965
+ ### HTTP request headers
1966
+
1967
+ - **Content-Type**: application/json, application/x-www-form-urlencoded
1968
+ - **Accept**: application/json
1969
+
1970
+
1971
+ ## submit_self_service_settings_flow
1972
+
1973
+ > <SuccessfulSelfServiceSettingsWithoutBrowser> submit_self_service_settings_flow(flow, opts)
1974
+
1975
+ Complete Settings Flow
1976
+
1977
+ 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 without HTTP Header `Accept` or with `Accept: text/*` respond 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. Browser flows with HTTP Header `Accept: application/json` respond with HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` 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 & Profile Management Documentation](../self-service/flows/user-settings).
1978
+
1979
+ ### Examples
1980
+
1981
+ ```ruby
1982
+ require 'time'
1983
+ require 'ory-kratos-client'
1984
+
1985
+ api_instance = OryKratosClient::V0alpha1Api.new
1986
+ flow = 'flow_example' # String | The Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`).
1987
+ opts = {
1988
+ x_session_token: 'x_session_token_example', # String | The Session Token of the Identity performing the settings flow.
1989
+ submit_self_service_settings_flow_body: OryKratosClient::SubmitSelfServiceSettingsFlowWithPasswordMethodBody.new({method: 'password', password: 'password_example'}) # SubmitSelfServiceSettingsFlowBody |
1990
+ }
1991
+
1992
+ begin
1993
+ # Complete Settings Flow
1994
+ result = api_instance.submit_self_service_settings_flow(flow, opts)
1995
+ p result
1996
+ rescue OryKratosClient::ApiError => e
1997
+ puts "Error when calling V0alpha1Api->submit_self_service_settings_flow: #{e}"
1998
+ end
1999
+ ```
2000
+
2001
+ #### Using the submit_self_service_settings_flow_with_http_info variant
2002
+
2003
+ This returns an Array which contains the response data, status code and headers.
2004
+
2005
+ > <Array(<SuccessfulSelfServiceSettingsWithoutBrowser>, Integer, Hash)> submit_self_service_settings_flow_with_http_info(flow, opts)
2006
+
2007
+ ```ruby
2008
+ begin
2009
+ # Complete Settings Flow
2010
+ data, status_code, headers = api_instance.submit_self_service_settings_flow_with_http_info(flow, opts)
2011
+ p status_code # => 2xx
2012
+ p headers # => { ... }
2013
+ p data # => <SuccessfulSelfServiceSettingsWithoutBrowser>
2014
+ rescue OryKratosClient::ApiError => e
2015
+ puts "Error when calling V0alpha1Api->submit_self_service_settings_flow_with_http_info: #{e}"
2016
+ end
2017
+ ```
2018
+
2019
+ ### Parameters
2020
+
2021
+ | Name | Type | Description | Notes |
2022
+ | ---- | ---- | ----------- | ----- |
2023
+ | **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;). | |
2024
+ | **x_session_token** | **String** | The Session Token of the Identity performing the settings flow. | [optional] |
2025
+ | **submit_self_service_settings_flow_body** | [**SubmitSelfServiceSettingsFlowBody**](SubmitSelfServiceSettingsFlowBody.md) | | [optional] |
2026
+
2027
+ ### Return type
2028
+
2029
+ [**SuccessfulSelfServiceSettingsWithoutBrowser**](SuccessfulSelfServiceSettingsWithoutBrowser.md)
2030
+
2031
+ ### Authorization
2032
+
2033
+ No authorization required
2034
+
2035
+ ### HTTP request headers
2036
+
2037
+ - **Content-Type**: application/json, application/x-www-form-urlencoded
2038
+ - **Accept**: application/json
2039
+
2040
+
2041
+ ## submit_self_service_verification_flow
2042
+
2043
+ > <SelfServiceVerificationFlow> submit_self_service_verification_flow(flow, opts)
2044
+
2045
+ Complete Verification Flow
2046
+
2047
+ Use this endpoint to complete a verification flow. This endpoint behaves differently for API and browser flows and has several states: `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. For API clients and Browser clients with HTTP Header `Accept: application/json` 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 `Accept` or with `Accept: text/*` it returns a HTTP 302 Found redirect to the Verification UI URL with the Verification Flow ID appended. `sent_email` is the success state after `choose_method` when using the `link` method and allows the user to request another verification email. It works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state. `passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a verification link\") does not have any API capabilities. The server responds with a HTTP 302 Found redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Verification UI URL with a new Verification Flow ID which contains an error message that the verification link was invalid. More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
2048
+
2049
+ ### Examples
2050
+
2051
+ ```ruby
2052
+ require 'time'
2053
+ require 'ory-kratos-client'
2054
+
2055
+ api_instance = OryKratosClient::V0alpha1Api.new
2056
+ flow = 'flow_example' # String | The Verification Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`).
2057
+ opts = {
2058
+ token: 'token_example', # String | 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.
2059
+ submit_self_service_verification_flow_body: OryKratosClient::SubmitSelfServiceVerificationFlowWithLinkMethodBody.new({email: 'email_example', method: 'link'}) # SubmitSelfServiceVerificationFlowBody |
2060
+ }
2061
+
2062
+ begin
2063
+ # Complete Verification Flow
2064
+ result = api_instance.submit_self_service_verification_flow(flow, opts)
2065
+ p result
2066
+ rescue OryKratosClient::ApiError => e
2067
+ puts "Error when calling V0alpha1Api->submit_self_service_verification_flow: #{e}"
2068
+ end
2069
+ ```
2070
+
2071
+ #### Using the submit_self_service_verification_flow_with_http_info variant
2072
+
2073
+ This returns an Array which contains the response data, status code and headers.
2074
+
2075
+ > <Array(<SelfServiceVerificationFlow>, Integer, Hash)> submit_self_service_verification_flow_with_http_info(flow, opts)
2076
+
2077
+ ```ruby
2078
+ begin
2079
+ # Complete Verification Flow
2080
+ data, status_code, headers = api_instance.submit_self_service_verification_flow_with_http_info(flow, opts)
2081
+ p status_code # => 2xx
2082
+ p headers # => { ... }
2083
+ p data # => <SelfServiceVerificationFlow>
2084
+ rescue OryKratosClient::ApiError => e
2085
+ puts "Error when calling V0alpha1Api->submit_self_service_verification_flow_with_http_info: #{e}"
2086
+ end
2087
+ ```
2088
+
2089
+ ### Parameters
2090
+
2091
+ | Name | Type | Description | Notes |
2092
+ | ---- | ---- | ----------- | ----- |
2093
+ | **flow** | **String** | 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;). | |
2094
+ | **token** | **String** | 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. | [optional] |
2095
+ | **submit_self_service_verification_flow_body** | [**SubmitSelfServiceVerificationFlowBody**](SubmitSelfServiceVerificationFlowBody.md) | | [optional] |
2096
+
2097
+ ### Return type
2098
+
2099
+ [**SelfServiceVerificationFlow**](SelfServiceVerificationFlow.md)
2100
+
2101
+ ### Authorization
2102
+
2103
+ No authorization required
2104
+
2105
+ ### HTTP request headers
2106
+
2107
+ - **Content-Type**: application/json, application/x-www-form-urlencoded
2108
+ - **Accept**: application/json
2109
+
2110
+
2111
+ ## to_session
2112
+
2113
+ > <Session> to_session(opts)
2114
+
2115
+ Check Who the Current HTTP Session Belongs To
2116
+
2117
+ 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. If you call this endpoint from a server-side application, you must forward the HTTP Cookie Header to this endpoint: ```js pseudo-code example router.get('/protected-endpoint', async function (req, res) { const session = await client.toSession(undefined, req.header('cookie')) console.log(session) }) ``` When calling this endpoint from a non-browser application (e.g. mobile app) you must include the session token: ```js pseudo-code example ... const session = await client.toSession(\"the-session-token\") console.log(session) ``` 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! This endpoint authenticates users by checking if the `Cookie` HTTP header was set containing an Ory Kratos Session Cookie; if the `Authorization: bearer <ory-session-token>` HTTP header was set with a valid Ory Kratos Session Token; if the `X-Session-Token` 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.
2118
+
2119
+ ### Examples
2120
+
2121
+ ```ruby
2122
+ require 'time'
2123
+ require 'ory-kratos-client'
2124
+
2125
+ api_instance = OryKratosClient::V0alpha1Api.new
2126
+ opts = {
2127
+ x_session_token: 'MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj', # String | Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`.
2128
+ cookie: 'ory_kratos_session=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f==' # String | 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: `ory_kratos_session=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f==`. It is ok if more than one cookie are included here as all other cookies will be ignored.
2129
+ }
2130
+
2131
+ begin
2132
+ # Check Who the Current HTTP Session Belongs To
2133
+ result = api_instance.to_session(opts)
2134
+ p result
2135
+ rescue OryKratosClient::ApiError => e
2136
+ puts "Error when calling V0alpha1Api->to_session: #{e}"
2137
+ end
2138
+ ```
2139
+
2140
+ #### Using the to_session_with_http_info variant
2141
+
2142
+ This returns an Array which contains the response data, status code and headers.
2143
+
2144
+ > <Array(<Session>, Integer, Hash)> to_session_with_http_info(opts)
2145
+
2146
+ ```ruby
2147
+ begin
2148
+ # Check Who the Current HTTP Session Belongs To
2149
+ data, status_code, headers = api_instance.to_session_with_http_info(opts)
2150
+ p status_code # => 2xx
2151
+ p headers # => { ... }
2152
+ p data # => <Session>
2153
+ rescue OryKratosClient::ApiError => e
2154
+ puts "Error when calling V0alpha1Api->to_session_with_http_info: #{e}"
2155
+ end
2156
+ ```
2157
+
2158
+ ### Parameters
2159
+
2160
+ | Name | Type | Description | Notes |
2161
+ | ---- | ---- | ----------- | ----- |
2162
+ | **x_session_token** | **String** | Set the Session Token when calling from non-browser clients. A session token has a format of &#x60;MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj&#x60;. | [optional] |
2163
+ | **cookie** | **String** | 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. | [optional] |
2164
+
2165
+ ### Return type
2166
+
2167
+ [**Session**](Session.md)
2168
+
2169
+ ### Authorization
2170
+
2171
+ No authorization required
2172
+
2173
+ ### HTTP request headers
2174
+
2175
+ - **Content-Type**: Not defined
2176
+ - **Accept**: application/json
2177
+