ory-client-client 0.0.1.alpha1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (248) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +231 -0
  4. data/Rakefile +10 -0
  5. data/docs/AuthenticateOKBody.md +20 -0
  6. data/docs/ContainerChangeResponseItem.md +20 -0
  7. data/docs/ContainerCreateCreatedBody.md +20 -0
  8. data/docs/ContainerTopOKBody.md +20 -0
  9. data/docs/ContainerUpdateOKBody.md +18 -0
  10. data/docs/ContainerWaitOKBody.md +20 -0
  11. data/docs/ContainerWaitOKBodyError.md +18 -0
  12. data/docs/CreateIdentity.md +20 -0
  13. data/docs/CreateRecoveryLink.md +20 -0
  14. data/docs/DefaultApi.md +2902 -0
  15. data/docs/ErrorContainer.md +20 -0
  16. data/docs/ErrorResponse.md +18 -0
  17. data/docs/GenericError.md +30 -0
  18. data/docs/GraphDriverData.md +20 -0
  19. data/docs/HealthNotReadyStatus.md +18 -0
  20. data/docs/HealthStatus.md +18 -0
  21. data/docs/IdResponse.md +18 -0
  22. data/docs/Identity.md +28 -0
  23. data/docs/IdentityCredentials.md +22 -0
  24. data/docs/ImageDeleteResponseItem.md +20 -0
  25. data/docs/ImageSummary.md +36 -0
  26. data/docs/InlineResponse200.md +18 -0
  27. data/docs/InlineResponse2001.md +18 -0
  28. data/docs/InlineResponse503.md +18 -0
  29. data/docs/JsonError.md +18 -0
  30. data/docs/LoginFlow.md +32 -0
  31. data/docs/LoginViaApiResponse.md +20 -0
  32. data/docs/Meta.md +18 -0
  33. data/docs/Plugin.md +28 -0
  34. data/docs/PluginConfig.md +48 -0
  35. data/docs/PluginConfigArgs.md +24 -0
  36. data/docs/PluginConfigInterface.md +20 -0
  37. data/docs/PluginConfigLinux.md +22 -0
  38. data/docs/PluginConfigNetwork.md +18 -0
  39. data/docs/PluginConfigRootfs.md +20 -0
  40. data/docs/PluginConfigUser.md +20 -0
  41. data/docs/PluginDevice.md +24 -0
  42. data/docs/PluginEnv.md +24 -0
  43. data/docs/PluginInterfaceType.md +22 -0
  44. data/docs/PluginMount.md +30 -0
  45. data/docs/PluginSettings.md +24 -0
  46. data/docs/Port.md +24 -0
  47. data/docs/RecoveryAddress.md +22 -0
  48. data/docs/RecoveryFlow.md +32 -0
  49. data/docs/RecoveryLink.md +20 -0
  50. data/docs/RegistrationFlow.md +30 -0
  51. data/docs/RegistrationViaApiResponse.md +22 -0
  52. data/docs/RevokeSession.md +18 -0
  53. data/docs/ServiceUpdateResponse.md +18 -0
  54. data/docs/Session.md +28 -0
  55. data/docs/SettingsFlow.md +34 -0
  56. data/docs/SettingsProfileFormConfig.md +24 -0
  57. data/docs/SettingsViaApiResponse.md +20 -0
  58. data/docs/SubmitSelfServiceBrowserSettingsOIDCFlowPayload.md +22 -0
  59. data/docs/SubmitSelfServiceLoginFlow.md +47 -0
  60. data/docs/SubmitSelfServiceLoginFlowWithPasswordMethod.md +24 -0
  61. data/docs/SubmitSelfServiceRecoveryFlowWithLinkMethod.md +20 -0
  62. data/docs/SubmitSelfServiceRegistrationFlow.md +47 -0
  63. data/docs/SubmitSelfServiceRegistrationFlowWithPasswordMethod.md +24 -0
  64. data/docs/SubmitSelfServiceSettingsFlow.md +49 -0
  65. data/docs/SubmitSelfServiceSettingsFlowWithPasswordMethod.md +22 -0
  66. data/docs/SubmitSelfServiceSettingsFlowWithProfileMethod.md +22 -0
  67. data/docs/SubmitSelfServiceVerificationFlowWithLinkMethod.md +20 -0
  68. data/docs/UiContainer.md +24 -0
  69. data/docs/UiNode.md +26 -0
  70. data/docs/UiNodeAnchorAttributes.md +20 -0
  71. data/docs/UiNodeAttributes.md +53 -0
  72. data/docs/UiNodeImageAttributes.md +18 -0
  73. data/docs/UiNodeInputAttributes.md +30 -0
  74. data/docs/UiNodeInputAttributesValue.md +51 -0
  75. data/docs/UiNodeTextAttributes.md +18 -0
  76. data/docs/UiText.md +24 -0
  77. data/docs/UpdateIdentity.md +20 -0
  78. data/docs/VerifiableIdentityAddress.md +32 -0
  79. data/docs/VerificationFlow.md +32 -0
  80. data/docs/Version.md +18 -0
  81. data/docs/Volume.md +34 -0
  82. data/docs/VolumeUsageData.md +20 -0
  83. data/lib/ory-client-client.rb +117 -0
  84. data/lib/ory-client-client/api/default_api.rb +2690 -0
  85. data/lib/ory-client-client/api_client.rb +390 -0
  86. data/lib/ory-client-client/api_error.rb +57 -0
  87. data/lib/ory-client-client/configuration.rb +297 -0
  88. data/lib/ory-client-client/models/authenticate_ok_body.rb +240 -0
  89. data/lib/ory-client-client/models/container_change_response_item.rb +240 -0
  90. data/lib/ory-client-client/models/container_create_created_body.rb +242 -0
  91. data/lib/ory-client-client/models/container_top_ok_body.rb +244 -0
  92. data/lib/ory-client-client/models/container_update_ok_body.rb +227 -0
  93. data/lib/ory-client-client/models/container_wait_ok_body.rb +239 -0
  94. data/lib/ory-client-client/models/container_wait_ok_body_error.rb +220 -0
  95. data/lib/ory-client-client/models/create_identity.rb +239 -0
  96. data/lib/ory-client-client/models/create_recovery_link.rb +250 -0
  97. data/lib/ory-client-client/models/error_container.rb +240 -0
  98. data/lib/ory-client-client/models/error_response.rb +224 -0
  99. data/lib/ory-client-client/models/generic_error.rb +286 -0
  100. data/lib/ory-client-client/models/graph_driver_data.rb +241 -0
  101. data/lib/ory-client-client/models/health_not_ready_status.rb +221 -0
  102. data/lib/ory-client-client/models/health_status.rb +219 -0
  103. data/lib/ory-client-client/models/id_response.rb +225 -0
  104. data/lib/ory-client-client/models/identity.rb +289 -0
  105. data/lib/ory-client-client/models/identity_credentials.rb +241 -0
  106. data/lib/ory-client-client/models/image_delete_response_item.rb +230 -0
  107. data/lib/ory-client-client/models/image_summary.rb +366 -0
  108. data/lib/ory-client-client/models/inline_response200.rb +224 -0
  109. data/lib/ory-client-client/models/inline_response2001.rb +224 -0
  110. data/lib/ory-client-client/models/inline_response503.rb +226 -0
  111. data/lib/ory-client-client/models/json_error.rb +224 -0
  112. data/lib/ory-client-client/models/login_flow.rb +318 -0
  113. data/lib/ory-client-client/models/login_via_api_response.rb +239 -0
  114. data/lib/ory-client-client/models/meta.rb +219 -0
  115. data/lib/ory-client-client/models/plugin.rb +288 -0
  116. data/lib/ory-client-client/models/plugin_config.rb +434 -0
  117. data/lib/ory-client-client/models/plugin_config_args.rb +274 -0
  118. data/lib/ory-client-client/models/plugin_config_interface.rb +242 -0
  119. data/lib/ory-client-client/models/plugin_config_linux.rb +259 -0
  120. data/lib/ory-client-client/models/plugin_config_network.rb +225 -0
  121. data/lib/ory-client-client/models/plugin_config_rootfs.rb +232 -0
  122. data/lib/ory-client-client/models/plugin_config_user.rb +230 -0
  123. data/lib/ory-client-client/models/plugin_device.rb +272 -0
  124. data/lib/ory-client-client/models/plugin_env.rb +272 -0
  125. data/lib/ory-client-client/models/plugin_interface_type.rb +255 -0
  126. data/lib/ory-client-client/models/plugin_mount.rb +319 -0
  127. data/lib/ory-client-client/models/plugin_settings.rb +277 -0
  128. data/lib/ory-client-client/models/port.rb +260 -0
  129. data/lib/ory-client-client/models/recovery_address.rb +251 -0
  130. data/lib/ory-client-client/models/recovery_flow.rb +317 -0
  131. data/lib/ory-client-client/models/recovery_link.rb +234 -0
  132. data/lib/ory-client-client/models/registration_flow.rb +302 -0
  133. data/lib/ory-client-client/models/registration_via_api_response.rb +248 -0
  134. data/lib/ory-client-client/models/revoke_session.rb +224 -0
  135. data/lib/ory-client-client/models/service_update_response.rb +222 -0
  136. data/lib/ory-client-client/models/session.rb +288 -0
  137. data/lib/ory-client-client/models/settings_flow.rb +331 -0
  138. data/lib/ory-client-client/models/settings_profile_form_config.rb +266 -0
  139. data/lib/ory-client-client/models/settings_via_api_response.rb +238 -0
  140. data/lib/ory-client-client/models/submit_self_service_browser_settings_oidc_flow_payload.rb +239 -0
  141. data/lib/ory-client-client/models/submit_self_service_login_flow.rb +104 -0
  142. data/lib/ory-client-client/models/submit_self_service_login_flow_with_password_method.rb +249 -0
  143. data/lib/ory-client-client/models/submit_self_service_recovery_flow_with_link_method.rb +229 -0
  144. data/lib/ory-client-client/models/submit_self_service_registration_flow.rb +104 -0
  145. data/lib/ory-client-client/models/submit_self_service_registration_flow_with_password_method.rb +276 -0
  146. data/lib/ory-client-client/models/submit_self_service_settings_flow.rb +105 -0
  147. data/lib/ory-client-client/models/submit_self_service_settings_flow_with_password_method.rb +244 -0
  148. data/lib/ory-client-client/models/submit_self_service_settings_flow_with_profile_method.rb +245 -0
  149. data/lib/ory-client-client/models/submit_self_service_verification_flow_with_link_method.rb +230 -0
  150. data/lib/ory-client-client/models/ui_container.rb +267 -0
  151. data/lib/ory-client-client/models/ui_node.rb +282 -0
  152. data/lib/ory-client-client/models/ui_node_anchor_attributes.rb +238 -0
  153. data/lib/ory-client-client/models/ui_node_attributes.rb +107 -0
  154. data/lib/ory-client-client/models/ui_node_image_attributes.rb +224 -0
  155. data/lib/ory-client-client/models/ui_node_input_attributes.rb +292 -0
  156. data/lib/ory-client-client/models/ui_node_input_attributes_value.rb +106 -0
  157. data/lib/ory-client-client/models/ui_node_text_attributes.rb +223 -0
  158. data/lib/ory-client-client/models/ui_text.rb +262 -0
  159. data/lib/ory-client-client/models/update_identity.rb +234 -0
  160. data/lib/ory-client-client/models/verifiable_identity_address.rb +313 -0
  161. data/lib/ory-client-client/models/verification_flow.rb +307 -0
  162. data/lib/ory-client-client/models/version.rb +219 -0
  163. data/lib/ory-client-client/models/volume.rb +335 -0
  164. data/lib/ory-client-client/models/volume_usage_data.rb +240 -0
  165. data/lib/ory-client-client/version.rb +15 -0
  166. data/ory-client-client.gemspec +38 -0
  167. data/spec/api/default_api_spec.rb +544 -0
  168. data/spec/api_client_spec.rb +226 -0
  169. data/spec/configuration_spec.rb +42 -0
  170. data/spec/models/authenticate_ok_body_spec.rb +40 -0
  171. data/spec/models/container_change_response_item_spec.rb +40 -0
  172. data/spec/models/container_create_created_body_spec.rb +40 -0
  173. data/spec/models/container_top_ok_body_spec.rb +40 -0
  174. data/spec/models/container_update_ok_body_spec.rb +34 -0
  175. data/spec/models/container_wait_ok_body_error_spec.rb +34 -0
  176. data/spec/models/container_wait_ok_body_spec.rb +40 -0
  177. data/spec/models/create_identity_spec.rb +40 -0
  178. data/spec/models/create_recovery_link_spec.rb +40 -0
  179. data/spec/models/error_container_spec.rb +40 -0
  180. data/spec/models/error_response_spec.rb +34 -0
  181. data/spec/models/generic_error_spec.rb +70 -0
  182. data/spec/models/graph_driver_data_spec.rb +40 -0
  183. data/spec/models/health_not_ready_status_spec.rb +34 -0
  184. data/spec/models/health_status_spec.rb +34 -0
  185. data/spec/models/id_response_spec.rb +34 -0
  186. data/spec/models/identity_credentials_spec.rb +46 -0
  187. data/spec/models/identity_spec.rb +64 -0
  188. data/spec/models/image_delete_response_item_spec.rb +40 -0
  189. data/spec/models/image_summary_spec.rb +88 -0
  190. data/spec/models/inline_response2001_spec.rb +34 -0
  191. data/spec/models/inline_response200_spec.rb +34 -0
  192. data/spec/models/inline_response503_spec.rb +34 -0
  193. data/spec/models/json_error_spec.rb +34 -0
  194. data/spec/models/login_flow_spec.rb +76 -0
  195. data/spec/models/login_via_api_response_spec.rb +40 -0
  196. data/spec/models/meta_spec.rb +34 -0
  197. data/spec/models/plugin_config_args_spec.rb +52 -0
  198. data/spec/models/plugin_config_interface_spec.rb +40 -0
  199. data/spec/models/plugin_config_linux_spec.rb +46 -0
  200. data/spec/models/plugin_config_network_spec.rb +34 -0
  201. data/spec/models/plugin_config_rootfs_spec.rb +40 -0
  202. data/spec/models/plugin_config_spec.rb +124 -0
  203. data/spec/models/plugin_config_user_spec.rb +40 -0
  204. data/spec/models/plugin_device_spec.rb +52 -0
  205. data/spec/models/plugin_env_spec.rb +52 -0
  206. data/spec/models/plugin_interface_type_spec.rb +46 -0
  207. data/spec/models/plugin_mount_spec.rb +70 -0
  208. data/spec/models/plugin_settings_spec.rb +52 -0
  209. data/spec/models/plugin_spec.rb +64 -0
  210. data/spec/models/port_spec.rb +52 -0
  211. data/spec/models/recovery_address_spec.rb +46 -0
  212. data/spec/models/recovery_flow_spec.rb +76 -0
  213. data/spec/models/recovery_link_spec.rb +40 -0
  214. data/spec/models/registration_flow_spec.rb +70 -0
  215. data/spec/models/registration_via_api_response_spec.rb +46 -0
  216. data/spec/models/revoke_session_spec.rb +34 -0
  217. data/spec/models/service_update_response_spec.rb +34 -0
  218. data/spec/models/session_spec.rb +64 -0
  219. data/spec/models/settings_flow_spec.rb +82 -0
  220. data/spec/models/settings_profile_form_config_spec.rb +52 -0
  221. data/spec/models/settings_via_api_response_spec.rb +40 -0
  222. data/spec/models/submit_self_service_browser_settings_oidc_flow_payload_spec.rb +46 -0
  223. data/spec/models/submit_self_service_login_flow_spec.rb +31 -0
  224. data/spec/models/submit_self_service_login_flow_with_password_method_spec.rb +52 -0
  225. data/spec/models/submit_self_service_recovery_flow_with_link_method_spec.rb +40 -0
  226. data/spec/models/submit_self_service_registration_flow_spec.rb +31 -0
  227. data/spec/models/submit_self_service_registration_flow_with_password_method_spec.rb +52 -0
  228. data/spec/models/submit_self_service_settings_flow_spec.rb +31 -0
  229. data/spec/models/submit_self_service_settings_flow_with_password_method_spec.rb +46 -0
  230. data/spec/models/submit_self_service_settings_flow_with_profile_method_spec.rb +46 -0
  231. data/spec/models/submit_self_service_verification_flow_with_link_method_spec.rb +40 -0
  232. data/spec/models/ui_container_spec.rb +52 -0
  233. data/spec/models/ui_node_anchor_attributes_spec.rb +40 -0
  234. data/spec/models/ui_node_attributes_spec.rb +31 -0
  235. data/spec/models/ui_node_image_attributes_spec.rb +34 -0
  236. data/spec/models/ui_node_input_attributes_spec.rb +70 -0
  237. data/spec/models/ui_node_input_attributes_value_spec.rb +31 -0
  238. data/spec/models/ui_node_spec.rb +58 -0
  239. data/spec/models/ui_node_text_attributes_spec.rb +34 -0
  240. data/spec/models/ui_text_spec.rb +52 -0
  241. data/spec/models/update_identity_spec.rb +40 -0
  242. data/spec/models/verifiable_identity_address_spec.rb +76 -0
  243. data/spec/models/verification_flow_spec.rb +76 -0
  244. data/spec/models/version_spec.rb +34 -0
  245. data/spec/models/volume_spec.rb +82 -0
  246. data/spec/models/volume_usage_data_spec.rb +40 -0
  247. data/spec/spec_helper.rb +111 -0
  248. metadata +413 -0
@@ -0,0 +1,2902 @@
1
+ # OryHydraClient::DefaultApi
2
+
3
+ All URIs are relative to *https://playground.projects.oryapis.com*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**create_identity_admin**](DefaultApi.md#create_identity_admin) | **POST** /api/kratos/admin/identities | Create an Identity |
8
+ | [**create_recovery_link_admin**](DefaultApi.md#create_recovery_link_admin) | **POST** /api/kratos/admin/recovery/link | Create a Recovery Link |
9
+ | [**delete_identity_admin**](DefaultApi.md#delete_identity_admin) | **DELETE** /api/kratos/admin/identities/{id} | Delete an Identity |
10
+ | [**get_identity_admin**](DefaultApi.md#get_identity_admin) | **GET** /api/kratos/admin/identities/{id} | Get an Identity |
11
+ | [**get_schema**](DefaultApi.md#get_schema) | **GET** /api/kratos/public/schemas/{id} | |
12
+ | [**get_schema_admin**](DefaultApi.md#get_schema_admin) | **GET** /api/kratos/admin/schemas/{id} | |
13
+ | [**get_self_service_error**](DefaultApi.md#get_self_service_error) | **GET** /api/kratos/public/self-service/errors | Get User-Facing Self-Service Errors |
14
+ | [**get_self_service_error_admin**](DefaultApi.md#get_self_service_error_admin) | **GET** /api/kratos/admin/self-service/errors | Get User-Facing Self-Service Errors |
15
+ | [**get_self_service_login_flow**](DefaultApi.md#get_self_service_login_flow) | **GET** /api/kratos/public/self-service/login/flows | Get Login Flow |
16
+ | [**get_self_service_login_flow_admin**](DefaultApi.md#get_self_service_login_flow_admin) | **GET** /api/kratos/admin/self-service/login/flows | Get Login Flow |
17
+ | [**get_self_service_recovery_flow**](DefaultApi.md#get_self_service_recovery_flow) | **GET** /api/kratos/public/self-service/recovery/flows | Get information about a recovery flow |
18
+ | [**get_self_service_recovery_flow_admin**](DefaultApi.md#get_self_service_recovery_flow_admin) | **GET** /api/kratos/admin/self-service/recovery/flows | Get information about a recovery flow |
19
+ | [**get_self_service_registration_flow**](DefaultApi.md#get_self_service_registration_flow) | **GET** /api/kratos/public/self-service/registration/flows | Get Registration Flow |
20
+ | [**get_self_service_registration_flow_admin**](DefaultApi.md#get_self_service_registration_flow_admin) | **GET** /api/kratos/admin/self-service/registration/flows | Get Registration Flow |
21
+ | [**get_self_service_settings_flow**](DefaultApi.md#get_self_service_settings_flow) | **GET** /api/kratos/public/self-service/settings/flows | Get Settings Flow |
22
+ | [**get_self_service_settings_flow_admin**](DefaultApi.md#get_self_service_settings_flow_admin) | **GET** /api/kratos/admin/self-service/settings/flows | Get Settings Flow |
23
+ | [**get_self_service_verification_flow**](DefaultApi.md#get_self_service_verification_flow) | **GET** /api/kratos/public/self-service/verification/flows | Get Verification Flow |
24
+ | [**get_self_service_verification_flow_admin**](DefaultApi.md#get_self_service_verification_flow_admin) | **GET** /api/kratos/admin/self-service/verification/flows | Get Verification Flow |
25
+ | [**get_version_admin**](DefaultApi.md#get_version_admin) | **GET** /api/kratos/admin/version | Return Running Software Version. |
26
+ | [**initialize_self_service_browser_logout_flow**](DefaultApi.md#initialize_self_service_browser_logout_flow) | **GET** /api/kratos/public/self-service/browser/flows/logout | Initialize Browser-Based Logout User Flow |
27
+ | [**initialize_self_service_login_via_api_flow**](DefaultApi.md#initialize_self_service_login_via_api_flow) | **GET** /api/kratos/public/self-service/login/api | Initialize Login Flow for API clients |
28
+ | [**initialize_self_service_login_via_browser_flow**](DefaultApi.md#initialize_self_service_login_via_browser_flow) | **GET** /api/kratos/public/self-service/login/browser | Initialize Login Flow for browsers |
29
+ | [**initialize_self_service_recovery_via_api_flow**](DefaultApi.md#initialize_self_service_recovery_via_api_flow) | **GET** /api/kratos/public/self-service/recovery/api | Initialize Recovery Flow for API Clients |
30
+ | [**initialize_self_service_recovery_via_browser_flow**](DefaultApi.md#initialize_self_service_recovery_via_browser_flow) | **GET** /api/kratos/public/self-service/recovery/browser | Initialize Recovery Flow for Browser Clients |
31
+ | [**initialize_self_service_registration**](DefaultApi.md#initialize_self_service_registration) | **GET** /api/kratos/public/self-service/registration/api | Initialize Registration Flow for API clients |
32
+ | [**initialize_self_service_registration_for_browsers**](DefaultApi.md#initialize_self_service_registration_for_browsers) | **GET** /api/kratos/public/self-service/registration/browser | Initialize Registration Flow for browsers |
33
+ | [**initialize_self_service_settings_via_api_flow**](DefaultApi.md#initialize_self_service_settings_via_api_flow) | **GET** /api/kratos/public/self-service/settings/api | Initialize Settings Flow for API Clients |
34
+ | [**initialize_self_service_settings_via_browser_flow**](DefaultApi.md#initialize_self_service_settings_via_browser_flow) | **GET** /api/kratos/public/self-service/settings/browser | Initialize Settings Flow for Browsers |
35
+ | [**initialize_self_service_verification_via_api_flow**](DefaultApi.md#initialize_self_service_verification_via_api_flow) | **GET** /api/kratos/public/self-service/verification/api | Initialize Verification Flow for API Clients |
36
+ | [**initialize_self_service_verification_via_browser_flow**](DefaultApi.md#initialize_self_service_verification_via_browser_flow) | **GET** /api/kratos/public/self-service/verification/browser | Initialize Verification Flow for Browser Clients |
37
+ | [**is_alive_admin**](DefaultApi.md#is_alive_admin) | **GET** /api/kratos/admin/health/alive | Check HTTP Server Status |
38
+ | [**is_ready_admin**](DefaultApi.md#is_ready_admin) | **GET** /api/kratos/admin/health/ready | Check HTTP Server and Database Status |
39
+ | [**list_identities_admin**](DefaultApi.md#list_identities_admin) | **GET** /api/kratos/admin/identities | List Identities |
40
+ | [**prometheus_admin**](DefaultApi.md#prometheus_admin) | **GET** /api/kratos/admin/metrics/prometheus | Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so: |
41
+ | [**revoke_session**](DefaultApi.md#revoke_session) | **DELETE** /api/kratos/public/sessions | Initialize Logout Flow for API Clients - Revoke a Session |
42
+ | [**submit_self_service_login_flow**](DefaultApi.md#submit_self_service_login_flow) | **POST** /api/kratos/public/self-service/login | Submit a Login Flow |
43
+ | [**submit_self_service_recovery_flow**](DefaultApi.md#submit_self_service_recovery_flow) | **POST** /api/kratos/public/self-service/recovery | Complete Recovery Flow |
44
+ | [**submit_self_service_recovery_flow_with_link_method**](DefaultApi.md#submit_self_service_recovery_flow_with_link_method) | **POST** /api/kratos/public/self-service/recovery/methods/link | Complete Recovery Flow with Link Method |
45
+ | [**submit_self_service_registration_flow**](DefaultApi.md#submit_self_service_registration_flow) | **POST** /api/kratos/public/self-service/registration | Submit a Registration Flow |
46
+ | [**submit_self_service_settings_flow**](DefaultApi.md#submit_self_service_settings_flow) | **POST** /api/kratos/public/self-service/settings | Complete Settings Flow |
47
+ | [**submit_self_service_verification_flow**](DefaultApi.md#submit_self_service_verification_flow) | **POST** /api/kratos/public/self-service/verification/methods/link | Complete Verification Flow |
48
+ | [**to_session**](DefaultApi.md#to_session) | **GET** /api/kratos/public/sessions/whoami | Check Who the Current HTTP Session Belongs To |
49
+ | [**update_identity_admin**](DefaultApi.md#update_identity_admin) | **PUT** /api/kratos/admin/identities/{id} | Update an Identity |
50
+
51
+
52
+ ## create_identity_admin
53
+
54
+ > <Identity> create_identity_admin(opts)
55
+
56
+ Create an Identity
57
+
58
+ 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).
59
+
60
+ ### Examples
61
+
62
+ ```ruby
63
+ require 'time'
64
+ require 'ory-client-client'
65
+ # setup authorization
66
+ OryHydraClient.configure do |config|
67
+ # Configure Bearer authorization: oryToken
68
+ config.access_token = 'YOUR_BEARER_TOKEN'
69
+ end
70
+
71
+ api_instance = OryHydraClient::DefaultApi.new
72
+ opts = {
73
+ create_identity: OryHydraClient::CreateIdentity.new({schema_id: 'schema_id_example', traits: 3.56}) # CreateIdentity |
74
+ }
75
+
76
+ begin
77
+ # Create an Identity
78
+ result = api_instance.create_identity_admin(opts)
79
+ p result
80
+ rescue OryHydraClient::ApiError => e
81
+ puts "Error when calling DefaultApi->create_identity_admin: #{e}"
82
+ end
83
+ ```
84
+
85
+ #### Using the create_identity_admin_with_http_info variant
86
+
87
+ This returns an Array which contains the response data, status code and headers.
88
+
89
+ > <Array(<Identity>, Integer, Hash)> create_identity_admin_with_http_info(opts)
90
+
91
+ ```ruby
92
+ begin
93
+ # Create an Identity
94
+ data, status_code, headers = api_instance.create_identity_admin_with_http_info(opts)
95
+ p status_code # => 2xx
96
+ p headers # => { ... }
97
+ p data # => <Identity>
98
+ rescue OryHydraClient::ApiError => e
99
+ puts "Error when calling DefaultApi->create_identity_admin_with_http_info: #{e}"
100
+ end
101
+ ```
102
+
103
+ ### Parameters
104
+
105
+ | Name | Type | Description | Notes |
106
+ | ---- | ---- | ----------- | ----- |
107
+ | **create_identity** | [**CreateIdentity**](CreateIdentity.md) | | [optional] |
108
+
109
+ ### Return type
110
+
111
+ [**Identity**](Identity.md)
112
+
113
+ ### Authorization
114
+
115
+ [oryToken](../README.md#oryToken)
116
+
117
+ ### HTTP request headers
118
+
119
+ - **Content-Type**: application/json
120
+ - **Accept**: application/json
121
+
122
+
123
+ ## create_recovery_link_admin
124
+
125
+ > <RecoveryLink> create_recovery_link_admin(opts)
126
+
127
+ Create a Recovery Link
128
+
129
+ This endpoint creates a recovery link which should be given to the user in order for them to recover (or activate) their account.
130
+
131
+ ### Examples
132
+
133
+ ```ruby
134
+ require 'time'
135
+ require 'ory-client-client'
136
+ # setup authorization
137
+ OryHydraClient.configure do |config|
138
+ # Configure Bearer authorization: oryToken
139
+ config.access_token = 'YOUR_BEARER_TOKEN'
140
+ end
141
+
142
+ api_instance = OryHydraClient::DefaultApi.new
143
+ opts = {
144
+ create_recovery_link: OryHydraClient::CreateRecoveryLink.new({identity_id: 'identity_id_example'}) # CreateRecoveryLink |
145
+ }
146
+
147
+ begin
148
+ # Create a Recovery Link
149
+ result = api_instance.create_recovery_link_admin(opts)
150
+ p result
151
+ rescue OryHydraClient::ApiError => e
152
+ puts "Error when calling DefaultApi->create_recovery_link_admin: #{e}"
153
+ end
154
+ ```
155
+
156
+ #### Using the create_recovery_link_admin_with_http_info variant
157
+
158
+ This returns an Array which contains the response data, status code and headers.
159
+
160
+ > <Array(<RecoveryLink>, Integer, Hash)> create_recovery_link_admin_with_http_info(opts)
161
+
162
+ ```ruby
163
+ begin
164
+ # Create a Recovery Link
165
+ data, status_code, headers = api_instance.create_recovery_link_admin_with_http_info(opts)
166
+ p status_code # => 2xx
167
+ p headers # => { ... }
168
+ p data # => <RecoveryLink>
169
+ rescue OryHydraClient::ApiError => e
170
+ puts "Error when calling DefaultApi->create_recovery_link_admin_with_http_info: #{e}"
171
+ end
172
+ ```
173
+
174
+ ### Parameters
175
+
176
+ | Name | Type | Description | Notes |
177
+ | ---- | ---- | ----------- | ----- |
178
+ | **create_recovery_link** | [**CreateRecoveryLink**](CreateRecoveryLink.md) | | [optional] |
179
+
180
+ ### Return type
181
+
182
+ [**RecoveryLink**](RecoveryLink.md)
183
+
184
+ ### Authorization
185
+
186
+ [oryToken](../README.md#oryToken)
187
+
188
+ ### HTTP request headers
189
+
190
+ - **Content-Type**: application/json
191
+ - **Accept**: application/json
192
+
193
+
194
+ ## delete_identity_admin
195
+
196
+ > delete_identity_admin(id)
197
+
198
+ Delete an Identity
199
+
200
+ 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).
201
+
202
+ ### Examples
203
+
204
+ ```ruby
205
+ require 'time'
206
+ require 'ory-client-client'
207
+ # setup authorization
208
+ OryHydraClient.configure do |config|
209
+ # Configure Bearer authorization: oryToken
210
+ config.access_token = 'YOUR_BEARER_TOKEN'
211
+ end
212
+
213
+ api_instance = OryHydraClient::DefaultApi.new
214
+ id = 'id_example' # String | ID is the identity's ID.
215
+
216
+ begin
217
+ # Delete an Identity
218
+ api_instance.delete_identity_admin(id)
219
+ rescue OryHydraClient::ApiError => e
220
+ puts "Error when calling DefaultApi->delete_identity_admin: #{e}"
221
+ end
222
+ ```
223
+
224
+ #### Using the delete_identity_admin_with_http_info variant
225
+
226
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
227
+
228
+ > <Array(nil, Integer, Hash)> delete_identity_admin_with_http_info(id)
229
+
230
+ ```ruby
231
+ begin
232
+ # Delete an Identity
233
+ data, status_code, headers = api_instance.delete_identity_admin_with_http_info(id)
234
+ p status_code # => 2xx
235
+ p headers # => { ... }
236
+ p data # => nil
237
+ rescue OryHydraClient::ApiError => e
238
+ puts "Error when calling DefaultApi->delete_identity_admin_with_http_info: #{e}"
239
+ end
240
+ ```
241
+
242
+ ### Parameters
243
+
244
+ | Name | Type | Description | Notes |
245
+ | ---- | ---- | ----------- | ----- |
246
+ | **id** | **String** | ID is the identity&#39;s ID. | |
247
+
248
+ ### Return type
249
+
250
+ nil (empty response body)
251
+
252
+ ### Authorization
253
+
254
+ [oryToken](../README.md#oryToken)
255
+
256
+ ### HTTP request headers
257
+
258
+ - **Content-Type**: Not defined
259
+ - **Accept**: application/json
260
+
261
+
262
+ ## get_identity_admin
263
+
264
+ > <Identity> get_identity_admin(id)
265
+
266
+ Get an Identity
267
+
268
+ Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
269
+
270
+ ### Examples
271
+
272
+ ```ruby
273
+ require 'time'
274
+ require 'ory-client-client'
275
+ # setup authorization
276
+ OryHydraClient.configure do |config|
277
+ # Configure Bearer authorization: oryToken
278
+ config.access_token = 'YOUR_BEARER_TOKEN'
279
+ end
280
+
281
+ api_instance = OryHydraClient::DefaultApi.new
282
+ id = 'id_example' # String | ID must be set to the ID of identity you want to get
283
+
284
+ begin
285
+ # Get an Identity
286
+ result = api_instance.get_identity_admin(id)
287
+ p result
288
+ rescue OryHydraClient::ApiError => e
289
+ puts "Error when calling DefaultApi->get_identity_admin: #{e}"
290
+ end
291
+ ```
292
+
293
+ #### Using the get_identity_admin_with_http_info variant
294
+
295
+ This returns an Array which contains the response data, status code and headers.
296
+
297
+ > <Array(<Identity>, Integer, Hash)> get_identity_admin_with_http_info(id)
298
+
299
+ ```ruby
300
+ begin
301
+ # Get an Identity
302
+ data, status_code, headers = api_instance.get_identity_admin_with_http_info(id)
303
+ p status_code # => 2xx
304
+ p headers # => { ... }
305
+ p data # => <Identity>
306
+ rescue OryHydraClient::ApiError => e
307
+ puts "Error when calling DefaultApi->get_identity_admin_with_http_info: #{e}"
308
+ end
309
+ ```
310
+
311
+ ### Parameters
312
+
313
+ | Name | Type | Description | Notes |
314
+ | ---- | ---- | ----------- | ----- |
315
+ | **id** | **String** | ID must be set to the ID of identity you want to get | |
316
+
317
+ ### Return type
318
+
319
+ [**Identity**](Identity.md)
320
+
321
+ ### Authorization
322
+
323
+ [oryToken](../README.md#oryToken)
324
+
325
+ ### HTTP request headers
326
+
327
+ - **Content-Type**: Not defined
328
+ - **Accept**: application/json
329
+
330
+
331
+ ## get_schema
332
+
333
+ > Object get_schema(id)
334
+
335
+
336
+
337
+ Get a Traits Schema Definition
338
+
339
+ ### Examples
340
+
341
+ ```ruby
342
+ require 'time'
343
+ require 'ory-client-client'
344
+
345
+ api_instance = OryHydraClient::DefaultApi.new
346
+ id = 'id_example' # String | ID must be set to the ID of schema you want to get
347
+
348
+ begin
349
+
350
+ result = api_instance.get_schema(id)
351
+ p result
352
+ rescue OryHydraClient::ApiError => e
353
+ puts "Error when calling DefaultApi->get_schema: #{e}"
354
+ end
355
+ ```
356
+
357
+ #### Using the get_schema_with_http_info variant
358
+
359
+ This returns an Array which contains the response data, status code and headers.
360
+
361
+ > <Array(Object, Integer, Hash)> get_schema_with_http_info(id)
362
+
363
+ ```ruby
364
+ begin
365
+
366
+ data, status_code, headers = api_instance.get_schema_with_http_info(id)
367
+ p status_code # => 2xx
368
+ p headers # => { ... }
369
+ p data # => Object
370
+ rescue OryHydraClient::ApiError => e
371
+ puts "Error when calling DefaultApi->get_schema_with_http_info: #{e}"
372
+ end
373
+ ```
374
+
375
+ ### Parameters
376
+
377
+ | Name | Type | Description | Notes |
378
+ | ---- | ---- | ----------- | ----- |
379
+ | **id** | **String** | ID must be set to the ID of schema you want to get | |
380
+
381
+ ### Return type
382
+
383
+ **Object**
384
+
385
+ ### Authorization
386
+
387
+ No authorization required
388
+
389
+ ### HTTP request headers
390
+
391
+ - **Content-Type**: Not defined
392
+ - **Accept**: application/json
393
+
394
+
395
+ ## get_schema_admin
396
+
397
+ > Object get_schema_admin(id)
398
+
399
+
400
+
401
+ Get a Traits Schema Definition
402
+
403
+ ### Examples
404
+
405
+ ```ruby
406
+ require 'time'
407
+ require 'ory-client-client'
408
+ # setup authorization
409
+ OryHydraClient.configure do |config|
410
+ # Configure Bearer authorization: oryToken
411
+ config.access_token = 'YOUR_BEARER_TOKEN'
412
+ end
413
+
414
+ api_instance = OryHydraClient::DefaultApi.new
415
+ id = 'id_example' # String | ID must be set to the ID of schema you want to get
416
+
417
+ begin
418
+
419
+ result = api_instance.get_schema_admin(id)
420
+ p result
421
+ rescue OryHydraClient::ApiError => e
422
+ puts "Error when calling DefaultApi->get_schema_admin: #{e}"
423
+ end
424
+ ```
425
+
426
+ #### Using the get_schema_admin_with_http_info variant
427
+
428
+ This returns an Array which contains the response data, status code and headers.
429
+
430
+ > <Array(Object, Integer, Hash)> get_schema_admin_with_http_info(id)
431
+
432
+ ```ruby
433
+ begin
434
+
435
+ data, status_code, headers = api_instance.get_schema_admin_with_http_info(id)
436
+ p status_code # => 2xx
437
+ p headers # => { ... }
438
+ p data # => Object
439
+ rescue OryHydraClient::ApiError => e
440
+ puts "Error when calling DefaultApi->get_schema_admin_with_http_info: #{e}"
441
+ end
442
+ ```
443
+
444
+ ### Parameters
445
+
446
+ | Name | Type | Description | Notes |
447
+ | ---- | ---- | ----------- | ----- |
448
+ | **id** | **String** | ID must be set to the ID of schema you want to get | |
449
+
450
+ ### Return type
451
+
452
+ **Object**
453
+
454
+ ### Authorization
455
+
456
+ [oryToken](../README.md#oryToken)
457
+
458
+ ### HTTP request headers
459
+
460
+ - **Content-Type**: Not defined
461
+ - **Accept**: application/json
462
+
463
+
464
+ ## get_self_service_error
465
+
466
+ > <ErrorContainer> get_self_service_error(error)
467
+
468
+ Get User-Facing Self-Service Errors
469
+
470
+ This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: `?error=stub:500` - returns a stub 500 (Internal Server Error) error. More information can be found at [Ory Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
471
+
472
+ ### Examples
473
+
474
+ ```ruby
475
+ require 'time'
476
+ require 'ory-client-client'
477
+
478
+ api_instance = OryHydraClient::DefaultApi.new
479
+ error = 'error_example' # String | Error is the container's ID
480
+
481
+ begin
482
+ # Get User-Facing Self-Service Errors
483
+ result = api_instance.get_self_service_error(error)
484
+ p result
485
+ rescue OryHydraClient::ApiError => e
486
+ puts "Error when calling DefaultApi->get_self_service_error: #{e}"
487
+ end
488
+ ```
489
+
490
+ #### Using the get_self_service_error_with_http_info variant
491
+
492
+ This returns an Array which contains the response data, status code and headers.
493
+
494
+ > <Array(<ErrorContainer>, Integer, Hash)> get_self_service_error_with_http_info(error)
495
+
496
+ ```ruby
497
+ begin
498
+ # Get User-Facing Self-Service Errors
499
+ data, status_code, headers = api_instance.get_self_service_error_with_http_info(error)
500
+ p status_code # => 2xx
501
+ p headers # => { ... }
502
+ p data # => <ErrorContainer>
503
+ rescue OryHydraClient::ApiError => e
504
+ puts "Error when calling DefaultApi->get_self_service_error_with_http_info: #{e}"
505
+ end
506
+ ```
507
+
508
+ ### Parameters
509
+
510
+ | Name | Type | Description | Notes |
511
+ | ---- | ---- | ----------- | ----- |
512
+ | **error** | **String** | Error is the container&#39;s ID | |
513
+
514
+ ### Return type
515
+
516
+ [**ErrorContainer**](ErrorContainer.md)
517
+
518
+ ### Authorization
519
+
520
+ No authorization required
521
+
522
+ ### HTTP request headers
523
+
524
+ - **Content-Type**: Not defined
525
+ - **Accept**: application/json
526
+
527
+
528
+ ## get_self_service_error_admin
529
+
530
+ > <ErrorContainer> get_self_service_error_admin(error)
531
+
532
+ Get User-Facing Self-Service Errors
533
+
534
+ This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: `?error=stub:500` - returns a stub 500 (Internal Server Error) error. More information can be found at [Ory Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
535
+
536
+ ### Examples
537
+
538
+ ```ruby
539
+ require 'time'
540
+ require 'ory-client-client'
541
+ # setup authorization
542
+ OryHydraClient.configure do |config|
543
+ # Configure Bearer authorization: oryToken
544
+ config.access_token = 'YOUR_BEARER_TOKEN'
545
+ end
546
+
547
+ api_instance = OryHydraClient::DefaultApi.new
548
+ error = 'error_example' # String | Error is the container's ID
549
+
550
+ begin
551
+ # Get User-Facing Self-Service Errors
552
+ result = api_instance.get_self_service_error_admin(error)
553
+ p result
554
+ rescue OryHydraClient::ApiError => e
555
+ puts "Error when calling DefaultApi->get_self_service_error_admin: #{e}"
556
+ end
557
+ ```
558
+
559
+ #### Using the get_self_service_error_admin_with_http_info variant
560
+
561
+ This returns an Array which contains the response data, status code and headers.
562
+
563
+ > <Array(<ErrorContainer>, Integer, Hash)> get_self_service_error_admin_with_http_info(error)
564
+
565
+ ```ruby
566
+ begin
567
+ # Get User-Facing Self-Service Errors
568
+ data, status_code, headers = api_instance.get_self_service_error_admin_with_http_info(error)
569
+ p status_code # => 2xx
570
+ p headers # => { ... }
571
+ p data # => <ErrorContainer>
572
+ rescue OryHydraClient::ApiError => e
573
+ puts "Error when calling DefaultApi->get_self_service_error_admin_with_http_info: #{e}"
574
+ end
575
+ ```
576
+
577
+ ### Parameters
578
+
579
+ | Name | Type | Description | Notes |
580
+ | ---- | ---- | ----------- | ----- |
581
+ | **error** | **String** | Error is the container&#39;s ID | |
582
+
583
+ ### Return type
584
+
585
+ [**ErrorContainer**](ErrorContainer.md)
586
+
587
+ ### Authorization
588
+
589
+ [oryToken](../README.md#oryToken)
590
+
591
+ ### HTTP request headers
592
+
593
+ - **Content-Type**: Not defined
594
+ - **Accept**: application/json
595
+
596
+
597
+ ## get_self_service_login_flow
598
+
599
+ > <LoginFlow> get_self_service_login_flow(id)
600
+
601
+ Get Login Flow
602
+
603
+ This endpoint returns a login flow's context with, for example, error details and other information. 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).
604
+
605
+ ### Examples
606
+
607
+ ```ruby
608
+ require 'time'
609
+ require 'ory-client-client'
610
+
611
+ api_instance = OryHydraClient::DefaultApi.new
612
+ 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`).
613
+
614
+ begin
615
+ # Get Login Flow
616
+ result = api_instance.get_self_service_login_flow(id)
617
+ p result
618
+ rescue OryHydraClient::ApiError => e
619
+ puts "Error when calling DefaultApi->get_self_service_login_flow: #{e}"
620
+ end
621
+ ```
622
+
623
+ #### Using the get_self_service_login_flow_with_http_info variant
624
+
625
+ This returns an Array which contains the response data, status code and headers.
626
+
627
+ > <Array(<LoginFlow>, Integer, Hash)> get_self_service_login_flow_with_http_info(id)
628
+
629
+ ```ruby
630
+ begin
631
+ # Get Login Flow
632
+ data, status_code, headers = api_instance.get_self_service_login_flow_with_http_info(id)
633
+ p status_code # => 2xx
634
+ p headers # => { ... }
635
+ p data # => <LoginFlow>
636
+ rescue OryHydraClient::ApiError => e
637
+ puts "Error when calling DefaultApi->get_self_service_login_flow_with_http_info: #{e}"
638
+ end
639
+ ```
640
+
641
+ ### Parameters
642
+
643
+ | Name | Type | Description | Notes |
644
+ | ---- | ---- | ----------- | ----- |
645
+ | **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;). | |
646
+
647
+ ### Return type
648
+
649
+ [**LoginFlow**](LoginFlow.md)
650
+
651
+ ### Authorization
652
+
653
+ No authorization required
654
+
655
+ ### HTTP request headers
656
+
657
+ - **Content-Type**: Not defined
658
+ - **Accept**: application/json
659
+
660
+
661
+ ## get_self_service_login_flow_admin
662
+
663
+ > <LoginFlow> get_self_service_login_flow_admin(id)
664
+
665
+ Get Login Flow
666
+
667
+ This endpoint returns a login flow's context with, for example, error details and other information. 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).
668
+
669
+ ### Examples
670
+
671
+ ```ruby
672
+ require 'time'
673
+ require 'ory-client-client'
674
+ # setup authorization
675
+ OryHydraClient.configure do |config|
676
+ # Configure Bearer authorization: oryToken
677
+ config.access_token = 'YOUR_BEARER_TOKEN'
678
+ end
679
+
680
+ api_instance = OryHydraClient::DefaultApi.new
681
+ 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`).
682
+
683
+ begin
684
+ # Get Login Flow
685
+ result = api_instance.get_self_service_login_flow_admin(id)
686
+ p result
687
+ rescue OryHydraClient::ApiError => e
688
+ puts "Error when calling DefaultApi->get_self_service_login_flow_admin: #{e}"
689
+ end
690
+ ```
691
+
692
+ #### Using the get_self_service_login_flow_admin_with_http_info variant
693
+
694
+ This returns an Array which contains the response data, status code and headers.
695
+
696
+ > <Array(<LoginFlow>, Integer, Hash)> get_self_service_login_flow_admin_with_http_info(id)
697
+
698
+ ```ruby
699
+ begin
700
+ # Get Login Flow
701
+ data, status_code, headers = api_instance.get_self_service_login_flow_admin_with_http_info(id)
702
+ p status_code # => 2xx
703
+ p headers # => { ... }
704
+ p data # => <LoginFlow>
705
+ rescue OryHydraClient::ApiError => e
706
+ puts "Error when calling DefaultApi->get_self_service_login_flow_admin_with_http_info: #{e}"
707
+ end
708
+ ```
709
+
710
+ ### Parameters
711
+
712
+ | Name | Type | Description | Notes |
713
+ | ---- | ---- | ----------- | ----- |
714
+ | **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;). | |
715
+
716
+ ### Return type
717
+
718
+ [**LoginFlow**](LoginFlow.md)
719
+
720
+ ### Authorization
721
+
722
+ [oryToken](../README.md#oryToken)
723
+
724
+ ### HTTP request headers
725
+
726
+ - **Content-Type**: Not defined
727
+ - **Accept**: application/json
728
+
729
+
730
+ ## get_self_service_recovery_flow
731
+
732
+ > <RecoveryFlow> get_self_service_recovery_flow(id)
733
+
734
+ Get information about a recovery flow
735
+
736
+ This endpoint returns a recovery flow's context with, for example, error details and other information. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
737
+
738
+ ### Examples
739
+
740
+ ```ruby
741
+ require 'time'
742
+ require 'ory-client-client'
743
+
744
+ api_instance = OryHydraClient::DefaultApi.new
745
+ 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`).
746
+
747
+ begin
748
+ # Get information about a recovery flow
749
+ result = api_instance.get_self_service_recovery_flow(id)
750
+ p result
751
+ rescue OryHydraClient::ApiError => e
752
+ puts "Error when calling DefaultApi->get_self_service_recovery_flow: #{e}"
753
+ end
754
+ ```
755
+
756
+ #### Using the get_self_service_recovery_flow_with_http_info variant
757
+
758
+ This returns an Array which contains the response data, status code and headers.
759
+
760
+ > <Array(<RecoveryFlow>, Integer, Hash)> get_self_service_recovery_flow_with_http_info(id)
761
+
762
+ ```ruby
763
+ begin
764
+ # Get information about a recovery flow
765
+ data, status_code, headers = api_instance.get_self_service_recovery_flow_with_http_info(id)
766
+ p status_code # => 2xx
767
+ p headers # => { ... }
768
+ p data # => <RecoveryFlow>
769
+ rescue OryHydraClient::ApiError => e
770
+ puts "Error when calling DefaultApi->get_self_service_recovery_flow_with_http_info: #{e}"
771
+ end
772
+ ```
773
+
774
+ ### Parameters
775
+
776
+ | Name | Type | Description | Notes |
777
+ | ---- | ---- | ----------- | ----- |
778
+ | **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;). | |
779
+
780
+ ### Return type
781
+
782
+ [**RecoveryFlow**](RecoveryFlow.md)
783
+
784
+ ### Authorization
785
+
786
+ No authorization required
787
+
788
+ ### HTTP request headers
789
+
790
+ - **Content-Type**: Not defined
791
+ - **Accept**: application/json
792
+
793
+
794
+ ## get_self_service_recovery_flow_admin
795
+
796
+ > <RecoveryFlow> get_self_service_recovery_flow_admin(id)
797
+
798
+ Get information about a recovery flow
799
+
800
+ This endpoint returns a recovery flow's context with, for example, error details and other information. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
801
+
802
+ ### Examples
803
+
804
+ ```ruby
805
+ require 'time'
806
+ require 'ory-client-client'
807
+ # setup authorization
808
+ OryHydraClient.configure do |config|
809
+ # Configure Bearer authorization: oryToken
810
+ config.access_token = 'YOUR_BEARER_TOKEN'
811
+ end
812
+
813
+ api_instance = OryHydraClient::DefaultApi.new
814
+ 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`).
815
+
816
+ begin
817
+ # Get information about a recovery flow
818
+ result = api_instance.get_self_service_recovery_flow_admin(id)
819
+ p result
820
+ rescue OryHydraClient::ApiError => e
821
+ puts "Error when calling DefaultApi->get_self_service_recovery_flow_admin: #{e}"
822
+ end
823
+ ```
824
+
825
+ #### Using the get_self_service_recovery_flow_admin_with_http_info variant
826
+
827
+ This returns an Array which contains the response data, status code and headers.
828
+
829
+ > <Array(<RecoveryFlow>, Integer, Hash)> get_self_service_recovery_flow_admin_with_http_info(id)
830
+
831
+ ```ruby
832
+ begin
833
+ # Get information about a recovery flow
834
+ data, status_code, headers = api_instance.get_self_service_recovery_flow_admin_with_http_info(id)
835
+ p status_code # => 2xx
836
+ p headers # => { ... }
837
+ p data # => <RecoveryFlow>
838
+ rescue OryHydraClient::ApiError => e
839
+ puts "Error when calling DefaultApi->get_self_service_recovery_flow_admin_with_http_info: #{e}"
840
+ end
841
+ ```
842
+
843
+ ### Parameters
844
+
845
+ | Name | Type | Description | Notes |
846
+ | ---- | ---- | ----------- | ----- |
847
+ | **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;). | |
848
+
849
+ ### Return type
850
+
851
+ [**RecoveryFlow**](RecoveryFlow.md)
852
+
853
+ ### Authorization
854
+
855
+ [oryToken](../README.md#oryToken)
856
+
857
+ ### HTTP request headers
858
+
859
+ - **Content-Type**: Not defined
860
+ - **Accept**: application/json
861
+
862
+
863
+ ## get_self_service_registration_flow
864
+
865
+ > <RegistrationFlow> get_self_service_registration_flow(id)
866
+
867
+ Get Registration Flow
868
+
869
+ This endpoint returns a registration flow's context with, for example, error details and other information. 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).
870
+
871
+ ### Examples
872
+
873
+ ```ruby
874
+ require 'time'
875
+ require 'ory-client-client'
876
+
877
+ api_instance = OryHydraClient::DefaultApi.new
878
+ 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`).
879
+
880
+ begin
881
+ # Get Registration Flow
882
+ result = api_instance.get_self_service_registration_flow(id)
883
+ p result
884
+ rescue OryHydraClient::ApiError => e
885
+ puts "Error when calling DefaultApi->get_self_service_registration_flow: #{e}"
886
+ end
887
+ ```
888
+
889
+ #### Using the get_self_service_registration_flow_with_http_info variant
890
+
891
+ This returns an Array which contains the response data, status code and headers.
892
+
893
+ > <Array(<RegistrationFlow>, Integer, Hash)> get_self_service_registration_flow_with_http_info(id)
894
+
895
+ ```ruby
896
+ begin
897
+ # Get Registration Flow
898
+ data, status_code, headers = api_instance.get_self_service_registration_flow_with_http_info(id)
899
+ p status_code # => 2xx
900
+ p headers # => { ... }
901
+ p data # => <RegistrationFlow>
902
+ rescue OryHydraClient::ApiError => e
903
+ puts "Error when calling DefaultApi->get_self_service_registration_flow_with_http_info: #{e}"
904
+ end
905
+ ```
906
+
907
+ ### Parameters
908
+
909
+ | Name | Type | Description | Notes |
910
+ | ---- | ---- | ----------- | ----- |
911
+ | **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;). | |
912
+
913
+ ### Return type
914
+
915
+ [**RegistrationFlow**](RegistrationFlow.md)
916
+
917
+ ### Authorization
918
+
919
+ No authorization required
920
+
921
+ ### HTTP request headers
922
+
923
+ - **Content-Type**: Not defined
924
+ - **Accept**: application/json
925
+
926
+
927
+ ## get_self_service_registration_flow_admin
928
+
929
+ > <RegistrationFlow> get_self_service_registration_flow_admin(id)
930
+
931
+ Get Registration Flow
932
+
933
+ This endpoint returns a registration flow's context with, for example, error details and other information. 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).
934
+
935
+ ### Examples
936
+
937
+ ```ruby
938
+ require 'time'
939
+ require 'ory-client-client'
940
+ # setup authorization
941
+ OryHydraClient.configure do |config|
942
+ # Configure Bearer authorization: oryToken
943
+ config.access_token = 'YOUR_BEARER_TOKEN'
944
+ end
945
+
946
+ api_instance = OryHydraClient::DefaultApi.new
947
+ 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`).
948
+
949
+ begin
950
+ # Get Registration Flow
951
+ result = api_instance.get_self_service_registration_flow_admin(id)
952
+ p result
953
+ rescue OryHydraClient::ApiError => e
954
+ puts "Error when calling DefaultApi->get_self_service_registration_flow_admin: #{e}"
955
+ end
956
+ ```
957
+
958
+ #### Using the get_self_service_registration_flow_admin_with_http_info variant
959
+
960
+ This returns an Array which contains the response data, status code and headers.
961
+
962
+ > <Array(<RegistrationFlow>, Integer, Hash)> get_self_service_registration_flow_admin_with_http_info(id)
963
+
964
+ ```ruby
965
+ begin
966
+ # Get Registration Flow
967
+ data, status_code, headers = api_instance.get_self_service_registration_flow_admin_with_http_info(id)
968
+ p status_code # => 2xx
969
+ p headers # => { ... }
970
+ p data # => <RegistrationFlow>
971
+ rescue OryHydraClient::ApiError => e
972
+ puts "Error when calling DefaultApi->get_self_service_registration_flow_admin_with_http_info: #{e}"
973
+ end
974
+ ```
975
+
976
+ ### Parameters
977
+
978
+ | Name | Type | Description | Notes |
979
+ | ---- | ---- | ----------- | ----- |
980
+ | **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;). | |
981
+
982
+ ### Return type
983
+
984
+ [**RegistrationFlow**](RegistrationFlow.md)
985
+
986
+ ### Authorization
987
+
988
+ [oryToken](../README.md#oryToken)
989
+
990
+ ### HTTP request headers
991
+
992
+ - **Content-Type**: Not defined
993
+ - **Accept**: application/json
994
+
995
+
996
+ ## get_self_service_settings_flow
997
+
998
+ > <SettingsFlow> get_self_service_settings_flow(id)
999
+
1000
+ Get Settings Flow
1001
+
1002
+ 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).
1003
+
1004
+ ### Examples
1005
+
1006
+ ```ruby
1007
+ require 'time'
1008
+ require 'ory-client-client'
1009
+ # setup authorization
1010
+ OryHydraClient.configure do |config|
1011
+ # Configure Bearer authorization: sessionToken
1012
+ config.access_token = 'YOUR_BEARER_TOKEN'
1013
+ end
1014
+
1015
+ api_instance = OryHydraClient::DefaultApi.new
1016
+ 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`).
1017
+
1018
+ begin
1019
+ # Get Settings Flow
1020
+ result = api_instance.get_self_service_settings_flow(id)
1021
+ p result
1022
+ rescue OryHydraClient::ApiError => e
1023
+ puts "Error when calling DefaultApi->get_self_service_settings_flow: #{e}"
1024
+ end
1025
+ ```
1026
+
1027
+ #### Using the get_self_service_settings_flow_with_http_info variant
1028
+
1029
+ This returns an Array which contains the response data, status code and headers.
1030
+
1031
+ > <Array(<SettingsFlow>, Integer, Hash)> get_self_service_settings_flow_with_http_info(id)
1032
+
1033
+ ```ruby
1034
+ begin
1035
+ # Get Settings Flow
1036
+ data, status_code, headers = api_instance.get_self_service_settings_flow_with_http_info(id)
1037
+ p status_code # => 2xx
1038
+ p headers # => { ... }
1039
+ p data # => <SettingsFlow>
1040
+ rescue OryHydraClient::ApiError => e
1041
+ puts "Error when calling DefaultApi->get_self_service_settings_flow_with_http_info: #{e}"
1042
+ end
1043
+ ```
1044
+
1045
+ ### Parameters
1046
+
1047
+ | Name | Type | Description | Notes |
1048
+ | ---- | ---- | ----------- | ----- |
1049
+ | **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;). | |
1050
+
1051
+ ### Return type
1052
+
1053
+ [**SettingsFlow**](SettingsFlow.md)
1054
+
1055
+ ### Authorization
1056
+
1057
+ [sessionToken](../README.md#sessionToken)
1058
+
1059
+ ### HTTP request headers
1060
+
1061
+ - **Content-Type**: Not defined
1062
+ - **Accept**: application/json
1063
+
1064
+
1065
+ ## get_self_service_settings_flow_admin
1066
+
1067
+ > <SettingsFlow> get_self_service_settings_flow_admin(id)
1068
+
1069
+ Get Settings Flow
1070
+
1071
+ 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).
1072
+
1073
+ ### Examples
1074
+
1075
+ ```ruby
1076
+ require 'time'
1077
+ require 'ory-client-client'
1078
+ # setup authorization
1079
+ OryHydraClient.configure do |config|
1080
+ # Configure Bearer authorization: oryToken
1081
+ config.access_token = 'YOUR_BEARER_TOKEN'
1082
+ end
1083
+
1084
+ api_instance = OryHydraClient::DefaultApi.new
1085
+ 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`).
1086
+
1087
+ begin
1088
+ # Get Settings Flow
1089
+ result = api_instance.get_self_service_settings_flow_admin(id)
1090
+ p result
1091
+ rescue OryHydraClient::ApiError => e
1092
+ puts "Error when calling DefaultApi->get_self_service_settings_flow_admin: #{e}"
1093
+ end
1094
+ ```
1095
+
1096
+ #### Using the get_self_service_settings_flow_admin_with_http_info variant
1097
+
1098
+ This returns an Array which contains the response data, status code and headers.
1099
+
1100
+ > <Array(<SettingsFlow>, Integer, Hash)> get_self_service_settings_flow_admin_with_http_info(id)
1101
+
1102
+ ```ruby
1103
+ begin
1104
+ # Get Settings Flow
1105
+ data, status_code, headers = api_instance.get_self_service_settings_flow_admin_with_http_info(id)
1106
+ p status_code # => 2xx
1107
+ p headers # => { ... }
1108
+ p data # => <SettingsFlow>
1109
+ rescue OryHydraClient::ApiError => e
1110
+ puts "Error when calling DefaultApi->get_self_service_settings_flow_admin_with_http_info: #{e}"
1111
+ end
1112
+ ```
1113
+
1114
+ ### Parameters
1115
+
1116
+ | Name | Type | Description | Notes |
1117
+ | ---- | ---- | ----------- | ----- |
1118
+ | **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;). | |
1119
+
1120
+ ### Return type
1121
+
1122
+ [**SettingsFlow**](SettingsFlow.md)
1123
+
1124
+ ### Authorization
1125
+
1126
+ [oryToken](../README.md#oryToken)
1127
+
1128
+ ### HTTP request headers
1129
+
1130
+ - **Content-Type**: Not defined
1131
+ - **Accept**: application/json
1132
+
1133
+
1134
+ ## get_self_service_verification_flow
1135
+
1136
+ > <VerificationFlow> get_self_service_verification_flow(id)
1137
+
1138
+ Get Verification Flow
1139
+
1140
+ This endpoint returns a verification flow's context with, for example, error details and other information. 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).
1141
+
1142
+ ### Examples
1143
+
1144
+ ```ruby
1145
+ require 'time'
1146
+ require 'ory-client-client'
1147
+
1148
+ api_instance = OryHydraClient::DefaultApi.new
1149
+ 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`).
1150
+
1151
+ begin
1152
+ # Get Verification Flow
1153
+ result = api_instance.get_self_service_verification_flow(id)
1154
+ p result
1155
+ rescue OryHydraClient::ApiError => e
1156
+ puts "Error when calling DefaultApi->get_self_service_verification_flow: #{e}"
1157
+ end
1158
+ ```
1159
+
1160
+ #### Using the get_self_service_verification_flow_with_http_info variant
1161
+
1162
+ This returns an Array which contains the response data, status code and headers.
1163
+
1164
+ > <Array(<VerificationFlow>, Integer, Hash)> get_self_service_verification_flow_with_http_info(id)
1165
+
1166
+ ```ruby
1167
+ begin
1168
+ # Get Verification Flow
1169
+ data, status_code, headers = api_instance.get_self_service_verification_flow_with_http_info(id)
1170
+ p status_code # => 2xx
1171
+ p headers # => { ... }
1172
+ p data # => <VerificationFlow>
1173
+ rescue OryHydraClient::ApiError => e
1174
+ puts "Error when calling DefaultApi->get_self_service_verification_flow_with_http_info: #{e}"
1175
+ end
1176
+ ```
1177
+
1178
+ ### Parameters
1179
+
1180
+ | Name | Type | Description | Notes |
1181
+ | ---- | ---- | ----------- | ----- |
1182
+ | **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;). | |
1183
+
1184
+ ### Return type
1185
+
1186
+ [**VerificationFlow**](VerificationFlow.md)
1187
+
1188
+ ### Authorization
1189
+
1190
+ No authorization required
1191
+
1192
+ ### HTTP request headers
1193
+
1194
+ - **Content-Type**: Not defined
1195
+ - **Accept**: application/json
1196
+
1197
+
1198
+ ## get_self_service_verification_flow_admin
1199
+
1200
+ > <VerificationFlow> get_self_service_verification_flow_admin(id)
1201
+
1202
+ Get Verification Flow
1203
+
1204
+ This endpoint returns a verification flow's context with, for example, error details and other information. 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).
1205
+
1206
+ ### Examples
1207
+
1208
+ ```ruby
1209
+ require 'time'
1210
+ require 'ory-client-client'
1211
+ # setup authorization
1212
+ OryHydraClient.configure do |config|
1213
+ # Configure Bearer authorization: oryToken
1214
+ config.access_token = 'YOUR_BEARER_TOKEN'
1215
+ end
1216
+
1217
+ api_instance = OryHydraClient::DefaultApi.new
1218
+ 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`).
1219
+
1220
+ begin
1221
+ # Get Verification Flow
1222
+ result = api_instance.get_self_service_verification_flow_admin(id)
1223
+ p result
1224
+ rescue OryHydraClient::ApiError => e
1225
+ puts "Error when calling DefaultApi->get_self_service_verification_flow_admin: #{e}"
1226
+ end
1227
+ ```
1228
+
1229
+ #### Using the get_self_service_verification_flow_admin_with_http_info variant
1230
+
1231
+ This returns an Array which contains the response data, status code and headers.
1232
+
1233
+ > <Array(<VerificationFlow>, Integer, Hash)> get_self_service_verification_flow_admin_with_http_info(id)
1234
+
1235
+ ```ruby
1236
+ begin
1237
+ # Get Verification Flow
1238
+ data, status_code, headers = api_instance.get_self_service_verification_flow_admin_with_http_info(id)
1239
+ p status_code # => 2xx
1240
+ p headers # => { ... }
1241
+ p data # => <VerificationFlow>
1242
+ rescue OryHydraClient::ApiError => e
1243
+ puts "Error when calling DefaultApi->get_self_service_verification_flow_admin_with_http_info: #{e}"
1244
+ end
1245
+ ```
1246
+
1247
+ ### Parameters
1248
+
1249
+ | Name | Type | Description | Notes |
1250
+ | ---- | ---- | ----------- | ----- |
1251
+ | **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;). | |
1252
+
1253
+ ### Return type
1254
+
1255
+ [**VerificationFlow**](VerificationFlow.md)
1256
+
1257
+ ### Authorization
1258
+
1259
+ [oryToken](../README.md#oryToken)
1260
+
1261
+ ### HTTP request headers
1262
+
1263
+ - **Content-Type**: Not defined
1264
+ - **Accept**: application/json
1265
+
1266
+
1267
+ ## get_version_admin
1268
+
1269
+ > <InlineResponse2001> get_version_admin
1270
+
1271
+ Return Running Software Version.
1272
+
1273
+ This endpoint returns the version of Ory Kratos. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the version will never refer to the cluster state, only to a single instance.
1274
+
1275
+ ### Examples
1276
+
1277
+ ```ruby
1278
+ require 'time'
1279
+ require 'ory-client-client'
1280
+ # setup authorization
1281
+ OryHydraClient.configure do |config|
1282
+ # Configure Bearer authorization: oryToken
1283
+ config.access_token = 'YOUR_BEARER_TOKEN'
1284
+ end
1285
+
1286
+ api_instance = OryHydraClient::DefaultApi.new
1287
+
1288
+ begin
1289
+ # Return Running Software Version.
1290
+ result = api_instance.get_version_admin
1291
+ p result
1292
+ rescue OryHydraClient::ApiError => e
1293
+ puts "Error when calling DefaultApi->get_version_admin: #{e}"
1294
+ end
1295
+ ```
1296
+
1297
+ #### Using the get_version_admin_with_http_info variant
1298
+
1299
+ This returns an Array which contains the response data, status code and headers.
1300
+
1301
+ > <Array(<InlineResponse2001>, Integer, Hash)> get_version_admin_with_http_info
1302
+
1303
+ ```ruby
1304
+ begin
1305
+ # Return Running Software Version.
1306
+ data, status_code, headers = api_instance.get_version_admin_with_http_info
1307
+ p status_code # => 2xx
1308
+ p headers # => { ... }
1309
+ p data # => <InlineResponse2001>
1310
+ rescue OryHydraClient::ApiError => e
1311
+ puts "Error when calling DefaultApi->get_version_admin_with_http_info: #{e}"
1312
+ end
1313
+ ```
1314
+
1315
+ ### Parameters
1316
+
1317
+ This endpoint does not need any parameter.
1318
+
1319
+ ### Return type
1320
+
1321
+ [**InlineResponse2001**](InlineResponse2001.md)
1322
+
1323
+ ### Authorization
1324
+
1325
+ [oryToken](../README.md#oryToken)
1326
+
1327
+ ### HTTP request headers
1328
+
1329
+ - **Content-Type**: Not defined
1330
+ - **Accept**: application/json
1331
+
1332
+
1333
+ ## initialize_self_service_browser_logout_flow
1334
+
1335
+ > initialize_self_service_browser_logout_flow
1336
+
1337
+ Initialize Browser-Based Logout User Flow
1338
+
1339
+ This endpoint initializes a logout flow. > This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). On successful logout, 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`. More information can be found at [Ory Kratos User Logout Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-logout).
1340
+
1341
+ ### Examples
1342
+
1343
+ ```ruby
1344
+ require 'time'
1345
+ require 'ory-client-client'
1346
+
1347
+ api_instance = OryHydraClient::DefaultApi.new
1348
+
1349
+ begin
1350
+ # Initialize Browser-Based Logout User Flow
1351
+ api_instance.initialize_self_service_browser_logout_flow
1352
+ rescue OryHydraClient::ApiError => e
1353
+ puts "Error when calling DefaultApi->initialize_self_service_browser_logout_flow: #{e}"
1354
+ end
1355
+ ```
1356
+
1357
+ #### Using the initialize_self_service_browser_logout_flow_with_http_info variant
1358
+
1359
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1360
+
1361
+ > <Array(nil, Integer, Hash)> initialize_self_service_browser_logout_flow_with_http_info
1362
+
1363
+ ```ruby
1364
+ begin
1365
+ # Initialize Browser-Based Logout User Flow
1366
+ data, status_code, headers = api_instance.initialize_self_service_browser_logout_flow_with_http_info
1367
+ p status_code # => 2xx
1368
+ p headers # => { ... }
1369
+ p data # => nil
1370
+ rescue OryHydraClient::ApiError => e
1371
+ puts "Error when calling DefaultApi->initialize_self_service_browser_logout_flow_with_http_info: #{e}"
1372
+ end
1373
+ ```
1374
+
1375
+ ### Parameters
1376
+
1377
+ This endpoint does not need any parameter.
1378
+
1379
+ ### Return type
1380
+
1381
+ nil (empty response body)
1382
+
1383
+ ### Authorization
1384
+
1385
+ No authorization required
1386
+
1387
+ ### HTTP request headers
1388
+
1389
+ - **Content-Type**: Not defined
1390
+ - **Accept**: application/json
1391
+
1392
+
1393
+ ## initialize_self_service_login_via_api_flow
1394
+
1395
+ > <LoginFlow> initialize_self_service_login_via_api_flow(opts)
1396
+
1397
+ Initialize Login Flow for API clients
1398
+
1399
+ This endpoint initiates a login flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing login flow call `/self-service/login/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks, including CSRF login attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
1400
+
1401
+ ### Examples
1402
+
1403
+ ```ruby
1404
+ require 'time'
1405
+ require 'ory-client-client'
1406
+
1407
+ api_instance = OryHydraClient::DefaultApi.new
1408
+ opts = {
1409
+ 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.
1410
+ }
1411
+
1412
+ begin
1413
+ # Initialize Login Flow for API clients
1414
+ result = api_instance.initialize_self_service_login_via_api_flow(opts)
1415
+ p result
1416
+ rescue OryHydraClient::ApiError => e
1417
+ puts "Error when calling DefaultApi->initialize_self_service_login_via_api_flow: #{e}"
1418
+ end
1419
+ ```
1420
+
1421
+ #### Using the initialize_self_service_login_via_api_flow_with_http_info variant
1422
+
1423
+ This returns an Array which contains the response data, status code and headers.
1424
+
1425
+ > <Array(<LoginFlow>, Integer, Hash)> initialize_self_service_login_via_api_flow_with_http_info(opts)
1426
+
1427
+ ```ruby
1428
+ begin
1429
+ # Initialize Login Flow for API clients
1430
+ data, status_code, headers = api_instance.initialize_self_service_login_via_api_flow_with_http_info(opts)
1431
+ p status_code # => 2xx
1432
+ p headers # => { ... }
1433
+ p data # => <LoginFlow>
1434
+ rescue OryHydraClient::ApiError => e
1435
+ puts "Error when calling DefaultApi->initialize_self_service_login_via_api_flow_with_http_info: #{e}"
1436
+ end
1437
+ ```
1438
+
1439
+ ### Parameters
1440
+
1441
+ | Name | Type | Description | Notes |
1442
+ | ---- | ---- | ----------- | ----- |
1443
+ | **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] |
1444
+
1445
+ ### Return type
1446
+
1447
+ [**LoginFlow**](LoginFlow.md)
1448
+
1449
+ ### Authorization
1450
+
1451
+ No authorization required
1452
+
1453
+ ### HTTP request headers
1454
+
1455
+ - **Content-Type**: Not defined
1456
+ - **Accept**: application/json
1457
+
1458
+
1459
+ ## initialize_self_service_login_via_browser_flow
1460
+
1461
+ > initialize_self_service_login_via_browser_flow
1462
+
1463
+ Initialize Login Flow for browsers
1464
+
1465
+ This endpoint initializes a browser-based user login flow. Once initialized, the browser will be redirected to `selfservice.flows.login.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url` unless the query parameter `?refresh=true` was set. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
1466
+
1467
+ ### Examples
1468
+
1469
+ ```ruby
1470
+ require 'time'
1471
+ require 'ory-client-client'
1472
+
1473
+ api_instance = OryHydraClient::DefaultApi.new
1474
+
1475
+ begin
1476
+ # Initialize Login Flow for browsers
1477
+ api_instance.initialize_self_service_login_via_browser_flow
1478
+ rescue OryHydraClient::ApiError => e
1479
+ puts "Error when calling DefaultApi->initialize_self_service_login_via_browser_flow: #{e}"
1480
+ end
1481
+ ```
1482
+
1483
+ #### Using the initialize_self_service_login_via_browser_flow_with_http_info variant
1484
+
1485
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1486
+
1487
+ > <Array(nil, Integer, Hash)> initialize_self_service_login_via_browser_flow_with_http_info
1488
+
1489
+ ```ruby
1490
+ begin
1491
+ # Initialize Login Flow for browsers
1492
+ data, status_code, headers = api_instance.initialize_self_service_login_via_browser_flow_with_http_info
1493
+ p status_code # => 2xx
1494
+ p headers # => { ... }
1495
+ p data # => nil
1496
+ rescue OryHydraClient::ApiError => e
1497
+ puts "Error when calling DefaultApi->initialize_self_service_login_via_browser_flow_with_http_info: #{e}"
1498
+ end
1499
+ ```
1500
+
1501
+ ### Parameters
1502
+
1503
+ This endpoint does not need any parameter.
1504
+
1505
+ ### Return type
1506
+
1507
+ nil (empty response body)
1508
+
1509
+ ### Authorization
1510
+
1511
+ No authorization required
1512
+
1513
+ ### HTTP request headers
1514
+
1515
+ - **Content-Type**: Not defined
1516
+ - **Accept**: application/json
1517
+
1518
+
1519
+ ## initialize_self_service_recovery_via_api_flow
1520
+
1521
+ > <RecoveryFlow> initialize_self_service_recovery_via_api_flow
1522
+
1523
+ Initialize Recovery Flow for API Clients
1524
+
1525
+ This endpoint initiates a recovery flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error. To fetch an existing recovery flow call `/self-service/recovery/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
1526
+
1527
+ ### Examples
1528
+
1529
+ ```ruby
1530
+ require 'time'
1531
+ require 'ory-client-client'
1532
+
1533
+ api_instance = OryHydraClient::DefaultApi.new
1534
+
1535
+ begin
1536
+ # Initialize Recovery Flow for API Clients
1537
+ result = api_instance.initialize_self_service_recovery_via_api_flow
1538
+ p result
1539
+ rescue OryHydraClient::ApiError => e
1540
+ puts "Error when calling DefaultApi->initialize_self_service_recovery_via_api_flow: #{e}"
1541
+ end
1542
+ ```
1543
+
1544
+ #### Using the initialize_self_service_recovery_via_api_flow_with_http_info variant
1545
+
1546
+ This returns an Array which contains the response data, status code and headers.
1547
+
1548
+ > <Array(<RecoveryFlow>, Integer, Hash)> initialize_self_service_recovery_via_api_flow_with_http_info
1549
+
1550
+ ```ruby
1551
+ begin
1552
+ # Initialize Recovery Flow for API Clients
1553
+ data, status_code, headers = api_instance.initialize_self_service_recovery_via_api_flow_with_http_info
1554
+ p status_code # => 2xx
1555
+ p headers # => { ... }
1556
+ p data # => <RecoveryFlow>
1557
+ rescue OryHydraClient::ApiError => e
1558
+ puts "Error when calling DefaultApi->initialize_self_service_recovery_via_api_flow_with_http_info: #{e}"
1559
+ end
1560
+ ```
1561
+
1562
+ ### Parameters
1563
+
1564
+ This endpoint does not need any parameter.
1565
+
1566
+ ### Return type
1567
+
1568
+ [**RecoveryFlow**](RecoveryFlow.md)
1569
+
1570
+ ### Authorization
1571
+
1572
+ No authorization required
1573
+
1574
+ ### HTTP request headers
1575
+
1576
+ - **Content-Type**: Not defined
1577
+ - **Accept**: application/json
1578
+
1579
+
1580
+ ## initialize_self_service_recovery_via_browser_flow
1581
+
1582
+ > initialize_self_service_recovery_via_browser_flow
1583
+
1584
+ Initialize Recovery Flow for Browser Clients
1585
+
1586
+ This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to `selfservice.flows.recovery.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists, the browser is returned to the configured return URL. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery.mdx).
1587
+
1588
+ ### Examples
1589
+
1590
+ ```ruby
1591
+ require 'time'
1592
+ require 'ory-client-client'
1593
+
1594
+ api_instance = OryHydraClient::DefaultApi.new
1595
+
1596
+ begin
1597
+ # Initialize Recovery Flow for Browser Clients
1598
+ api_instance.initialize_self_service_recovery_via_browser_flow
1599
+ rescue OryHydraClient::ApiError => e
1600
+ puts "Error when calling DefaultApi->initialize_self_service_recovery_via_browser_flow: #{e}"
1601
+ end
1602
+ ```
1603
+
1604
+ #### Using the initialize_self_service_recovery_via_browser_flow_with_http_info variant
1605
+
1606
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1607
+
1608
+ > <Array(nil, Integer, Hash)> initialize_self_service_recovery_via_browser_flow_with_http_info
1609
+
1610
+ ```ruby
1611
+ begin
1612
+ # Initialize Recovery Flow for Browser Clients
1613
+ data, status_code, headers = api_instance.initialize_self_service_recovery_via_browser_flow_with_http_info
1614
+ p status_code # => 2xx
1615
+ p headers # => { ... }
1616
+ p data # => nil
1617
+ rescue OryHydraClient::ApiError => e
1618
+ puts "Error when calling DefaultApi->initialize_self_service_recovery_via_browser_flow_with_http_info: #{e}"
1619
+ end
1620
+ ```
1621
+
1622
+ ### Parameters
1623
+
1624
+ This endpoint does not need any parameter.
1625
+
1626
+ ### Return type
1627
+
1628
+ nil (empty response body)
1629
+
1630
+ ### Authorization
1631
+
1632
+ No authorization required
1633
+
1634
+ ### HTTP request headers
1635
+
1636
+ - **Content-Type**: Not defined
1637
+ - **Accept**: application/json
1638
+
1639
+
1640
+ ## initialize_self_service_registration
1641
+
1642
+ > <RegistrationFlow> initialize_self_service_registration
1643
+
1644
+ Initialize Registration Flow for API clients
1645
+
1646
+ This endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing registration flow call `/self-service/registration/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
1647
+
1648
+ ### Examples
1649
+
1650
+ ```ruby
1651
+ require 'time'
1652
+ require 'ory-client-client'
1653
+
1654
+ api_instance = OryHydraClient::DefaultApi.new
1655
+
1656
+ begin
1657
+ # Initialize Registration Flow for API clients
1658
+ result = api_instance.initialize_self_service_registration
1659
+ p result
1660
+ rescue OryHydraClient::ApiError => e
1661
+ puts "Error when calling DefaultApi->initialize_self_service_registration: #{e}"
1662
+ end
1663
+ ```
1664
+
1665
+ #### Using the initialize_self_service_registration_with_http_info variant
1666
+
1667
+ This returns an Array which contains the response data, status code and headers.
1668
+
1669
+ > <Array(<RegistrationFlow>, Integer, Hash)> initialize_self_service_registration_with_http_info
1670
+
1671
+ ```ruby
1672
+ begin
1673
+ # Initialize Registration Flow for API clients
1674
+ data, status_code, headers = api_instance.initialize_self_service_registration_with_http_info
1675
+ p status_code # => 2xx
1676
+ p headers # => { ... }
1677
+ p data # => <RegistrationFlow>
1678
+ rescue OryHydraClient::ApiError => e
1679
+ puts "Error when calling DefaultApi->initialize_self_service_registration_with_http_info: #{e}"
1680
+ end
1681
+ ```
1682
+
1683
+ ### Parameters
1684
+
1685
+ This endpoint does not need any parameter.
1686
+
1687
+ ### Return type
1688
+
1689
+ [**RegistrationFlow**](RegistrationFlow.md)
1690
+
1691
+ ### Authorization
1692
+
1693
+ No authorization required
1694
+
1695
+ ### HTTP request headers
1696
+
1697
+ - **Content-Type**: Not defined
1698
+ - **Accept**: application/json
1699
+
1700
+
1701
+ ## initialize_self_service_registration_for_browsers
1702
+
1703
+ > initialize_self_service_registration_for_browsers
1704
+
1705
+ Initialize Registration Flow for browsers
1706
+
1707
+ This endpoint initializes a browser-based user registration flow. Once initialized, the browser will be redirected to `selfservice.flows.registration.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url` unless the query parameter `?refresh=true` was set. :::note This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). ::: More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
1708
+
1709
+ ### Examples
1710
+
1711
+ ```ruby
1712
+ require 'time'
1713
+ require 'ory-client-client'
1714
+
1715
+ api_instance = OryHydraClient::DefaultApi.new
1716
+
1717
+ begin
1718
+ # Initialize Registration Flow for browsers
1719
+ api_instance.initialize_self_service_registration_for_browsers
1720
+ rescue OryHydraClient::ApiError => e
1721
+ puts "Error when calling DefaultApi->initialize_self_service_registration_for_browsers: #{e}"
1722
+ end
1723
+ ```
1724
+
1725
+ #### Using the initialize_self_service_registration_for_browsers_with_http_info variant
1726
+
1727
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1728
+
1729
+ > <Array(nil, Integer, Hash)> initialize_self_service_registration_for_browsers_with_http_info
1730
+
1731
+ ```ruby
1732
+ begin
1733
+ # Initialize Registration Flow for browsers
1734
+ data, status_code, headers = api_instance.initialize_self_service_registration_for_browsers_with_http_info
1735
+ p status_code # => 2xx
1736
+ p headers # => { ... }
1737
+ p data # => nil
1738
+ rescue OryHydraClient::ApiError => e
1739
+ puts "Error when calling DefaultApi->initialize_self_service_registration_for_browsers_with_http_info: #{e}"
1740
+ end
1741
+ ```
1742
+
1743
+ ### Parameters
1744
+
1745
+ This endpoint does not need any parameter.
1746
+
1747
+ ### Return type
1748
+
1749
+ nil (empty response body)
1750
+
1751
+ ### Authorization
1752
+
1753
+ No authorization required
1754
+
1755
+ ### HTTP request headers
1756
+
1757
+ - **Content-Type**: Not defined
1758
+ - **Accept**: application/json
1759
+
1760
+
1761
+ ## initialize_self_service_settings_via_api_flow
1762
+
1763
+ > <SettingsFlow> initialize_self_service_settings_via_api_flow
1764
+
1765
+ Initialize Settings Flow for API Clients
1766
+
1767
+ This endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on. You must provide a valid Ory Kratos Session Token for this endpoint to respond with HTTP 200 OK. To fetch an existing settings flow call `/self-service/settings/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
1768
+
1769
+ ### Examples
1770
+
1771
+ ```ruby
1772
+ require 'time'
1773
+ require 'ory-client-client'
1774
+ # setup authorization
1775
+ OryHydraClient.configure do |config|
1776
+ # Configure Bearer authorization: sessionToken
1777
+ config.access_token = 'YOUR_BEARER_TOKEN'
1778
+ end
1779
+
1780
+ api_instance = OryHydraClient::DefaultApi.new
1781
+
1782
+ begin
1783
+ # Initialize Settings Flow for API Clients
1784
+ result = api_instance.initialize_self_service_settings_via_api_flow
1785
+ p result
1786
+ rescue OryHydraClient::ApiError => e
1787
+ puts "Error when calling DefaultApi->initialize_self_service_settings_via_api_flow: #{e}"
1788
+ end
1789
+ ```
1790
+
1791
+ #### Using the initialize_self_service_settings_via_api_flow_with_http_info variant
1792
+
1793
+ This returns an Array which contains the response data, status code and headers.
1794
+
1795
+ > <Array(<SettingsFlow>, Integer, Hash)> initialize_self_service_settings_via_api_flow_with_http_info
1796
+
1797
+ ```ruby
1798
+ begin
1799
+ # Initialize Settings Flow for API Clients
1800
+ data, status_code, headers = api_instance.initialize_self_service_settings_via_api_flow_with_http_info
1801
+ p status_code # => 2xx
1802
+ p headers # => { ... }
1803
+ p data # => <SettingsFlow>
1804
+ rescue OryHydraClient::ApiError => e
1805
+ puts "Error when calling DefaultApi->initialize_self_service_settings_via_api_flow_with_http_info: #{e}"
1806
+ end
1807
+ ```
1808
+
1809
+ ### Parameters
1810
+
1811
+ This endpoint does not need any parameter.
1812
+
1813
+ ### Return type
1814
+
1815
+ [**SettingsFlow**](SettingsFlow.md)
1816
+
1817
+ ### Authorization
1818
+
1819
+ [sessionToken](../README.md#sessionToken)
1820
+
1821
+ ### HTTP request headers
1822
+
1823
+ - **Content-Type**: Not defined
1824
+ - **Accept**: application/json
1825
+
1826
+
1827
+ ## initialize_self_service_settings_via_browser_flow
1828
+
1829
+ > initialize_self_service_settings_via_browser_flow
1830
+
1831
+ Initialize Settings Flow for Browsers
1832
+
1833
+ This endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid Ory Kratos Session Cookie is included in the request, a login flow will be initialized. :::note This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). ::: More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
1834
+
1835
+ ### Examples
1836
+
1837
+ ```ruby
1838
+ require 'time'
1839
+ require 'ory-client-client'
1840
+ # setup authorization
1841
+ OryHydraClient.configure do |config|
1842
+ # Configure Bearer authorization: sessionToken
1843
+ config.access_token = 'YOUR_BEARER_TOKEN'
1844
+ end
1845
+
1846
+ api_instance = OryHydraClient::DefaultApi.new
1847
+
1848
+ begin
1849
+ # Initialize Settings Flow for Browsers
1850
+ api_instance.initialize_self_service_settings_via_browser_flow
1851
+ rescue OryHydraClient::ApiError => e
1852
+ puts "Error when calling DefaultApi->initialize_self_service_settings_via_browser_flow: #{e}"
1853
+ end
1854
+ ```
1855
+
1856
+ #### Using the initialize_self_service_settings_via_browser_flow_with_http_info variant
1857
+
1858
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1859
+
1860
+ > <Array(nil, Integer, Hash)> initialize_self_service_settings_via_browser_flow_with_http_info
1861
+
1862
+ ```ruby
1863
+ begin
1864
+ # Initialize Settings Flow for Browsers
1865
+ data, status_code, headers = api_instance.initialize_self_service_settings_via_browser_flow_with_http_info
1866
+ p status_code # => 2xx
1867
+ p headers # => { ... }
1868
+ p data # => nil
1869
+ rescue OryHydraClient::ApiError => e
1870
+ puts "Error when calling DefaultApi->initialize_self_service_settings_via_browser_flow_with_http_info: #{e}"
1871
+ end
1872
+ ```
1873
+
1874
+ ### Parameters
1875
+
1876
+ This endpoint does not need any parameter.
1877
+
1878
+ ### Return type
1879
+
1880
+ nil (empty response body)
1881
+
1882
+ ### Authorization
1883
+
1884
+ [sessionToken](../README.md#sessionToken)
1885
+
1886
+ ### HTTP request headers
1887
+
1888
+ - **Content-Type**: Not defined
1889
+ - **Accept**: application/json
1890
+
1891
+
1892
+ ## initialize_self_service_verification_via_api_flow
1893
+
1894
+ > <VerificationFlow> initialize_self_service_verification_via_api_flow
1895
+
1896
+ Initialize Verification Flow for API Clients
1897
+
1898
+ This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. To fetch an existing verification flow call `/self-service/verification/flows?flow=<flow_id>`. :::warning You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). ::: More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
1899
+
1900
+ ### Examples
1901
+
1902
+ ```ruby
1903
+ require 'time'
1904
+ require 'ory-client-client'
1905
+
1906
+ api_instance = OryHydraClient::DefaultApi.new
1907
+
1908
+ begin
1909
+ # Initialize Verification Flow for API Clients
1910
+ result = api_instance.initialize_self_service_verification_via_api_flow
1911
+ p result
1912
+ rescue OryHydraClient::ApiError => e
1913
+ puts "Error when calling DefaultApi->initialize_self_service_verification_via_api_flow: #{e}"
1914
+ end
1915
+ ```
1916
+
1917
+ #### Using the initialize_self_service_verification_via_api_flow_with_http_info variant
1918
+
1919
+ This returns an Array which contains the response data, status code and headers.
1920
+
1921
+ > <Array(<VerificationFlow>, Integer, Hash)> initialize_self_service_verification_via_api_flow_with_http_info
1922
+
1923
+ ```ruby
1924
+ begin
1925
+ # Initialize Verification Flow for API Clients
1926
+ data, status_code, headers = api_instance.initialize_self_service_verification_via_api_flow_with_http_info
1927
+ p status_code # => 2xx
1928
+ p headers # => { ... }
1929
+ p data # => <VerificationFlow>
1930
+ rescue OryHydraClient::ApiError => e
1931
+ puts "Error when calling DefaultApi->initialize_self_service_verification_via_api_flow_with_http_info: #{e}"
1932
+ end
1933
+ ```
1934
+
1935
+ ### Parameters
1936
+
1937
+ This endpoint does not need any parameter.
1938
+
1939
+ ### Return type
1940
+
1941
+ [**VerificationFlow**](VerificationFlow.md)
1942
+
1943
+ ### Authorization
1944
+
1945
+ No authorization required
1946
+
1947
+ ### HTTP request headers
1948
+
1949
+ - **Content-Type**: Not defined
1950
+ - **Accept**: application/json
1951
+
1952
+
1953
+ ## initialize_self_service_verification_via_browser_flow
1954
+
1955
+ > initialize_self_service_verification_via_browser_flow
1956
+
1957
+ Initialize Verification Flow for Browser Clients
1958
+
1959
+ This endpoint initializes a browser-based account verification flow. Once initialized, the browser will be redirected to `selfservice.flows.verification.ui_url` with the flow ID set as the query parameter `?flow=`. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
1960
+
1961
+ ### Examples
1962
+
1963
+ ```ruby
1964
+ require 'time'
1965
+ require 'ory-client-client'
1966
+
1967
+ api_instance = OryHydraClient::DefaultApi.new
1968
+
1969
+ begin
1970
+ # Initialize Verification Flow for Browser Clients
1971
+ api_instance.initialize_self_service_verification_via_browser_flow
1972
+ rescue OryHydraClient::ApiError => e
1973
+ puts "Error when calling DefaultApi->initialize_self_service_verification_via_browser_flow: #{e}"
1974
+ end
1975
+ ```
1976
+
1977
+ #### Using the initialize_self_service_verification_via_browser_flow_with_http_info variant
1978
+
1979
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
1980
+
1981
+ > <Array(nil, Integer, Hash)> initialize_self_service_verification_via_browser_flow_with_http_info
1982
+
1983
+ ```ruby
1984
+ begin
1985
+ # Initialize Verification Flow for Browser Clients
1986
+ data, status_code, headers = api_instance.initialize_self_service_verification_via_browser_flow_with_http_info
1987
+ p status_code # => 2xx
1988
+ p headers # => { ... }
1989
+ p data # => nil
1990
+ rescue OryHydraClient::ApiError => e
1991
+ puts "Error when calling DefaultApi->initialize_self_service_verification_via_browser_flow_with_http_info: #{e}"
1992
+ end
1993
+ ```
1994
+
1995
+ ### Parameters
1996
+
1997
+ This endpoint does not need any parameter.
1998
+
1999
+ ### Return type
2000
+
2001
+ nil (empty response body)
2002
+
2003
+ ### Authorization
2004
+
2005
+ No authorization required
2006
+
2007
+ ### HTTP request headers
2008
+
2009
+ - **Content-Type**: Not defined
2010
+ - **Accept**: application/json
2011
+
2012
+
2013
+ ## is_alive_admin
2014
+
2015
+ > <InlineResponse200> is_alive_admin
2016
+
2017
+ Check HTTP Server Status
2018
+
2019
+ This endpoint returns a HTTP 200 status code when Ory Kratos is accepting incoming HTTP requests. This status does currently not include checks whether the database connection is working. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
2020
+
2021
+ ### Examples
2022
+
2023
+ ```ruby
2024
+ require 'time'
2025
+ require 'ory-client-client'
2026
+ # setup authorization
2027
+ OryHydraClient.configure do |config|
2028
+ # Configure Bearer authorization: oryToken
2029
+ config.access_token = 'YOUR_BEARER_TOKEN'
2030
+ end
2031
+
2032
+ api_instance = OryHydraClient::DefaultApi.new
2033
+
2034
+ begin
2035
+ # Check HTTP Server Status
2036
+ result = api_instance.is_alive_admin
2037
+ p result
2038
+ rescue OryHydraClient::ApiError => e
2039
+ puts "Error when calling DefaultApi->is_alive_admin: #{e}"
2040
+ end
2041
+ ```
2042
+
2043
+ #### Using the is_alive_admin_with_http_info variant
2044
+
2045
+ This returns an Array which contains the response data, status code and headers.
2046
+
2047
+ > <Array(<InlineResponse200>, Integer, Hash)> is_alive_admin_with_http_info
2048
+
2049
+ ```ruby
2050
+ begin
2051
+ # Check HTTP Server Status
2052
+ data, status_code, headers = api_instance.is_alive_admin_with_http_info
2053
+ p status_code # => 2xx
2054
+ p headers # => { ... }
2055
+ p data # => <InlineResponse200>
2056
+ rescue OryHydraClient::ApiError => e
2057
+ puts "Error when calling DefaultApi->is_alive_admin_with_http_info: #{e}"
2058
+ end
2059
+ ```
2060
+
2061
+ ### Parameters
2062
+
2063
+ This endpoint does not need any parameter.
2064
+
2065
+ ### Return type
2066
+
2067
+ [**InlineResponse200**](InlineResponse200.md)
2068
+
2069
+ ### Authorization
2070
+
2071
+ [oryToken](../README.md#oryToken)
2072
+
2073
+ ### HTTP request headers
2074
+
2075
+ - **Content-Type**: Not defined
2076
+ - **Accept**: application/json
2077
+
2078
+
2079
+ ## is_ready_admin
2080
+
2081
+ > <InlineResponse200> is_ready_admin
2082
+
2083
+ Check HTTP Server and Database Status
2084
+
2085
+ This endpoint returns a HTTP 200 status code when Ory Kratos is up running and the environment dependencies (e.g. the database) are responsive as well. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of Ory Kratos, the health status will never refer to the cluster state, only to a single instance.
2086
+
2087
+ ### Examples
2088
+
2089
+ ```ruby
2090
+ require 'time'
2091
+ require 'ory-client-client'
2092
+ # setup authorization
2093
+ OryHydraClient.configure do |config|
2094
+ # Configure Bearer authorization: oryToken
2095
+ config.access_token = 'YOUR_BEARER_TOKEN'
2096
+ end
2097
+
2098
+ api_instance = OryHydraClient::DefaultApi.new
2099
+
2100
+ begin
2101
+ # Check HTTP Server and Database Status
2102
+ result = api_instance.is_ready_admin
2103
+ p result
2104
+ rescue OryHydraClient::ApiError => e
2105
+ puts "Error when calling DefaultApi->is_ready_admin: #{e}"
2106
+ end
2107
+ ```
2108
+
2109
+ #### Using the is_ready_admin_with_http_info variant
2110
+
2111
+ This returns an Array which contains the response data, status code and headers.
2112
+
2113
+ > <Array(<InlineResponse200>, Integer, Hash)> is_ready_admin_with_http_info
2114
+
2115
+ ```ruby
2116
+ begin
2117
+ # Check HTTP Server and Database Status
2118
+ data, status_code, headers = api_instance.is_ready_admin_with_http_info
2119
+ p status_code # => 2xx
2120
+ p headers # => { ... }
2121
+ p data # => <InlineResponse200>
2122
+ rescue OryHydraClient::ApiError => e
2123
+ puts "Error when calling DefaultApi->is_ready_admin_with_http_info: #{e}"
2124
+ end
2125
+ ```
2126
+
2127
+ ### Parameters
2128
+
2129
+ This endpoint does not need any parameter.
2130
+
2131
+ ### Return type
2132
+
2133
+ [**InlineResponse200**](InlineResponse200.md)
2134
+
2135
+ ### Authorization
2136
+
2137
+ [oryToken](../README.md#oryToken)
2138
+
2139
+ ### HTTP request headers
2140
+
2141
+ - **Content-Type**: Not defined
2142
+ - **Accept**: application/json
2143
+
2144
+
2145
+ ## list_identities_admin
2146
+
2147
+ > <Array<Identity>> list_identities_admin(opts)
2148
+
2149
+ List Identities
2150
+
2151
+ 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).
2152
+
2153
+ ### Examples
2154
+
2155
+ ```ruby
2156
+ require 'time'
2157
+ require 'ory-client-client'
2158
+ # setup authorization
2159
+ OryHydraClient.configure do |config|
2160
+ # Configure Bearer authorization: oryToken
2161
+ config.access_token = 'YOUR_BEARER_TOKEN'
2162
+ end
2163
+
2164
+ api_instance = OryHydraClient::DefaultApi.new
2165
+ opts = {
2166
+ per_page: 789, # Integer | Items per Page This is the number of items per page.
2167
+ page: 789 # Integer | Pagination Page
2168
+ }
2169
+
2170
+ begin
2171
+ # List Identities
2172
+ result = api_instance.list_identities_admin(opts)
2173
+ p result
2174
+ rescue OryHydraClient::ApiError => e
2175
+ puts "Error when calling DefaultApi->list_identities_admin: #{e}"
2176
+ end
2177
+ ```
2178
+
2179
+ #### Using the list_identities_admin_with_http_info variant
2180
+
2181
+ This returns an Array which contains the response data, status code and headers.
2182
+
2183
+ > <Array(<Array<Identity>>, Integer, Hash)> list_identities_admin_with_http_info(opts)
2184
+
2185
+ ```ruby
2186
+ begin
2187
+ # List Identities
2188
+ data, status_code, headers = api_instance.list_identities_admin_with_http_info(opts)
2189
+ p status_code # => 2xx
2190
+ p headers # => { ... }
2191
+ p data # => <Array<Identity>>
2192
+ rescue OryHydraClient::ApiError => e
2193
+ puts "Error when calling DefaultApi->list_identities_admin_with_http_info: #{e}"
2194
+ end
2195
+ ```
2196
+
2197
+ ### Parameters
2198
+
2199
+ | Name | Type | Description | Notes |
2200
+ | ---- | ---- | ----------- | ----- |
2201
+ | **per_page** | **Integer** | Items per Page This is the number of items per page. | [optional][default to 100] |
2202
+ | **page** | **Integer** | Pagination Page | [optional][default to 0] |
2203
+
2204
+ ### Return type
2205
+
2206
+ [**Array&lt;Identity&gt;**](Identity.md)
2207
+
2208
+ ### Authorization
2209
+
2210
+ [oryToken](../README.md#oryToken)
2211
+
2212
+ ### HTTP request headers
2213
+
2214
+ - **Content-Type**: Not defined
2215
+ - **Accept**: application/json
2216
+
2217
+
2218
+ ## prometheus_admin
2219
+
2220
+ > prometheus_admin
2221
+
2222
+ Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
2223
+
2224
+ ``` metadata: annotations: prometheus.io/port: \"4434\" prometheus.io/path: \"/metrics/prometheus\" ```
2225
+
2226
+ ### Examples
2227
+
2228
+ ```ruby
2229
+ require 'time'
2230
+ require 'ory-client-client'
2231
+ # setup authorization
2232
+ OryHydraClient.configure do |config|
2233
+ # Configure Bearer authorization: oryToken
2234
+ config.access_token = 'YOUR_BEARER_TOKEN'
2235
+ end
2236
+
2237
+ api_instance = OryHydraClient::DefaultApi.new
2238
+
2239
+ begin
2240
+ # Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
2241
+ api_instance.prometheus_admin
2242
+ rescue OryHydraClient::ApiError => e
2243
+ puts "Error when calling DefaultApi->prometheus_admin: #{e}"
2244
+ end
2245
+ ```
2246
+
2247
+ #### Using the prometheus_admin_with_http_info variant
2248
+
2249
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
2250
+
2251
+ > <Array(nil, Integer, Hash)> prometheus_admin_with_http_info
2252
+
2253
+ ```ruby
2254
+ begin
2255
+ # Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to your deployment like so:
2256
+ data, status_code, headers = api_instance.prometheus_admin_with_http_info
2257
+ p status_code # => 2xx
2258
+ p headers # => { ... }
2259
+ p data # => nil
2260
+ rescue OryHydraClient::ApiError => e
2261
+ puts "Error when calling DefaultApi->prometheus_admin_with_http_info: #{e}"
2262
+ end
2263
+ ```
2264
+
2265
+ ### Parameters
2266
+
2267
+ This endpoint does not need any parameter.
2268
+
2269
+ ### Return type
2270
+
2271
+ nil (empty response body)
2272
+
2273
+ ### Authorization
2274
+
2275
+ [oryToken](../README.md#oryToken)
2276
+
2277
+ ### HTTP request headers
2278
+
2279
+ - **Content-Type**: Not defined
2280
+ - **Accept**: Not defined
2281
+
2282
+
2283
+ ## revoke_session
2284
+
2285
+ > revoke_session(revoke_session)
2286
+
2287
+ Initialize Logout Flow for API Clients - Revoke a Session
2288
+
2289
+ Use this endpoint to revoke a session using its token. This endpoint is particularly useful for API clients such as mobile apps to log the user out of the system and invalidate the session. This endpoint does not remove any HTTP Cookies - use the Browser-Based Self-Service Logout Flow instead.
2290
+
2291
+ ### Examples
2292
+
2293
+ ```ruby
2294
+ require 'time'
2295
+ require 'ory-client-client'
2296
+
2297
+ api_instance = OryHydraClient::DefaultApi.new
2298
+ revoke_session = OryHydraClient::RevokeSession.new({session_token: 'session_token_example'}) # RevokeSession |
2299
+
2300
+ begin
2301
+ # Initialize Logout Flow for API Clients - Revoke a Session
2302
+ api_instance.revoke_session(revoke_session)
2303
+ rescue OryHydraClient::ApiError => e
2304
+ puts "Error when calling DefaultApi->revoke_session: #{e}"
2305
+ end
2306
+ ```
2307
+
2308
+ #### Using the revoke_session_with_http_info variant
2309
+
2310
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
2311
+
2312
+ > <Array(nil, Integer, Hash)> revoke_session_with_http_info(revoke_session)
2313
+
2314
+ ```ruby
2315
+ begin
2316
+ # Initialize Logout Flow for API Clients - Revoke a Session
2317
+ data, status_code, headers = api_instance.revoke_session_with_http_info(revoke_session)
2318
+ p status_code # => 2xx
2319
+ p headers # => { ... }
2320
+ p data # => nil
2321
+ rescue OryHydraClient::ApiError => e
2322
+ puts "Error when calling DefaultApi->revoke_session_with_http_info: #{e}"
2323
+ end
2324
+ ```
2325
+
2326
+ ### Parameters
2327
+
2328
+ | Name | Type | Description | Notes |
2329
+ | ---- | ---- | ----------- | ----- |
2330
+ | **revoke_session** | [**RevokeSession**](RevokeSession.md) | | |
2331
+
2332
+ ### Return type
2333
+
2334
+ nil (empty response body)
2335
+
2336
+ ### Authorization
2337
+
2338
+ No authorization required
2339
+
2340
+ ### HTTP request headers
2341
+
2342
+ - **Content-Type**: application/json
2343
+ - **Accept**: application/json
2344
+
2345
+
2346
+ ## submit_self_service_login_flow
2347
+
2348
+ > <LoginViaApiResponse> submit_self_service_login_flow(flow, opts)
2349
+
2350
+ Submit a Login Flow
2351
+
2352
+ 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 `application/x-www-form-urlencoded` to be sent in the body and responds 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. 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).
2353
+
2354
+ ### Examples
2355
+
2356
+ ```ruby
2357
+ require 'time'
2358
+ require 'ory-client-client'
2359
+
2360
+ api_instance = OryHydraClient::DefaultApi.new
2361
+ 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`).
2362
+ opts = {
2363
+ submit_self_service_login_flow: OryHydraClient::SubmitSelfServiceLoginFlowWithPasswordMethod.new # SubmitSelfServiceLoginFlow |
2364
+ }
2365
+
2366
+ begin
2367
+ # Submit a Login Flow
2368
+ result = api_instance.submit_self_service_login_flow(flow, opts)
2369
+ p result
2370
+ rescue OryHydraClient::ApiError => e
2371
+ puts "Error when calling DefaultApi->submit_self_service_login_flow: #{e}"
2372
+ end
2373
+ ```
2374
+
2375
+ #### Using the submit_self_service_login_flow_with_http_info variant
2376
+
2377
+ This returns an Array which contains the response data, status code and headers.
2378
+
2379
+ > <Array(<LoginViaApiResponse>, Integer, Hash)> submit_self_service_login_flow_with_http_info(flow, opts)
2380
+
2381
+ ```ruby
2382
+ begin
2383
+ # Submit a Login Flow
2384
+ data, status_code, headers = api_instance.submit_self_service_login_flow_with_http_info(flow, opts)
2385
+ p status_code # => 2xx
2386
+ p headers # => { ... }
2387
+ p data # => <LoginViaApiResponse>
2388
+ rescue OryHydraClient::ApiError => e
2389
+ puts "Error when calling DefaultApi->submit_self_service_login_flow_with_http_info: #{e}"
2390
+ end
2391
+ ```
2392
+
2393
+ ### Parameters
2394
+
2395
+ | Name | Type | Description | Notes |
2396
+ | ---- | ---- | ----------- | ----- |
2397
+ | **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;). | |
2398
+ | **submit_self_service_login_flow** | [**SubmitSelfServiceLoginFlow**](SubmitSelfServiceLoginFlow.md) | | [optional] |
2399
+
2400
+ ### Return type
2401
+
2402
+ [**LoginViaApiResponse**](LoginViaApiResponse.md)
2403
+
2404
+ ### Authorization
2405
+
2406
+ No authorization required
2407
+
2408
+ ### HTTP request headers
2409
+
2410
+ - **Content-Type**: application/json, application/x-www-form-urlencoded
2411
+ - **Accept**: application/json
2412
+
2413
+
2414
+ ## submit_self_service_recovery_flow
2415
+
2416
+ > submit_self_service_recovery_flow(flow, opts)
2417
+
2418
+ Complete Recovery Flow
2419
+
2420
+ 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 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 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).
2421
+
2422
+ ### Examples
2423
+
2424
+ ```ruby
2425
+ require 'time'
2426
+ require 'ory-client-client'
2427
+
2428
+ api_instance = OryHydraClient::DefaultApi.new
2429
+ 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`).
2430
+ opts = {
2431
+ body: Object # Object |
2432
+ }
2433
+
2434
+ begin
2435
+ # Complete Recovery Flow
2436
+ api_instance.submit_self_service_recovery_flow(flow, opts)
2437
+ rescue OryHydraClient::ApiError => e
2438
+ puts "Error when calling DefaultApi->submit_self_service_recovery_flow: #{e}"
2439
+ end
2440
+ ```
2441
+
2442
+ #### Using the submit_self_service_recovery_flow_with_http_info variant
2443
+
2444
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
2445
+
2446
+ > <Array(nil, Integer, Hash)> submit_self_service_recovery_flow_with_http_info(flow, opts)
2447
+
2448
+ ```ruby
2449
+ begin
2450
+ # Complete Recovery Flow
2451
+ data, status_code, headers = api_instance.submit_self_service_recovery_flow_with_http_info(flow, opts)
2452
+ p status_code # => 2xx
2453
+ p headers # => { ... }
2454
+ p data # => nil
2455
+ rescue OryHydraClient::ApiError => e
2456
+ puts "Error when calling DefaultApi->submit_self_service_recovery_flow_with_http_info: #{e}"
2457
+ end
2458
+ ```
2459
+
2460
+ ### Parameters
2461
+
2462
+ | Name | Type | Description | Notes |
2463
+ | ---- | ---- | ----------- | ----- |
2464
+ | **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;). | |
2465
+ | **body** | **Object** | | [optional] |
2466
+
2467
+ ### Return type
2468
+
2469
+ nil (empty response body)
2470
+
2471
+ ### Authorization
2472
+
2473
+ No authorization required
2474
+
2475
+ ### HTTP request headers
2476
+
2477
+ - **Content-Type**: application/json, application/x-www-form-urlencoded
2478
+ - **Accept**: application/json
2479
+
2480
+
2481
+ ## submit_self_service_recovery_flow_with_link_method
2482
+
2483
+ > submit_self_service_recovery_flow_with_link_method(opts)
2484
+
2485
+ Complete Recovery Flow with Link Method
2486
+
2487
+ Use this endpoint to complete a recovery flow using the link method. 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 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 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` 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).
2488
+
2489
+ ### Examples
2490
+
2491
+ ```ruby
2492
+ require 'time'
2493
+ require 'ory-client-client'
2494
+
2495
+ api_instance = OryHydraClient::DefaultApi.new
2496
+ opts = {
2497
+ 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.
2498
+ flow: 'flow_example', # String | The Flow ID format: uuid
2499
+ submit_self_service_recovery_flow_with_link_method: OryHydraClient::SubmitSelfServiceRecoveryFlowWithLinkMethod.new # SubmitSelfServiceRecoveryFlowWithLinkMethod |
2500
+ }
2501
+
2502
+ begin
2503
+ # Complete Recovery Flow with Link Method
2504
+ api_instance.submit_self_service_recovery_flow_with_link_method(opts)
2505
+ rescue OryHydraClient::ApiError => e
2506
+ puts "Error when calling DefaultApi->submit_self_service_recovery_flow_with_link_method: #{e}"
2507
+ end
2508
+ ```
2509
+
2510
+ #### Using the submit_self_service_recovery_flow_with_link_method_with_http_info variant
2511
+
2512
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
2513
+
2514
+ > <Array(nil, Integer, Hash)> submit_self_service_recovery_flow_with_link_method_with_http_info(opts)
2515
+
2516
+ ```ruby
2517
+ begin
2518
+ # Complete Recovery Flow with Link Method
2519
+ data, status_code, headers = api_instance.submit_self_service_recovery_flow_with_link_method_with_http_info(opts)
2520
+ p status_code # => 2xx
2521
+ p headers # => { ... }
2522
+ p data # => nil
2523
+ rescue OryHydraClient::ApiError => e
2524
+ puts "Error when calling DefaultApi->submit_self_service_recovery_flow_with_link_method_with_http_info: #{e}"
2525
+ end
2526
+ ```
2527
+
2528
+ ### Parameters
2529
+
2530
+ | Name | Type | Description | Notes |
2531
+ | ---- | ---- | ----------- | ----- |
2532
+ | **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. | [optional] |
2533
+ | **flow** | **String** | The Flow ID format: uuid | [optional] |
2534
+ | **submit_self_service_recovery_flow_with_link_method** | [**SubmitSelfServiceRecoveryFlowWithLinkMethod**](SubmitSelfServiceRecoveryFlowWithLinkMethod.md) | | [optional] |
2535
+
2536
+ ### Return type
2537
+
2538
+ nil (empty response body)
2539
+
2540
+ ### Authorization
2541
+
2542
+ No authorization required
2543
+
2544
+ ### HTTP request headers
2545
+
2546
+ - **Content-Type**: application/json, application/x-www-form-urlencoded
2547
+ - **Accept**: application/json
2548
+
2549
+
2550
+ ## submit_self_service_registration_flow
2551
+
2552
+ > <RegistrationViaApiResponse> submit_self_service_registration_flow(flow, opts)
2553
+
2554
+ Submit a Registration Flow
2555
+
2556
+ 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 `application/x-www-form-urlencoded` to be sent in the body and responds 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. 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).
2557
+
2558
+ ### Examples
2559
+
2560
+ ```ruby
2561
+ require 'time'
2562
+ require 'ory-client-client'
2563
+
2564
+ api_instance = OryHydraClient::DefaultApi.new
2565
+ 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`).
2566
+ opts = {
2567
+ submit_self_service_registration_flow: OryHydraClient::SubmitSelfServiceRegistrationFlowWithPasswordMethod.new({method: 'method_example'}) # SubmitSelfServiceRegistrationFlow |
2568
+ }
2569
+
2570
+ begin
2571
+ # Submit a Registration Flow
2572
+ result = api_instance.submit_self_service_registration_flow(flow, opts)
2573
+ p result
2574
+ rescue OryHydraClient::ApiError => e
2575
+ puts "Error when calling DefaultApi->submit_self_service_registration_flow: #{e}"
2576
+ end
2577
+ ```
2578
+
2579
+ #### Using the submit_self_service_registration_flow_with_http_info variant
2580
+
2581
+ This returns an Array which contains the response data, status code and headers.
2582
+
2583
+ > <Array(<RegistrationViaApiResponse>, Integer, Hash)> submit_self_service_registration_flow_with_http_info(flow, opts)
2584
+
2585
+ ```ruby
2586
+ begin
2587
+ # Submit a Registration Flow
2588
+ data, status_code, headers = api_instance.submit_self_service_registration_flow_with_http_info(flow, opts)
2589
+ p status_code # => 2xx
2590
+ p headers # => { ... }
2591
+ p data # => <RegistrationViaApiResponse>
2592
+ rescue OryHydraClient::ApiError => e
2593
+ puts "Error when calling DefaultApi->submit_self_service_registration_flow_with_http_info: #{e}"
2594
+ end
2595
+ ```
2596
+
2597
+ ### Parameters
2598
+
2599
+ | Name | Type | Description | Notes |
2600
+ | ---- | ---- | ----------- | ----- |
2601
+ | **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;). | |
2602
+ | **submit_self_service_registration_flow** | [**SubmitSelfServiceRegistrationFlow**](SubmitSelfServiceRegistrationFlow.md) | | [optional] |
2603
+
2604
+ ### Return type
2605
+
2606
+ [**RegistrationViaApiResponse**](RegistrationViaApiResponse.md)
2607
+
2608
+ ### Authorization
2609
+
2610
+ No authorization required
2611
+
2612
+ ### HTTP request headers
2613
+
2614
+ - **Content-Type**: application/json, application/x-www-form-urlencoded
2615
+ - **Accept**: application/json
2616
+
2617
+
2618
+ ## submit_self_service_settings_flow
2619
+
2620
+ > <SettingsViaApiResponse> submit_self_service_settings_flow(flow, opts)
2621
+
2622
+ Complete Settings Flow
2623
+
2624
+ Use this endpoint to complete a settings flow by sending an identity's updated password. This endpoint behaves differently for API and browser flows. API-initiated flows expect `application/json` to be sent in the body and respond with HTTP 200 and an application/json body with the session token on success; HTTP 302 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. HTTP 401 when the endpoint is called without a valid session token. HTTP 403 when `selfservice.flows.settings.privileged_session_max_age` was reached. Implies that the user needs to re-authenticate. Browser flows expect `application/x-www-form-urlencoded` to be sent in the body and responds with a HTTP 302 redirect to the post/after settings URL or the `return_to` value if it was set and if the flow succeeded; a HTTP 302 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise. a HTTP 302 redirect to the login endpoint when `selfservice.flows.settings.privileged_session_max_age` was reached. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
2625
+
2626
+ ### Examples
2627
+
2628
+ ```ruby
2629
+ require 'time'
2630
+ require 'ory-client-client'
2631
+ # setup authorization
2632
+ OryHydraClient.configure do |config|
2633
+ # Configure Bearer authorization: sessionToken
2634
+ config.access_token = 'YOUR_BEARER_TOKEN'
2635
+ end
2636
+
2637
+ api_instance = OryHydraClient::DefaultApi.new
2638
+ 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`).
2639
+ opts = {
2640
+ submit_self_service_settings_flow: OryHydraClient::SubmitSelfServiceSettingsFlowWithPasswordMethod.new({password: 'password_example'}) # SubmitSelfServiceSettingsFlow |
2641
+ }
2642
+
2643
+ begin
2644
+ # Complete Settings Flow
2645
+ result = api_instance.submit_self_service_settings_flow(flow, opts)
2646
+ p result
2647
+ rescue OryHydraClient::ApiError => e
2648
+ puts "Error when calling DefaultApi->submit_self_service_settings_flow: #{e}"
2649
+ end
2650
+ ```
2651
+
2652
+ #### Using the submit_self_service_settings_flow_with_http_info variant
2653
+
2654
+ This returns an Array which contains the response data, status code and headers.
2655
+
2656
+ > <Array(<SettingsViaApiResponse>, Integer, Hash)> submit_self_service_settings_flow_with_http_info(flow, opts)
2657
+
2658
+ ```ruby
2659
+ begin
2660
+ # Complete Settings Flow
2661
+ data, status_code, headers = api_instance.submit_self_service_settings_flow_with_http_info(flow, opts)
2662
+ p status_code # => 2xx
2663
+ p headers # => { ... }
2664
+ p data # => <SettingsViaApiResponse>
2665
+ rescue OryHydraClient::ApiError => e
2666
+ puts "Error when calling DefaultApi->submit_self_service_settings_flow_with_http_info: #{e}"
2667
+ end
2668
+ ```
2669
+
2670
+ ### Parameters
2671
+
2672
+ | Name | Type | Description | Notes |
2673
+ | ---- | ---- | ----------- | ----- |
2674
+ | **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;). | |
2675
+ | **submit_self_service_settings_flow** | [**SubmitSelfServiceSettingsFlow**](SubmitSelfServiceSettingsFlow.md) | | [optional] |
2676
+
2677
+ ### Return type
2678
+
2679
+ [**SettingsViaApiResponse**](SettingsViaApiResponse.md)
2680
+
2681
+ ### Authorization
2682
+
2683
+ [sessionToken](../README.md#sessionToken)
2684
+
2685
+ ### HTTP request headers
2686
+
2687
+ - **Content-Type**: application/json, application/x-www-form-urlencoded
2688
+ - **Accept**: application/json
2689
+
2690
+
2691
+ ## submit_self_service_verification_flow
2692
+
2693
+ > submit_self_service_verification_flow(flow, opts)
2694
+
2695
+ Complete Verification Flow
2696
+
2697
+ 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 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 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).
2698
+
2699
+ ### Examples
2700
+
2701
+ ```ruby
2702
+ require 'time'
2703
+ require 'ory-client-client'
2704
+
2705
+ api_instance = OryHydraClient::DefaultApi.new
2706
+ 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`).
2707
+ opts = {
2708
+ body: Object # Object |
2709
+ }
2710
+
2711
+ begin
2712
+ # Complete Verification Flow
2713
+ api_instance.submit_self_service_verification_flow(flow, opts)
2714
+ rescue OryHydraClient::ApiError => e
2715
+ puts "Error when calling DefaultApi->submit_self_service_verification_flow: #{e}"
2716
+ end
2717
+ ```
2718
+
2719
+ #### Using the submit_self_service_verification_flow_with_http_info variant
2720
+
2721
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
2722
+
2723
+ > <Array(nil, Integer, Hash)> submit_self_service_verification_flow_with_http_info(flow, opts)
2724
+
2725
+ ```ruby
2726
+ begin
2727
+ # Complete Verification Flow
2728
+ data, status_code, headers = api_instance.submit_self_service_verification_flow_with_http_info(flow, opts)
2729
+ p status_code # => 2xx
2730
+ p headers # => { ... }
2731
+ p data # => nil
2732
+ rescue OryHydraClient::ApiError => e
2733
+ puts "Error when calling DefaultApi->submit_self_service_verification_flow_with_http_info: #{e}"
2734
+ end
2735
+ ```
2736
+
2737
+ ### Parameters
2738
+
2739
+ | Name | Type | Description | Notes |
2740
+ | ---- | ---- | ----------- | ----- |
2741
+ | **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;). | |
2742
+ | **body** | **Object** | | [optional] |
2743
+
2744
+ ### Return type
2745
+
2746
+ nil (empty response body)
2747
+
2748
+ ### Authorization
2749
+
2750
+ No authorization required
2751
+
2752
+ ### HTTP request headers
2753
+
2754
+ - **Content-Type**: application/json, application/x-www-form-urlencoded
2755
+ - **Accept**: application/json
2756
+
2757
+
2758
+ ## to_session
2759
+
2760
+ > <Session> to_session(opts)
2761
+
2762
+ Check Who the Current HTTP Session Belongs To
2763
+
2764
+ Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object in the body or 401 if the credentials are invalid or no credentials were sent. Additionally when the request it successful it adds the user ID to the 'X-Kratos-Authenticated-Identity-Id' header in the response. This endpoint is useful for: AJAX calls. Remember to send credentials and set up CORS correctly! Reverse proxies and API Gateways Server-side calls - use the `X-Session-Token` header!
2765
+
2766
+ ### Examples
2767
+
2768
+ ```ruby
2769
+ require 'time'
2770
+ require 'ory-client-client'
2771
+ # setup authorization
2772
+ OryHydraClient.configure do |config|
2773
+ # Configure API key authorization: sessionCookie
2774
+ config.api_key['sessionCookie'] = 'YOUR API KEY'
2775
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2776
+ # config.api_key_prefix['sessionCookie'] = 'Bearer'
2777
+ end
2778
+
2779
+ api_instance = OryHydraClient::DefaultApi.new
2780
+ opts = {
2781
+ x_session_token: 'x_session_token_example' # String |
2782
+ }
2783
+
2784
+ begin
2785
+ # Check Who the Current HTTP Session Belongs To
2786
+ result = api_instance.to_session(opts)
2787
+ p result
2788
+ rescue OryHydraClient::ApiError => e
2789
+ puts "Error when calling DefaultApi->to_session: #{e}"
2790
+ end
2791
+ ```
2792
+
2793
+ #### Using the to_session_with_http_info variant
2794
+
2795
+ This returns an Array which contains the response data, status code and headers.
2796
+
2797
+ > <Array(<Session>, Integer, Hash)> to_session_with_http_info(opts)
2798
+
2799
+ ```ruby
2800
+ begin
2801
+ # Check Who the Current HTTP Session Belongs To
2802
+ data, status_code, headers = api_instance.to_session_with_http_info(opts)
2803
+ p status_code # => 2xx
2804
+ p headers # => { ... }
2805
+ p data # => <Session>
2806
+ rescue OryHydraClient::ApiError => e
2807
+ puts "Error when calling DefaultApi->to_session_with_http_info: #{e}"
2808
+ end
2809
+ ```
2810
+
2811
+ ### Parameters
2812
+
2813
+ | Name | Type | Description | Notes |
2814
+ | ---- | ---- | ----------- | ----- |
2815
+ | **x_session_token** | **String** | | [optional] |
2816
+
2817
+ ### Return type
2818
+
2819
+ [**Session**](Session.md)
2820
+
2821
+ ### Authorization
2822
+
2823
+ [sessionCookie](../README.md#sessionCookie)
2824
+
2825
+ ### HTTP request headers
2826
+
2827
+ - **Content-Type**: Not defined
2828
+ - **Accept**: application/json
2829
+
2830
+
2831
+ ## update_identity_admin
2832
+
2833
+ > <Identity> update_identity_admin(id, opts)
2834
+
2835
+ Update an Identity
2836
+
2837
+ 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).
2838
+
2839
+ ### Examples
2840
+
2841
+ ```ruby
2842
+ require 'time'
2843
+ require 'ory-client-client'
2844
+ # setup authorization
2845
+ OryHydraClient.configure do |config|
2846
+ # Configure Bearer authorization: oryToken
2847
+ config.access_token = 'YOUR_BEARER_TOKEN'
2848
+ end
2849
+
2850
+ api_instance = OryHydraClient::DefaultApi.new
2851
+ id = 'id_example' # String | ID must be set to the ID of identity you want to update
2852
+ opts = {
2853
+ update_identity: OryHydraClient::UpdateIdentity.new({traits: 3.56}) # UpdateIdentity |
2854
+ }
2855
+
2856
+ begin
2857
+ # Update an Identity
2858
+ result = api_instance.update_identity_admin(id, opts)
2859
+ p result
2860
+ rescue OryHydraClient::ApiError => e
2861
+ puts "Error when calling DefaultApi->update_identity_admin: #{e}"
2862
+ end
2863
+ ```
2864
+
2865
+ #### Using the update_identity_admin_with_http_info variant
2866
+
2867
+ This returns an Array which contains the response data, status code and headers.
2868
+
2869
+ > <Array(<Identity>, Integer, Hash)> update_identity_admin_with_http_info(id, opts)
2870
+
2871
+ ```ruby
2872
+ begin
2873
+ # Update an Identity
2874
+ data, status_code, headers = api_instance.update_identity_admin_with_http_info(id, opts)
2875
+ p status_code # => 2xx
2876
+ p headers # => { ... }
2877
+ p data # => <Identity>
2878
+ rescue OryHydraClient::ApiError => e
2879
+ puts "Error when calling DefaultApi->update_identity_admin_with_http_info: #{e}"
2880
+ end
2881
+ ```
2882
+
2883
+ ### Parameters
2884
+
2885
+ | Name | Type | Description | Notes |
2886
+ | ---- | ---- | ----------- | ----- |
2887
+ | **id** | **String** | ID must be set to the ID of identity you want to update | |
2888
+ | **update_identity** | [**UpdateIdentity**](UpdateIdentity.md) | | [optional] |
2889
+
2890
+ ### Return type
2891
+
2892
+ [**Identity**](Identity.md)
2893
+
2894
+ ### Authorization
2895
+
2896
+ [oryToken](../README.md#oryToken)
2897
+
2898
+ ### HTTP request headers
2899
+
2900
+ - **Content-Type**: application/json
2901
+ - **Accept**: application/json
2902
+