ory-client 0.0.1.alpha177 → 0.0.1.alpha180

Sign up to get free protection for your applications and to get access to all the features.
Files changed (295) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +5 -5
  4. data/docs/CreateCustomHostnameBody.md +2 -2
  5. data/docs/UpdateCustomHostnameBody.md +2 -2
  6. data/docs/V0alpha2Api.md +48 -40
  7. data/lib/ory-client/api/metadata_api.rb +1 -1
  8. data/lib/ory-client/api/read_api.rb +1 -1
  9. data/lib/ory-client/api/v0alpha2_api.rb +78 -46
  10. data/lib/ory-client/api/write_api.rb +1 -1
  11. data/lib/ory-client/api_client.rb +1 -1
  12. data/lib/ory-client/api_error.rb +1 -1
  13. data/lib/ory-client/configuration.rb +1 -1
  14. data/lib/ory-client/models/active_project.rb +1 -1
  15. data/lib/ory-client/models/admin_create_identity_body.rb +1 -1
  16. data/lib/ory-client/models/admin_create_identity_import_credentials_oidc.rb +1 -1
  17. data/lib/ory-client/models/admin_create_identity_import_credentials_oidc_config.rb +1 -1
  18. data/lib/ory-client/models/admin_create_identity_import_credentials_oidc_provider.rb +1 -1
  19. data/lib/ory-client/models/admin_create_identity_import_credentials_password.rb +1 -1
  20. data/lib/ory-client/models/admin_create_identity_import_credentials_password_config.rb +1 -1
  21. data/lib/ory-client/models/admin_create_self_service_recovery_link_body.rb +1 -1
  22. data/lib/ory-client/models/admin_identity_import_credentials.rb +1 -1
  23. data/lib/ory-client/models/admin_update_identity_body.rb +1 -1
  24. data/lib/ory-client/models/api_token.rb +1 -1
  25. data/lib/ory-client/models/authenticator_assurance_level.rb +1 -1
  26. data/lib/ory-client/models/cloud_account.rb +1 -1
  27. data/lib/ory-client/models/cname_settings.rb +1 -1
  28. data/lib/ory-client/models/create_custom_hostname_body.rb +3 -3
  29. data/lib/ory-client/models/create_project_body.rb +1 -1
  30. data/lib/ory-client/models/create_subscription_payload.rb +1 -1
  31. data/lib/ory-client/models/error_authenticator_assurance_level_not_satisfied.rb +1 -1
  32. data/lib/ory-client/models/expand_tree.rb +1 -1
  33. data/lib/ory-client/models/generic_error.rb +1 -1
  34. data/lib/ory-client/models/generic_error_content.rb +1 -1
  35. data/lib/ory-client/models/get_check_response.rb +1 -1
  36. data/lib/ory-client/models/get_relation_tuples_response.rb +1 -1
  37. data/lib/ory-client/models/health_not_ready_status.rb +1 -1
  38. data/lib/ory-client/models/health_status.rb +1 -1
  39. data/lib/ory-client/models/identity.rb +1 -1
  40. data/lib/ory-client/models/identity_credentials.rb +1 -1
  41. data/lib/ory-client/models/identity_credentials_oidc.rb +1 -1
  42. data/lib/ory-client/models/identity_credentials_oidc_provider.rb +1 -1
  43. data/lib/ory-client/models/identity_credentials_password.rb +1 -1
  44. data/lib/ory-client/models/identity_credentials_type.rb +1 -1
  45. data/lib/ory-client/models/identity_schema.rb +1 -1
  46. data/lib/ory-client/models/identity_schema_location.rb +1 -1
  47. data/lib/ory-client/models/identity_schema_preset.rb +1 -1
  48. data/lib/ory-client/models/identity_schema_validation_result.rb +1 -1
  49. data/lib/ory-client/models/identity_state.rb +1 -1
  50. data/lib/ory-client/models/inline_response200.rb +1 -1
  51. data/lib/ory-client/models/inline_response2001.rb +1 -1
  52. data/lib/ory-client/models/inline_response503.rb +1 -1
  53. data/lib/ory-client/models/internal_relation_tuple.rb +1 -1
  54. data/lib/ory-client/models/invite_payload.rb +1 -1
  55. data/lib/ory-client/models/is_owner_for_project_by_slug.rb +1 -1
  56. data/lib/ory-client/models/is_owner_for_project_by_slug_payload.rb +1 -1
  57. data/lib/ory-client/models/json_error.rb +1 -1
  58. data/lib/ory-client/models/json_patch.rb +1 -1
  59. data/lib/ory-client/models/keto_namespace.rb +1 -1
  60. data/lib/ory-client/models/needs_privileged_session_error.rb +1 -1
  61. data/lib/ory-client/models/normalized_project.rb +1 -1
  62. data/lib/ory-client/models/normalized_project_revision.rb +1 -1
  63. data/lib/ory-client/models/normalized_project_revision_hook.rb +1 -1
  64. data/lib/ory-client/models/normalized_project_revision_identity_schema.rb +1 -1
  65. data/lib/ory-client/models/normalized_project_revision_third_party_provider.rb +1 -1
  66. data/lib/ory-client/models/null_plan.rb +1 -1
  67. data/lib/ory-client/models/pagination.rb +1 -1
  68. data/lib/ory-client/models/patch_delta.rb +1 -1
  69. data/lib/ory-client/models/project.rb +1 -1
  70. data/lib/ory-client/models/project_host.rb +1 -1
  71. data/lib/ory-client/models/project_invite.rb +1 -1
  72. data/lib/ory-client/models/project_metadata.rb +1 -1
  73. data/lib/ory-client/models/project_service_identity.rb +1 -1
  74. data/lib/ory-client/models/project_service_permission.rb +1 -1
  75. data/lib/ory-client/models/project_services.rb +1 -1
  76. data/lib/ory-client/models/provision_mock_subscription_payload.rb +1 -1
  77. data/lib/ory-client/models/quota_project_member_seats.rb +1 -1
  78. data/lib/ory-client/models/recovery_address.rb +1 -1
  79. data/lib/ory-client/models/relation_query.rb +1 -1
  80. data/lib/ory-client/models/revoked_sessions.rb +1 -1
  81. data/lib/ory-client/models/schema_patch.rb +1 -1
  82. data/lib/ory-client/models/self_service_browser_location_change_required_error.rb +1 -1
  83. data/lib/ory-client/models/self_service_error.rb +1 -1
  84. data/lib/ory-client/models/self_service_flow_expired_error.rb +1 -1
  85. data/lib/ory-client/models/self_service_login_flow.rb +1 -1
  86. data/lib/ory-client/models/self_service_logout_url.rb +1 -1
  87. data/lib/ory-client/models/self_service_recovery_flow.rb +1 -1
  88. data/lib/ory-client/models/self_service_recovery_flow_state.rb +1 -1
  89. data/lib/ory-client/models/self_service_recovery_link.rb +1 -1
  90. data/lib/ory-client/models/self_service_registration_flow.rb +1 -1
  91. data/lib/ory-client/models/self_service_settings_flow.rb +1 -1
  92. data/lib/ory-client/models/self_service_settings_flow_state.rb +1 -1
  93. data/lib/ory-client/models/self_service_verification_flow.rb +1 -1
  94. data/lib/ory-client/models/self_service_verification_flow_state.rb +1 -1
  95. data/lib/ory-client/models/session.rb +1 -1
  96. data/lib/ory-client/models/session_authentication_method.rb +1 -1
  97. data/lib/ory-client/models/session_device.rb +1 -1
  98. data/lib/ory-client/models/settings_profile_form_config.rb +1 -1
  99. data/lib/ory-client/models/stripe_customer_response.rb +1 -1
  100. data/lib/ory-client/models/subject_set.rb +1 -1
  101. data/lib/ory-client/models/submit_self_service_flow_with_web_authn_registration_method.rb +1 -1
  102. data/lib/ory-client/models/submit_self_service_login_flow_body.rb +1 -1
  103. data/lib/ory-client/models/submit_self_service_login_flow_with_lookup_secret_method_body.rb +1 -1
  104. data/lib/ory-client/models/submit_self_service_login_flow_with_oidc_method_body.rb +1 -1
  105. data/lib/ory-client/models/submit_self_service_login_flow_with_password_method_body.rb +1 -1
  106. data/lib/ory-client/models/submit_self_service_login_flow_with_totp_method_body.rb +1 -1
  107. data/lib/ory-client/models/submit_self_service_login_flow_with_web_authn_method_body.rb +1 -1
  108. data/lib/ory-client/models/submit_self_service_logout_flow_without_browser_body.rb +1 -1
  109. data/lib/ory-client/models/submit_self_service_recovery_flow_body.rb +1 -1
  110. data/lib/ory-client/models/submit_self_service_recovery_flow_with_link_method_body.rb +1 -1
  111. data/lib/ory-client/models/submit_self_service_registration_flow_body.rb +1 -1
  112. data/lib/ory-client/models/submit_self_service_registration_flow_with_oidc_method_body.rb +1 -1
  113. data/lib/ory-client/models/submit_self_service_registration_flow_with_password_method_body.rb +1 -1
  114. data/lib/ory-client/models/submit_self_service_registration_flow_with_web_authn_method_body.rb +1 -1
  115. data/lib/ory-client/models/submit_self_service_settings_flow_body.rb +1 -1
  116. data/lib/ory-client/models/submit_self_service_settings_flow_with_lookup_method_body.rb +1 -1
  117. data/lib/ory-client/models/submit_self_service_settings_flow_with_oidc_method_body.rb +1 -1
  118. data/lib/ory-client/models/submit_self_service_settings_flow_with_password_method_body.rb +1 -1
  119. data/lib/ory-client/models/submit_self_service_settings_flow_with_profile_method_body.rb +1 -1
  120. data/lib/ory-client/models/submit_self_service_settings_flow_with_totp_method_body.rb +1 -1
  121. data/lib/ory-client/models/submit_self_service_settings_flow_with_web_authn_method_body.rb +1 -1
  122. data/lib/ory-client/models/submit_self_service_verification_flow_body.rb +1 -1
  123. data/lib/ory-client/models/submit_self_service_verification_flow_with_link_method_body.rb +1 -1
  124. data/lib/ory-client/models/subscription.rb +1 -1
  125. data/lib/ory-client/models/successful_project_update.rb +1 -1
  126. data/lib/ory-client/models/successful_self_service_login_without_browser.rb +1 -1
  127. data/lib/ory-client/models/successful_self_service_registration_without_browser.rb +1 -1
  128. data/lib/ory-client/models/ui_container.rb +1 -1
  129. data/lib/ory-client/models/ui_node.rb +1 -1
  130. data/lib/ory-client/models/ui_node_anchor_attributes.rb +1 -1
  131. data/lib/ory-client/models/ui_node_attributes.rb +1 -1
  132. data/lib/ory-client/models/ui_node_image_attributes.rb +1 -1
  133. data/lib/ory-client/models/ui_node_input_attributes.rb +1 -1
  134. data/lib/ory-client/models/ui_node_meta.rb +1 -1
  135. data/lib/ory-client/models/ui_node_script_attributes.rb +1 -1
  136. data/lib/ory-client/models/ui_node_text_attributes.rb +1 -1
  137. data/lib/ory-client/models/ui_text.rb +1 -1
  138. data/lib/ory-client/models/update_custom_hostname_body.rb +3 -3
  139. data/lib/ory-client/models/update_project.rb +1 -1
  140. data/lib/ory-client/models/update_subscription_payload.rb +1 -1
  141. data/lib/ory-client/models/verifiable_identity_address.rb +1 -1
  142. data/lib/ory-client/models/version.rb +1 -1
  143. data/lib/ory-client/models/warning.rb +1 -1
  144. data/lib/ory-client/version.rb +2 -2
  145. data/lib/ory-client.rb +1 -1
  146. data/ory-client.gemspec +1 -1
  147. data/spec/api/metadata_api_spec.rb +1 -1
  148. data/spec/api/read_api_spec.rb +1 -1
  149. data/spec/api/v0alpha2_api_spec.rb +15 -11
  150. data/spec/api/write_api_spec.rb +1 -1
  151. data/spec/api_client_spec.rb +1 -1
  152. data/spec/configuration_spec.rb +1 -1
  153. data/spec/models/active_project_spec.rb +1 -1
  154. data/spec/models/admin_create_identity_body_spec.rb +1 -1
  155. data/spec/models/admin_create_identity_import_credentials_oidc_config_spec.rb +1 -1
  156. data/spec/models/admin_create_identity_import_credentials_oidc_provider_spec.rb +1 -1
  157. data/spec/models/admin_create_identity_import_credentials_oidc_spec.rb +1 -1
  158. data/spec/models/admin_create_identity_import_credentials_password_config_spec.rb +1 -1
  159. data/spec/models/admin_create_identity_import_credentials_password_spec.rb +1 -1
  160. data/spec/models/admin_create_self_service_recovery_link_body_spec.rb +1 -1
  161. data/spec/models/admin_identity_import_credentials_spec.rb +1 -1
  162. data/spec/models/admin_update_identity_body_spec.rb +1 -1
  163. data/spec/models/api_token_spec.rb +1 -1
  164. data/spec/models/authenticator_assurance_level_spec.rb +1 -1
  165. data/spec/models/cloud_account_spec.rb +1 -1
  166. data/spec/models/cname_settings_spec.rb +1 -1
  167. data/spec/models/create_custom_hostname_body_spec.rb +1 -1
  168. data/spec/models/create_project_body_spec.rb +1 -1
  169. data/spec/models/create_subscription_payload_spec.rb +1 -1
  170. data/spec/models/error_authenticator_assurance_level_not_satisfied_spec.rb +1 -1
  171. data/spec/models/expand_tree_spec.rb +1 -1
  172. data/spec/models/generic_error_content_spec.rb +1 -1
  173. data/spec/models/generic_error_spec.rb +1 -1
  174. data/spec/models/get_check_response_spec.rb +1 -1
  175. data/spec/models/get_relation_tuples_response_spec.rb +1 -1
  176. data/spec/models/health_not_ready_status_spec.rb +1 -1
  177. data/spec/models/health_status_spec.rb +1 -1
  178. data/spec/models/identity_credentials_oidc_provider_spec.rb +1 -1
  179. data/spec/models/identity_credentials_oidc_spec.rb +1 -1
  180. data/spec/models/identity_credentials_password_spec.rb +1 -1
  181. data/spec/models/identity_credentials_spec.rb +1 -1
  182. data/spec/models/identity_credentials_type_spec.rb +1 -1
  183. data/spec/models/identity_schema_location_spec.rb +1 -1
  184. data/spec/models/identity_schema_preset_spec.rb +1 -1
  185. data/spec/models/identity_schema_spec.rb +1 -1
  186. data/spec/models/identity_schema_validation_result_spec.rb +1 -1
  187. data/spec/models/identity_spec.rb +1 -1
  188. data/spec/models/identity_state_spec.rb +1 -1
  189. data/spec/models/inline_response2001_spec.rb +1 -1
  190. data/spec/models/inline_response200_spec.rb +1 -1
  191. data/spec/models/inline_response503_spec.rb +1 -1
  192. data/spec/models/internal_relation_tuple_spec.rb +1 -1
  193. data/spec/models/invite_payload_spec.rb +1 -1
  194. data/spec/models/is_owner_for_project_by_slug_payload_spec.rb +1 -1
  195. data/spec/models/is_owner_for_project_by_slug_spec.rb +1 -1
  196. data/spec/models/json_error_spec.rb +1 -1
  197. data/spec/models/json_patch_spec.rb +1 -1
  198. data/spec/models/keto_namespace_spec.rb +1 -1
  199. data/spec/models/needs_privileged_session_error_spec.rb +1 -1
  200. data/spec/models/normalized_project_revision_hook_spec.rb +1 -1
  201. data/spec/models/normalized_project_revision_identity_schema_spec.rb +1 -1
  202. data/spec/models/normalized_project_revision_spec.rb +1 -1
  203. data/spec/models/normalized_project_revision_third_party_provider_spec.rb +1 -1
  204. data/spec/models/normalized_project_spec.rb +1 -1
  205. data/spec/models/null_plan_spec.rb +1 -1
  206. data/spec/models/pagination_spec.rb +1 -1
  207. data/spec/models/patch_delta_spec.rb +1 -1
  208. data/spec/models/project_host_spec.rb +1 -1
  209. data/spec/models/project_invite_spec.rb +1 -1
  210. data/spec/models/project_metadata_spec.rb +1 -1
  211. data/spec/models/project_service_identity_spec.rb +1 -1
  212. data/spec/models/project_service_permission_spec.rb +1 -1
  213. data/spec/models/project_services_spec.rb +1 -1
  214. data/spec/models/project_spec.rb +1 -1
  215. data/spec/models/provision_mock_subscription_payload_spec.rb +1 -1
  216. data/spec/models/quota_project_member_seats_spec.rb +1 -1
  217. data/spec/models/recovery_address_spec.rb +1 -1
  218. data/spec/models/relation_query_spec.rb +1 -1
  219. data/spec/models/revoked_sessions_spec.rb +1 -1
  220. data/spec/models/schema_patch_spec.rb +1 -1
  221. data/spec/models/self_service_browser_location_change_required_error_spec.rb +1 -1
  222. data/spec/models/self_service_error_spec.rb +1 -1
  223. data/spec/models/self_service_flow_expired_error_spec.rb +1 -1
  224. data/spec/models/self_service_login_flow_spec.rb +1 -1
  225. data/spec/models/self_service_logout_url_spec.rb +1 -1
  226. data/spec/models/self_service_recovery_flow_spec.rb +1 -1
  227. data/spec/models/self_service_recovery_flow_state_spec.rb +1 -1
  228. data/spec/models/self_service_recovery_link_spec.rb +1 -1
  229. data/spec/models/self_service_registration_flow_spec.rb +1 -1
  230. data/spec/models/self_service_settings_flow_spec.rb +1 -1
  231. data/spec/models/self_service_settings_flow_state_spec.rb +1 -1
  232. data/spec/models/self_service_verification_flow_spec.rb +1 -1
  233. data/spec/models/self_service_verification_flow_state_spec.rb +1 -1
  234. data/spec/models/session_authentication_method_spec.rb +1 -1
  235. data/spec/models/session_device_spec.rb +1 -1
  236. data/spec/models/session_spec.rb +1 -1
  237. data/spec/models/settings_profile_form_config_spec.rb +1 -1
  238. data/spec/models/stripe_customer_response_spec.rb +1 -1
  239. data/spec/models/subject_set_spec.rb +1 -1
  240. data/spec/models/submit_self_service_flow_with_web_authn_registration_method_spec.rb +1 -1
  241. data/spec/models/submit_self_service_login_flow_body_spec.rb +1 -1
  242. data/spec/models/submit_self_service_login_flow_with_lookup_secret_method_body_spec.rb +1 -1
  243. data/spec/models/submit_self_service_login_flow_with_oidc_method_body_spec.rb +1 -1
  244. data/spec/models/submit_self_service_login_flow_with_password_method_body_spec.rb +1 -1
  245. data/spec/models/submit_self_service_login_flow_with_totp_method_body_spec.rb +1 -1
  246. data/spec/models/submit_self_service_login_flow_with_web_authn_method_body_spec.rb +1 -1
  247. data/spec/models/submit_self_service_logout_flow_without_browser_body_spec.rb +1 -1
  248. data/spec/models/submit_self_service_recovery_flow_body_spec.rb +1 -1
  249. data/spec/models/submit_self_service_recovery_flow_with_link_method_body_spec.rb +1 -1
  250. data/spec/models/submit_self_service_registration_flow_body_spec.rb +1 -1
  251. data/spec/models/submit_self_service_registration_flow_with_oidc_method_body_spec.rb +1 -1
  252. data/spec/models/submit_self_service_registration_flow_with_password_method_body_spec.rb +1 -1
  253. data/spec/models/submit_self_service_registration_flow_with_web_authn_method_body_spec.rb +1 -1
  254. data/spec/models/submit_self_service_settings_flow_body_spec.rb +1 -1
  255. data/spec/models/submit_self_service_settings_flow_with_lookup_method_body_spec.rb +1 -1
  256. data/spec/models/submit_self_service_settings_flow_with_oidc_method_body_spec.rb +1 -1
  257. data/spec/models/submit_self_service_settings_flow_with_password_method_body_spec.rb +1 -1
  258. data/spec/models/submit_self_service_settings_flow_with_profile_method_body_spec.rb +1 -1
  259. data/spec/models/submit_self_service_settings_flow_with_totp_method_body_spec.rb +1 -1
  260. data/spec/models/submit_self_service_settings_flow_with_web_authn_method_body_spec.rb +1 -1
  261. data/spec/models/submit_self_service_verification_flow_body_spec.rb +1 -1
  262. data/spec/models/submit_self_service_verification_flow_with_link_method_body_spec.rb +1 -1
  263. data/spec/models/subscription_spec.rb +1 -1
  264. data/spec/models/successful_project_update_spec.rb +1 -1
  265. data/spec/models/successful_self_service_login_without_browser_spec.rb +1 -1
  266. data/spec/models/successful_self_service_registration_without_browser_spec.rb +1 -1
  267. data/spec/models/ui_container_spec.rb +1 -1
  268. data/spec/models/ui_node_anchor_attributes_spec.rb +1 -1
  269. data/spec/models/ui_node_attributes_spec.rb +1 -1
  270. data/spec/models/ui_node_image_attributes_spec.rb +1 -1
  271. data/spec/models/ui_node_input_attributes_spec.rb +1 -1
  272. data/spec/models/ui_node_meta_spec.rb +1 -1
  273. data/spec/models/ui_node_script_attributes_spec.rb +1 -1
  274. data/spec/models/ui_node_spec.rb +1 -1
  275. data/spec/models/ui_node_text_attributes_spec.rb +1 -1
  276. data/spec/models/ui_text_spec.rb +1 -1
  277. data/spec/models/update_custom_hostname_body_spec.rb +1 -1
  278. data/spec/models/update_project_spec.rb +1 -1
  279. data/spec/models/update_subscription_payload_spec.rb +1 -1
  280. data/spec/models/verifiable_identity_address_spec.rb +1 -1
  281. data/spec/models/version_spec.rb +1 -1
  282. data/spec/models/warning_spec.rb +1 -1
  283. data/spec/spec_helper.rb +1 -1
  284. data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/byebug-11.1.3/gem_make.out +2 -2
  285. data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/ffi-1.15.5/gem_make.out +2 -2
  286. data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/jaro_winkler-1.5.4/gem_make.out +2 -2
  287. data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/psych-4.0.4/gem_make.out +2 -2
  288. data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/stringio-3.0.2/gem_make.out +2 -2
  289. data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/stringio-3.0.2/mkmf.log +1 -1
  290. data/vendor/bundle/ruby/2.5.0/gems/byebug-11.1.3/ext/byebug/Makefile +2 -2
  291. data/vendor/bundle/ruby/2.5.0/gems/ffi-1.15.5/ext/ffi_c/Makefile +2 -2
  292. data/vendor/bundle/ruby/2.5.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler/Makefile +2 -2
  293. data/vendor/bundle/ruby/2.5.0/gems/psych-4.0.4/ext/psych/Makefile +2 -2
  294. data/vendor/bundle/ruby/2.5.0/gems/stringio-3.0.2/ext/stringio/Makefile +2 -2
  295. metadata +2 -2
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
5
5
 
6
- The version of the OpenAPI document: v0.0.1-alpha.177
6
+ The version of the OpenAPI document: v0.0.1-alpha.180
7
7
  Contact: support@ory.sh
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0
@@ -1010,7 +1010,7 @@ module OryClient
1010
1010
  # This endpoint returns a login flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/login', async function (req, res) { const flow = await client.getSelfServiceLoginFlow(req.header('cookie'), req.query['flow']) res.render('login', flow) }) ``` This request may fail due to several reasons. The `error.id` can be one of: `session_already_available`: The user is already signed in. `self_service_flow_expired`: The flow is expired and you should request a new one. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
1011
1011
  # @param id [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`).
1012
1012
  # @param [Hash] opts the optional parameters
1013
- # @option opts [String] :cookie HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.
1013
+ # @option opts [String] :cookie HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected.
1014
1014
  # @return [SelfServiceLoginFlow]
1015
1015
  def get_self_service_login_flow(id, opts = {})
1016
1016
  data, _status_code, _headers = get_self_service_login_flow_with_http_info(id, opts)
@@ -1021,7 +1021,7 @@ module OryClient
1021
1021
  # This endpoint returns a login flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/login', async function (req, res) { const flow = await client.getSelfServiceLoginFlow(req.header('cookie'), req.query['flow']) res.render('login', flow) }) ``` This request may fail due to several reasons. The `error.id` can be one of: `session_already_available`: The user is already signed in. `self_service_flow_expired`: The flow is expired and you should request a new one. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
1022
1022
  # @param id [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`).
1023
1023
  # @param [Hash] opts the optional parameters
1024
- # @option opts [String] :cookie HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.
1024
+ # @option opts [String] :cookie HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected.
1025
1025
  # @return [Array<(SelfServiceLoginFlow, Integer, Hash)>] SelfServiceLoginFlow data, response status code and response headers
1026
1026
  def get_self_service_login_flow_with_http_info(id, opts = {})
1027
1027
  if @api_client.config.debugging
@@ -1042,7 +1042,7 @@ module OryClient
1042
1042
  header_params = opts[:header_params] || {}
1043
1043
  # HTTP header 'Accept' (if needed)
1044
1044
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1045
- header_params[:'cookie'] = opts[:'cookie'] if !opts[:'cookie'].nil?
1045
+ header_params[:'Cookie'] = opts[:'cookie'] if !opts[:'cookie'].nil?
1046
1046
 
1047
1047
  # form parameters
1048
1048
  form_params = opts[:form_params] || {}
@@ -1077,7 +1077,7 @@ module OryClient
1077
1077
  # This endpoint returns a recovery flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/recovery', async function (req, res) { const flow = await client.getSelfServiceRecoveryFlow(req.header('Cookie'), req.query['flow']) res.render('recovery', flow) }) ``` More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).
1078
1078
  # @param 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;).
1079
1079
  # @param [Hash] opts the optional parameters
1080
- # @option opts [String] :cookie HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.
1080
+ # @option opts [String] :cookie HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected.
1081
1081
  # @return [SelfServiceRecoveryFlow]
1082
1082
  def get_self_service_recovery_flow(id, opts = {})
1083
1083
  data, _status_code, _headers = get_self_service_recovery_flow_with_http_info(id, opts)
@@ -1088,7 +1088,7 @@ module OryClient
1088
1088
  # This endpoint returns a recovery flow&#39;s context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request&#39;s HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: &#x60;&#x60;&#x60;js pseudo-code example router.get(&#39;/recovery&#39;, async function (req, res) { const flow &#x3D; await client.getSelfServiceRecoveryFlow(req.header(&#39;Cookie&#39;), req.query[&#39;flow&#39;]) res.render(&#39;recovery&#39;, flow) }) &#x60;&#x60;&#x60; More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).
1089
1089
  # @param 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;).
1090
1090
  # @param [Hash] opts the optional parameters
1091
- # @option opts [String] :cookie HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.
1091
+ # @option opts [String] :cookie HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected.
1092
1092
  # @return [Array<(SelfServiceRecoveryFlow, Integer, Hash)>] SelfServiceRecoveryFlow data, response status code and response headers
1093
1093
  def get_self_service_recovery_flow_with_http_info(id, opts = {})
1094
1094
  if @api_client.config.debugging
@@ -1109,7 +1109,7 @@ module OryClient
1109
1109
  header_params = opts[:header_params] || {}
1110
1110
  # HTTP header 'Accept' (if needed)
1111
1111
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1112
- header_params[:'cookie'] = opts[:'cookie'] if !opts[:'cookie'].nil?
1112
+ header_params[:'Cookie'] = opts[:'cookie'] if !opts[:'cookie'].nil?
1113
1113
 
1114
1114
  # form parameters
1115
1115
  form_params = opts[:form_params] || {}
@@ -1144,7 +1144,7 @@ module OryClient
1144
1144
  # This endpoint returns a registration flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/registration', async function (req, res) { const flow = await client.getSelfServiceRegistrationFlow(req.header('cookie'), req.query['flow']) res.render('registration', flow) }) ``` This request may fail due to several reasons. The `error.id` can be one of: `session_already_available`: The user is already signed in. `self_service_flow_expired`: The flow is expired and you should request a new one. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
1145
1145
  # @param 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;).
1146
1146
  # @param [Hash] opts the optional parameters
1147
- # @option opts [String] :cookie HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.
1147
+ # @option opts [String] :cookie HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected.
1148
1148
  # @return [SelfServiceRegistrationFlow]
1149
1149
  def get_self_service_registration_flow(id, opts = {})
1150
1150
  data, _status_code, _headers = get_self_service_registration_flow_with_http_info(id, opts)
@@ -1155,7 +1155,7 @@ module OryClient
1155
1155
  # This endpoint returns a registration flow&#39;s context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request&#39;s HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: &#x60;&#x60;&#x60;js pseudo-code example router.get(&#39;/registration&#39;, async function (req, res) { const flow &#x3D; await client.getSelfServiceRegistrationFlow(req.header(&#39;cookie&#39;), req.query[&#39;flow&#39;]) res.render(&#39;registration&#39;, flow) }) &#x60;&#x60;&#x60; This request may fail due to several reasons. The &#x60;error.id&#x60; can be one of: &#x60;session_already_available&#x60;: The user is already signed in. &#x60;self_service_flow_expired&#x60;: The flow is expired and you should request a new one. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
1156
1156
  # @param 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;).
1157
1157
  # @param [Hash] opts the optional parameters
1158
- # @option opts [String] :cookie HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.
1158
+ # @option opts [String] :cookie HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected.
1159
1159
  # @return [Array<(SelfServiceRegistrationFlow, Integer, Hash)>] SelfServiceRegistrationFlow data, response status code and response headers
1160
1160
  def get_self_service_registration_flow_with_http_info(id, opts = {})
1161
1161
  if @api_client.config.debugging
@@ -1176,7 +1176,7 @@ module OryClient
1176
1176
  header_params = opts[:header_params] || {}
1177
1177
  # HTTP header 'Accept' (if needed)
1178
1178
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1179
- header_params[:'cookie'] = opts[:'cookie'] if !opts[:'cookie'].nil?
1179
+ header_params[:'Cookie'] = opts[:'cookie'] if !opts[:'cookie'].nil?
1180
1180
 
1181
1181
  # form parameters
1182
1182
  form_params = opts[:form_params] || {}
@@ -1212,7 +1212,7 @@ module OryClient
1212
1212
  # @param id [String] ID is the Settings Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/settings?flow&#x3D;abcde&#x60;).
1213
1213
  # @param [Hash] opts the optional parameters
1214
1214
  # @option opts [String] :x_session_token The Session Token When using the SDK in an app without a browser, please include the session token here.
1215
- # @option opts [String] :cookie HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. You only need to do this for browser- based flows.
1215
+ # @option opts [String] :cookie HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected.
1216
1216
  # @return [SelfServiceSettingsFlow]
1217
1217
  def get_self_service_settings_flow(id, opts = {})
1218
1218
  data, _status_code, _headers = get_self_service_settings_flow_with_http_info(id, opts)
@@ -1224,7 +1224,7 @@ module OryClient
1224
1224
  # @param id [String] ID is the Settings Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/settings?flow&#x3D;abcde&#x60;).
1225
1225
  # @param [Hash] opts the optional parameters
1226
1226
  # @option opts [String] :x_session_token The Session Token When using the SDK in an app without a browser, please include the session token here.
1227
- # @option opts [String] :cookie HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. You only need to do this for browser- based flows.
1227
+ # @option opts [String] :cookie HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected.
1228
1228
  # @return [Array<(SelfServiceSettingsFlow, Integer, Hash)>] SelfServiceSettingsFlow data, response status code and response headers
1229
1229
  def get_self_service_settings_flow_with_http_info(id, opts = {})
1230
1230
  if @api_client.config.debugging
@@ -1246,7 +1246,7 @@ module OryClient
1246
1246
  # HTTP header 'Accept' (if needed)
1247
1247
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1248
1248
  header_params[:'X-Session-Token'] = opts[:'x_session_token'] if !opts[:'x_session_token'].nil?
1249
- header_params[:'cookie'] = opts[:'cookie'] if !opts[:'cookie'].nil?
1249
+ header_params[:'Cookie'] = opts[:'cookie'] if !opts[:'cookie'].nil?
1250
1250
 
1251
1251
  # form parameters
1252
1252
  form_params = opts[:form_params] || {}
@@ -2546,25 +2546,25 @@ module OryClient
2546
2546
  # Submit a Login Flow
2547
2547
  # :::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: Use this endpoint to complete a login flow. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and responds with HTTP 200 and a application/json body with the session token on success; HTTP 410 if the original flow expired with the appropriate error messages set and optionally a `use_flow_id` parameter in the body; HTTP 400 on form validation errors. Browser flows expect a Content-Type of `application/x-www-form-urlencoded` or `application/json` to be sent in the body and respond with a HTTP 303 redirect to the post/after login URL or the `return_to` value if it was set and if the login succeeded; a HTTP 303 redirect to the login UI URL with the flow ID containing the validation errors otherwise. Browser flows with an accept header of `application/json` will not redirect but instead respond with HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success; HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. If this endpoint is called with `Accept: application/json` in the header, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `session_already_available`: The user is already signed in. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! `browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL. Most likely used in Social Sign In flows. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
2548
2548
  # @param 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;).
2549
+ # @param submit_self_service_login_flow_body [SubmitSelfServiceLoginFlowBody]
2549
2550
  # @param [Hash] opts the optional parameters
2550
2551
  # @option opts [String] :x_session_token The Session Token of the Identity performing the settings flow.
2551
- # @option opts [String] :cookie CSRF Cookie The CSRF cookie for browsers flow.
2552
- # @option opts [SubmitSelfServiceLoginFlowBody] :submit_self_service_login_flow_body
2552
+ # @option opts [String] :cookie HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected.
2553
2553
  # @return [SuccessfulSelfServiceLoginWithoutBrowser]
2554
- def submit_self_service_login_flow(flow, opts = {})
2555
- data, _status_code, _headers = submit_self_service_login_flow_with_http_info(flow, opts)
2554
+ def submit_self_service_login_flow(flow, submit_self_service_login_flow_body, opts = {})
2555
+ data, _status_code, _headers = submit_self_service_login_flow_with_http_info(flow, submit_self_service_login_flow_body, opts)
2556
2556
  data
2557
2557
  end
2558
2558
 
2559
2559
  # Submit a Login Flow
2560
2560
  # :::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: Use this endpoint to complete a login flow. This endpoint behaves differently for API and browser flows. API flows expect &#x60;application/json&#x60; to be sent in the body and responds with HTTP 200 and a application/json body with the session token on success; HTTP 410 if the original flow expired with the appropriate error messages set and optionally a &#x60;use_flow_id&#x60; parameter in the body; HTTP 400 on form validation errors. Browser flows expect a Content-Type of &#x60;application/x-www-form-urlencoded&#x60; or &#x60;application/json&#x60; to be sent in the body and respond with a HTTP 303 redirect to the post/after login URL or the &#x60;return_to&#x60; value if it was set and if the login succeeded; a HTTP 303 redirect to the login UI URL with the flow ID containing the validation errors otherwise. Browser flows with an accept header of &#x60;application/json&#x60; will not redirect but instead respond with HTTP 200 and a application/json body with the signed in identity and a &#x60;Set-Cookie&#x60; header on success; HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. If this endpoint is called with &#x60;Accept: application/json&#x60; in the header, the response contains the flow without a redirect. In the case of an error, the &#x60;error.id&#x60; of the JSON response body can be one of: &#x60;session_already_available&#x60;: The user is already signed in. &#x60;security_csrf_violation&#x60;: Unable to fetch the flow because a CSRF violation occurred. &#x60;security_identity_mismatch&#x60;: The requested &#x60;?return_to&#x60; address is not allowed to be used. Adjust this in the configuration! &#x60;browser_location_change_required&#x60;: Usually sent when an AJAX request indicates that the browser needs to open a specific URL. Most likely used in Social Sign In flows. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
2561
2561
  # @param 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;).
2562
+ # @param submit_self_service_login_flow_body [SubmitSelfServiceLoginFlowBody]
2562
2563
  # @param [Hash] opts the optional parameters
2563
2564
  # @option opts [String] :x_session_token The Session Token of the Identity performing the settings flow.
2564
- # @option opts [String] :cookie CSRF Cookie The CSRF cookie for browsers flow.
2565
- # @option opts [SubmitSelfServiceLoginFlowBody] :submit_self_service_login_flow_body
2565
+ # @option opts [String] :cookie HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected.
2566
2566
  # @return [Array<(SuccessfulSelfServiceLoginWithoutBrowser, Integer, Hash)>] SuccessfulSelfServiceLoginWithoutBrowser data, response status code and response headers
2567
- def submit_self_service_login_flow_with_http_info(flow, opts = {})
2567
+ def submit_self_service_login_flow_with_http_info(flow, submit_self_service_login_flow_body, opts = {})
2568
2568
  if @api_client.config.debugging
2569
2569
  @api_client.config.logger.debug 'Calling API: V0alpha2Api.submit_self_service_login_flow ...'
2570
2570
  end
@@ -2572,6 +2572,10 @@ module OryClient
2572
2572
  if @api_client.config.client_side_validation && flow.nil?
2573
2573
  fail ArgumentError, "Missing the required parameter 'flow' when calling V0alpha2Api.submit_self_service_login_flow"
2574
2574
  end
2575
+ # verify the required parameter 'submit_self_service_login_flow_body' is set
2576
+ if @api_client.config.client_side_validation && submit_self_service_login_flow_body.nil?
2577
+ fail ArgumentError, "Missing the required parameter 'submit_self_service_login_flow_body' when calling V0alpha2Api.submit_self_service_login_flow"
2578
+ end
2575
2579
  # resource path
2576
2580
  local_var_path = '/self-service/login'
2577
2581
 
@@ -2589,13 +2593,13 @@ module OryClient
2589
2593
  header_params['Content-Type'] = content_type
2590
2594
  end
2591
2595
  header_params[:'X-Session-Token'] = opts[:'x_session_token'] if !opts[:'x_session_token'].nil?
2592
- header_params[:'cookie'] = opts[:'cookie'] if !opts[:'cookie'].nil?
2596
+ header_params[:'Cookie'] = opts[:'cookie'] if !opts[:'cookie'].nil?
2593
2597
 
2594
2598
  # form parameters
2595
2599
  form_params = opts[:form_params] || {}
2596
2600
 
2597
2601
  # http body (model)
2598
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'submit_self_service_login_flow_body'])
2602
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(submit_self_service_login_flow_body)
2599
2603
 
2600
2604
  # return_type
2601
2605
  return_type = opts[:debug_return_type] || 'SuccessfulSelfServiceLoginWithoutBrowser'
@@ -2754,23 +2758,25 @@ module OryClient
2754
2758
  # Complete Recovery Flow
2755
2759
  # Use this endpoint to complete a recovery flow. This endpoint behaves differently for API and browser flows and has several states: `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. For API clients and Browser clients with HTTP Header `Accept: application/json` it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid. and a HTTP 303 See Other redirect with a fresh recovery flow if the flow was otherwise invalid (e.g. expired). For Browser clients without HTTP Header `Accept` or with `Accept: text/*` it returns a HTTP 303 See Other 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 303 See Other 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).
2756
2760
  # @param flow [String] The Recovery Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/recovery?flow&#x3D;abcde&#x60;).
2761
+ # @param submit_self_service_recovery_flow_body [SubmitSelfServiceRecoveryFlowBody]
2757
2762
  # @param [Hash] opts the optional parameters
2758
2763
  # @option opts [String] :token Recovery Token The recovery token which completes the recovery request. If the token is invalid (e.g. expired) an error will be shown to the end-user. This parameter is usually set in a link and not used by any direct API call.
2759
- # @option opts [SubmitSelfServiceRecoveryFlowBody] :submit_self_service_recovery_flow_body
2764
+ # @option opts [String] :cookie HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected.
2760
2765
  # @return [SelfServiceRecoveryFlow]
2761
- def submit_self_service_recovery_flow(flow, opts = {})
2762
- data, _status_code, _headers = submit_self_service_recovery_flow_with_http_info(flow, opts)
2766
+ def submit_self_service_recovery_flow(flow, submit_self_service_recovery_flow_body, opts = {})
2767
+ data, _status_code, _headers = submit_self_service_recovery_flow_with_http_info(flow, submit_self_service_recovery_flow_body, opts)
2763
2768
  data
2764
2769
  end
2765
2770
 
2766
2771
  # Complete Recovery Flow
2767
2772
  # Use this endpoint to complete a recovery flow. This endpoint behaves differently for API and browser flows and has several states: &#x60;choose_method&#x60; expects &#x60;flow&#x60; (in the URL query) and &#x60;email&#x60; (in the body) to be sent and works with API- and Browser-initiated flows. For API clients and Browser clients with HTTP Header &#x60;Accept: application/json&#x60; it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid. and a HTTP 303 See Other redirect with a fresh recovery flow if the flow was otherwise invalid (e.g. expired). For Browser clients without HTTP Header &#x60;Accept&#x60; or with &#x60;Accept: text/*&#x60; it returns a HTTP 303 See Other redirect to the Recovery UI URL with the Recovery Flow ID appended. &#x60;sent_email&#x60; is the success state after &#x60;choose_method&#x60; for the &#x60;link&#x60; method and allows the user to request another recovery email. It works for both API and Browser-initiated flows and returns the same responses as the flow in &#x60;choose_method&#x60; state. &#x60;passed_challenge&#x60; expects a &#x60;token&#x60; to be sent in the URL query and given the nature of the flow (\&quot;sending a recovery link\&quot;) does not have any API capabilities. The server responds with a HTTP 303 See Other 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).
2768
2773
  # @param flow [String] The Recovery Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/recovery?flow&#x3D;abcde&#x60;).
2774
+ # @param submit_self_service_recovery_flow_body [SubmitSelfServiceRecoveryFlowBody]
2769
2775
  # @param [Hash] opts the optional parameters
2770
2776
  # @option opts [String] :token Recovery Token The recovery token which completes the recovery request. If the token is invalid (e.g. expired) an error will be shown to the end-user. This parameter is usually set in a link and not used by any direct API call.
2771
- # @option opts [SubmitSelfServiceRecoveryFlowBody] :submit_self_service_recovery_flow_body
2777
+ # @option opts [String] :cookie HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected.
2772
2778
  # @return [Array<(SelfServiceRecoveryFlow, Integer, Hash)>] SelfServiceRecoveryFlow data, response status code and response headers
2773
- def submit_self_service_recovery_flow_with_http_info(flow, opts = {})
2779
+ def submit_self_service_recovery_flow_with_http_info(flow, submit_self_service_recovery_flow_body, opts = {})
2774
2780
  if @api_client.config.debugging
2775
2781
  @api_client.config.logger.debug 'Calling API: V0alpha2Api.submit_self_service_recovery_flow ...'
2776
2782
  end
@@ -2778,6 +2784,10 @@ module OryClient
2778
2784
  if @api_client.config.client_side_validation && flow.nil?
2779
2785
  fail ArgumentError, "Missing the required parameter 'flow' when calling V0alpha2Api.submit_self_service_recovery_flow"
2780
2786
  end
2787
+ # verify the required parameter 'submit_self_service_recovery_flow_body' is set
2788
+ if @api_client.config.client_side_validation && submit_self_service_recovery_flow_body.nil?
2789
+ fail ArgumentError, "Missing the required parameter 'submit_self_service_recovery_flow_body' when calling V0alpha2Api.submit_self_service_recovery_flow"
2790
+ end
2781
2791
  # resource path
2782
2792
  local_var_path = '/self-service/recovery'
2783
2793
 
@@ -2795,12 +2805,13 @@ module OryClient
2795
2805
  if !content_type.nil?
2796
2806
  header_params['Content-Type'] = content_type
2797
2807
  end
2808
+ header_params[:'Cookie'] = opts[:'cookie'] if !opts[:'cookie'].nil?
2798
2809
 
2799
2810
  # form parameters
2800
2811
  form_params = opts[:form_params] || {}
2801
2812
 
2802
2813
  # http body (model)
2803
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'submit_self_service_recovery_flow_body'])
2814
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(submit_self_service_recovery_flow_body)
2804
2815
 
2805
2816
  # return_type
2806
2817
  return_type = opts[:debug_return_type] || 'SelfServiceRecoveryFlow'
@@ -2828,21 +2839,23 @@ module OryClient
2828
2839
  # Submit a Registration Flow
2829
2840
  # 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 410 if the original flow expired with the appropriate error messages set and optionally a `use_flow_id` parameter in the body; HTTP 400 on form validation errors. Browser flows expect a Content-Type of `application/x-www-form-urlencoded` or `application/json` to be sent in the body and respond with a HTTP 303 redirect to the post/after registration URL or the `return_to` value if it was set and if the registration succeeded; a HTTP 303 redirect to the registration UI URL with the flow ID containing the validation errors otherwise. Browser flows with an accept header of `application/json` will not redirect but instead respond with HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success; HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. If this endpoint is called with `Accept: application/json` in the header, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `session_already_available`: The user is already signed in. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! `browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL. Most likely used in Social Sign In flows. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
2830
2841
  # @param 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;).
2842
+ # @param submit_self_service_registration_flow_body [SubmitSelfServiceRegistrationFlowBody]
2831
2843
  # @param [Hash] opts the optional parameters
2832
- # @option opts [SubmitSelfServiceRegistrationFlowBody] :submit_self_service_registration_flow_body
2844
+ # @option opts [String] :cookie HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected.
2833
2845
  # @return [SuccessfulSelfServiceRegistrationWithoutBrowser]
2834
- def submit_self_service_registration_flow(flow, opts = {})
2835
- data, _status_code, _headers = submit_self_service_registration_flow_with_http_info(flow, opts)
2846
+ def submit_self_service_registration_flow(flow, submit_self_service_registration_flow_body, opts = {})
2847
+ data, _status_code, _headers = submit_self_service_registration_flow_with_http_info(flow, submit_self_service_registration_flow_body, opts)
2836
2848
  data
2837
2849
  end
2838
2850
 
2839
2851
  # Submit a Registration Flow
2840
2852
  # Use this endpoint to complete a registration flow by sending an identity&#39;s traits and password. This endpoint behaves differently for API and browser flows. API flows expect &#x60;application/json&#x60; to be sent in the body and respond with HTTP 200 and a application/json body with the created identity success - if the session hook is configured the &#x60;session&#x60; and &#x60;session_token&#x60; will also be included; HTTP 410 if the original flow expired with the appropriate error messages set and optionally a &#x60;use_flow_id&#x60; parameter in the body; HTTP 400 on form validation errors. Browser flows expect a Content-Type of &#x60;application/x-www-form-urlencoded&#x60; or &#x60;application/json&#x60; to be sent in the body and respond with a HTTP 303 redirect to the post/after registration URL or the &#x60;return_to&#x60; value if it was set and if the registration succeeded; a HTTP 303 redirect to the registration UI URL with the flow ID containing the validation errors otherwise. Browser flows with an accept header of &#x60;application/json&#x60; will not redirect but instead respond with HTTP 200 and a application/json body with the signed in identity and a &#x60;Set-Cookie&#x60; header on success; HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. If this endpoint is called with &#x60;Accept: application/json&#x60; in the header, the response contains the flow without a redirect. In the case of an error, the &#x60;error.id&#x60; of the JSON response body can be one of: &#x60;session_already_available&#x60;: The user is already signed in. &#x60;security_csrf_violation&#x60;: Unable to fetch the flow because a CSRF violation occurred. &#x60;security_identity_mismatch&#x60;: The requested &#x60;?return_to&#x60; address is not allowed to be used. Adjust this in the configuration! &#x60;browser_location_change_required&#x60;: Usually sent when an AJAX request indicates that the browser needs to open a specific URL. Most likely used in Social Sign In flows. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
2841
2853
  # @param 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;).
2854
+ # @param submit_self_service_registration_flow_body [SubmitSelfServiceRegistrationFlowBody]
2842
2855
  # @param [Hash] opts the optional parameters
2843
- # @option opts [SubmitSelfServiceRegistrationFlowBody] :submit_self_service_registration_flow_body
2856
+ # @option opts [String] :cookie HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected.
2844
2857
  # @return [Array<(SuccessfulSelfServiceRegistrationWithoutBrowser, Integer, Hash)>] SuccessfulSelfServiceRegistrationWithoutBrowser data, response status code and response headers
2845
- def submit_self_service_registration_flow_with_http_info(flow, opts = {})
2858
+ def submit_self_service_registration_flow_with_http_info(flow, submit_self_service_registration_flow_body, opts = {})
2846
2859
  if @api_client.config.debugging
2847
2860
  @api_client.config.logger.debug 'Calling API: V0alpha2Api.submit_self_service_registration_flow ...'
2848
2861
  end
@@ -2850,6 +2863,10 @@ module OryClient
2850
2863
  if @api_client.config.client_side_validation && flow.nil?
2851
2864
  fail ArgumentError, "Missing the required parameter 'flow' when calling V0alpha2Api.submit_self_service_registration_flow"
2852
2865
  end
2866
+ # verify the required parameter 'submit_self_service_registration_flow_body' is set
2867
+ if @api_client.config.client_side_validation && submit_self_service_registration_flow_body.nil?
2868
+ fail ArgumentError, "Missing the required parameter 'submit_self_service_registration_flow_body' when calling V0alpha2Api.submit_self_service_registration_flow"
2869
+ end
2853
2870
  # resource path
2854
2871
  local_var_path = '/self-service/registration'
2855
2872
 
@@ -2866,12 +2883,13 @@ module OryClient
2866
2883
  if !content_type.nil?
2867
2884
  header_params['Content-Type'] = content_type
2868
2885
  end
2886
+ header_params[:'Cookie'] = opts[:'cookie'] if !opts[:'cookie'].nil?
2869
2887
 
2870
2888
  # form parameters
2871
2889
  form_params = opts[:form_params] || {}
2872
2890
 
2873
2891
  # http body (model)
2874
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'submit_self_service_registration_flow_body'])
2892
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(submit_self_service_registration_flow_body)
2875
2893
 
2876
2894
  # return_type
2877
2895
  return_type = opts[:debug_return_type] || 'SuccessfulSelfServiceRegistrationWithoutBrowser'
@@ -2899,23 +2917,25 @@ module OryClient
2899
2917
  # Complete Settings Flow
2900
2918
  # 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 303 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 or the session's AAL is too low. Implies that the user needs to re-authenticate. Browser flows without HTTP Header `Accept` or with `Accept: text/*` respond with a HTTP 303 redirect to the post/after settings URL or the `return_to` value if it was set and if the flow succeeded; a HTTP 303 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise. a HTTP 303 redirect to the login endpoint when `selfservice.flows.settings.privileged_session_max_age` was reached or the session's AAL is too low. Browser flows with HTTP Header `Accept: application/json` respond with HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success; HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 401 when the endpoint is called without a valid session cookie. HTTP 403 when the page is accessed without a session cookie or the session's AAL is too low. HTTP 400 on form validation errors. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor (happens automatically for server-side browser flows) or change the configuration. If this endpoint is called with a `Accept: application/json` HTTP header, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `session_refresh_required`: The identity requested to change something that needs a privileged session. Redirect the identity to the login init endpoint with query parameters `?refresh=true&return_to=<the-current-browser-url>`, or initiate a refresh login flow otherwise. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `session_inactive`: No Ory Session was found - sign in a user first. `security_identity_mismatch`: The flow was interrupted with `session_refresh_required` but apparently some other identity logged in instead. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! `browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL. Most likely used in Social Sign In flows. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
2901
2919
  # @param flow [String] The Settings Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/settings?flow&#x3D;abcde&#x60;).
2920
+ # @param submit_self_service_settings_flow_body [SubmitSelfServiceSettingsFlowBody]
2902
2921
  # @param [Hash] opts the optional parameters
2903
2922
  # @option opts [String] :x_session_token The Session Token of the Identity performing the settings flow.
2904
- # @option opts [SubmitSelfServiceSettingsFlowBody] :submit_self_service_settings_flow_body
2923
+ # @option opts [String] :cookie HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected.
2905
2924
  # @return [SelfServiceSettingsFlow]
2906
- def submit_self_service_settings_flow(flow, opts = {})
2907
- data, _status_code, _headers = submit_self_service_settings_flow_with_http_info(flow, opts)
2925
+ def submit_self_service_settings_flow(flow, submit_self_service_settings_flow_body, opts = {})
2926
+ data, _status_code, _headers = submit_self_service_settings_flow_with_http_info(flow, submit_self_service_settings_flow_body, opts)
2908
2927
  data
2909
2928
  end
2910
2929
 
2911
2930
  # Complete Settings Flow
2912
2931
  # Use this endpoint to complete a settings flow by sending an identity&#39;s updated password. This endpoint behaves differently for API and browser flows. API-initiated flows expect &#x60;application/json&#x60; to be sent in the body and respond with HTTP 200 and an application/json body with the session token on success; HTTP 303 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. HTTP 401 when the endpoint is called without a valid session token. HTTP 403 when &#x60;selfservice.flows.settings.privileged_session_max_age&#x60; was reached or the session&#39;s AAL is too low. Implies that the user needs to re-authenticate. Browser flows without HTTP Header &#x60;Accept&#x60; or with &#x60;Accept: text/*&#x60; respond with a HTTP 303 redirect to the post/after settings URL or the &#x60;return_to&#x60; value if it was set and if the flow succeeded; a HTTP 303 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise. a HTTP 303 redirect to the login endpoint when &#x60;selfservice.flows.settings.privileged_session_max_age&#x60; was reached or the session&#39;s AAL is too low. Browser flows with HTTP Header &#x60;Accept: application/json&#x60; respond with HTTP 200 and a application/json body with the signed in identity and a &#x60;Set-Cookie&#x60; header on success; HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 401 when the endpoint is called without a valid session cookie. HTTP 403 when the page is accessed without a session cookie or the session&#39;s AAL is too low. HTTP 400 on form validation errors. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor (happens automatically for server-side browser flows) or change the configuration. If this endpoint is called with a &#x60;Accept: application/json&#x60; HTTP header, the response contains the flow without a redirect. In the case of an error, the &#x60;error.id&#x60; of the JSON response body can be one of: &#x60;session_refresh_required&#x60;: The identity requested to change something that needs a privileged session. Redirect the identity to the login init endpoint with query parameters &#x60;?refresh&#x3D;true&amp;return_to&#x3D;&lt;the-current-browser-url&gt;&#x60;, or initiate a refresh login flow otherwise. &#x60;security_csrf_violation&#x60;: Unable to fetch the flow because a CSRF violation occurred. &#x60;session_inactive&#x60;: No Ory Session was found - sign in a user first. &#x60;security_identity_mismatch&#x60;: The flow was interrupted with &#x60;session_refresh_required&#x60; but apparently some other identity logged in instead. &#x60;security_identity_mismatch&#x60;: The requested &#x60;?return_to&#x60; address is not allowed to be used. Adjust this in the configuration! &#x60;browser_location_change_required&#x60;: Usually sent when an AJAX request indicates that the browser needs to open a specific URL. Most likely used in Social Sign In flows. More information can be found at [Ory Kratos User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
2913
2932
  # @param flow [String] The Settings Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/settings?flow&#x3D;abcde&#x60;).
2933
+ # @param submit_self_service_settings_flow_body [SubmitSelfServiceSettingsFlowBody]
2914
2934
  # @param [Hash] opts the optional parameters
2915
2935
  # @option opts [String] :x_session_token The Session Token of the Identity performing the settings flow.
2916
- # @option opts [SubmitSelfServiceSettingsFlowBody] :submit_self_service_settings_flow_body
2936
+ # @option opts [String] :cookie HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected.
2917
2937
  # @return [Array<(SelfServiceSettingsFlow, Integer, Hash)>] SelfServiceSettingsFlow data, response status code and response headers
2918
- def submit_self_service_settings_flow_with_http_info(flow, opts = {})
2938
+ def submit_self_service_settings_flow_with_http_info(flow, submit_self_service_settings_flow_body, opts = {})
2919
2939
  if @api_client.config.debugging
2920
2940
  @api_client.config.logger.debug 'Calling API: V0alpha2Api.submit_self_service_settings_flow ...'
2921
2941
  end
@@ -2923,6 +2943,10 @@ module OryClient
2923
2943
  if @api_client.config.client_side_validation && flow.nil?
2924
2944
  fail ArgumentError, "Missing the required parameter 'flow' when calling V0alpha2Api.submit_self_service_settings_flow"
2925
2945
  end
2946
+ # verify the required parameter 'submit_self_service_settings_flow_body' is set
2947
+ if @api_client.config.client_side_validation && submit_self_service_settings_flow_body.nil?
2948
+ fail ArgumentError, "Missing the required parameter 'submit_self_service_settings_flow_body' when calling V0alpha2Api.submit_self_service_settings_flow"
2949
+ end
2926
2950
  # resource path
2927
2951
  local_var_path = '/self-service/settings'
2928
2952
 
@@ -2940,12 +2964,13 @@ module OryClient
2940
2964
  header_params['Content-Type'] = content_type
2941
2965
  end
2942
2966
  header_params[:'X-Session-Token'] = opts[:'x_session_token'] if !opts[:'x_session_token'].nil?
2967
+ header_params[:'Cookie'] = opts[:'cookie'] if !opts[:'cookie'].nil?
2943
2968
 
2944
2969
  # form parameters
2945
2970
  form_params = opts[:form_params] || {}
2946
2971
 
2947
2972
  # http body (model)
2948
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'submit_self_service_settings_flow_body'])
2973
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(submit_self_service_settings_flow_body)
2949
2974
 
2950
2975
  # return_type
2951
2976
  return_type = opts[:debug_return_type] || 'SelfServiceSettingsFlow'
@@ -2973,23 +2998,25 @@ module OryClient
2973
2998
  # Complete Verification Flow
2974
2999
  # Use this endpoint to complete a verification flow. This endpoint behaves differently for API and browser flows and has several states: `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. For API clients and Browser clients with HTTP Header `Accept: application/json` it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid and a HTTP 303 See Other redirect with a fresh verification flow if the flow was otherwise invalid (e.g. expired). For Browser clients without HTTP Header `Accept` or with `Accept: text/*` it returns a HTTP 303 See Other 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 303 See Other 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).
2975
3000
  # @param flow [String] The Verification Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/verification?flow&#x3D;abcde&#x60;).
3001
+ # @param submit_self_service_verification_flow_body [SubmitSelfServiceVerificationFlowBody]
2976
3002
  # @param [Hash] opts the optional parameters
2977
3003
  # @option opts [String] :token Verification Token The verification token which completes the verification request. If the token is invalid (e.g. expired) an error will be shown to the end-user. This parameter is usually set in a link and not used by any direct API call.
2978
- # @option opts [SubmitSelfServiceVerificationFlowBody] :submit_self_service_verification_flow_body
3004
+ # @option opts [String] :cookie HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected.
2979
3005
  # @return [SelfServiceVerificationFlow]
2980
- def submit_self_service_verification_flow(flow, opts = {})
2981
- data, _status_code, _headers = submit_self_service_verification_flow_with_http_info(flow, opts)
3006
+ def submit_self_service_verification_flow(flow, submit_self_service_verification_flow_body, opts = {})
3007
+ data, _status_code, _headers = submit_self_service_verification_flow_with_http_info(flow, submit_self_service_verification_flow_body, opts)
2982
3008
  data
2983
3009
  end
2984
3010
 
2985
3011
  # Complete Verification Flow
2986
3012
  # Use this endpoint to complete a verification flow. This endpoint behaves differently for API and browser flows and has several states: &#x60;choose_method&#x60; expects &#x60;flow&#x60; (in the URL query) and &#x60;email&#x60; (in the body) to be sent and works with API- and Browser-initiated flows. For API clients and Browser clients with HTTP Header &#x60;Accept: application/json&#x60; it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid and a HTTP 303 See Other redirect with a fresh verification flow if the flow was otherwise invalid (e.g. expired). For Browser clients without HTTP Header &#x60;Accept&#x60; or with &#x60;Accept: text/*&#x60; it returns a HTTP 303 See Other redirect to the Verification UI URL with the Verification Flow ID appended. &#x60;sent_email&#x60; is the success state after &#x60;choose_method&#x60; when using the &#x60;link&#x60; method and allows the user to request another verification email. It works for both API and Browser-initiated flows and returns the same responses as the flow in &#x60;choose_method&#x60; state. &#x60;passed_challenge&#x60; expects a &#x60;token&#x60; to be sent in the URL query and given the nature of the flow (\&quot;sending a verification link\&quot;) does not have any API capabilities. The server responds with a HTTP 303 See Other 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).
2987
3013
  # @param flow [String] The Verification Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/verification?flow&#x3D;abcde&#x60;).
3014
+ # @param submit_self_service_verification_flow_body [SubmitSelfServiceVerificationFlowBody]
2988
3015
  # @param [Hash] opts the optional parameters
2989
3016
  # @option opts [String] :token Verification Token The verification token which completes the verification request. If the token is invalid (e.g. expired) an error will be shown to the end-user. This parameter is usually set in a link and not used by any direct API call.
2990
- # @option opts [SubmitSelfServiceVerificationFlowBody] :submit_self_service_verification_flow_body
3017
+ # @option opts [String] :cookie HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected.
2991
3018
  # @return [Array<(SelfServiceVerificationFlow, Integer, Hash)>] SelfServiceVerificationFlow data, response status code and response headers
2992
- def submit_self_service_verification_flow_with_http_info(flow, opts = {})
3019
+ def submit_self_service_verification_flow_with_http_info(flow, submit_self_service_verification_flow_body, opts = {})
2993
3020
  if @api_client.config.debugging
2994
3021
  @api_client.config.logger.debug 'Calling API: V0alpha2Api.submit_self_service_verification_flow ...'
2995
3022
  end
@@ -2997,6 +3024,10 @@ module OryClient
2997
3024
  if @api_client.config.client_side_validation && flow.nil?
2998
3025
  fail ArgumentError, "Missing the required parameter 'flow' when calling V0alpha2Api.submit_self_service_verification_flow"
2999
3026
  end
3027
+ # verify the required parameter 'submit_self_service_verification_flow_body' is set
3028
+ if @api_client.config.client_side_validation && submit_self_service_verification_flow_body.nil?
3029
+ fail ArgumentError, "Missing the required parameter 'submit_self_service_verification_flow_body' when calling V0alpha2Api.submit_self_service_verification_flow"
3030
+ end
3000
3031
  # resource path
3001
3032
  local_var_path = '/self-service/verification'
3002
3033
 
@@ -3014,12 +3045,13 @@ module OryClient
3014
3045
  if !content_type.nil?
3015
3046
  header_params['Content-Type'] = content_type
3016
3047
  end
3048
+ header_params[:'Cookie'] = opts[:'cookie'] if !opts[:'cookie'].nil?
3017
3049
 
3018
3050
  # form parameters
3019
3051
  form_params = opts[:form_params] || {}
3020
3052
 
3021
3053
  # http body (model)
3022
- post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'submit_self_service_verification_flow_body'])
3054
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(submit_self_service_verification_flow_body)
3023
3055
 
3024
3056
  # return_type
3025
3057
  return_type = opts[:debug_return_type] || 'SelfServiceVerificationFlow'
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
5
5
 
6
- The version of the OpenAPI document: v0.0.1-alpha.177
6
+ The version of the OpenAPI document: v0.0.1-alpha.180
7
7
  Contact: support@ory.sh
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
5
5
 
6
- The version of the OpenAPI document: v0.0.1-alpha.177
6
+ The version of the OpenAPI document: v0.0.1-alpha.180
7
7
  Contact: support@ory.sh
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
5
5
 
6
- The version of the OpenAPI document: v0.0.1-alpha.177
6
+ The version of the OpenAPI document: v0.0.1-alpha.180
7
7
  Contact: support@ory.sh
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
5
5
 
6
- The version of the OpenAPI document: v0.0.1-alpha.177
6
+ The version of the OpenAPI document: v0.0.1-alpha.180
7
7
  Contact: support@ory.sh
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
5
5
 
6
- The version of the OpenAPI document: v0.0.1-alpha.177
6
+ The version of the OpenAPI document: v0.0.1-alpha.180
7
7
  Contact: support@ory.sh
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
5
5
 
6
- The version of the OpenAPI document: v0.0.1-alpha.177
6
+ The version of the OpenAPI document: v0.0.1-alpha.180
7
7
  Contact: support@ory.sh
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
5
5
 
6
- The version of the OpenAPI document: v0.0.1-alpha.177
6
+ The version of the OpenAPI document: v0.0.1-alpha.180
7
7
  Contact: support@ory.sh
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
5
5
 
6
- The version of the OpenAPI document: v0.0.1-alpha.177
6
+ The version of the OpenAPI document: v0.0.1-alpha.180
7
7
  Contact: support@ory.sh
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
5
5
 
6
- The version of the OpenAPI document: v0.0.1-alpha.177
6
+ The version of the OpenAPI document: v0.0.1-alpha.180
7
7
  Contact: support@ory.sh
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
5
5
 
6
- The version of the OpenAPI document: v0.0.1-alpha.177
6
+ The version of the OpenAPI document: v0.0.1-alpha.180
7
7
  Contact: support@ory.sh
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
5
5
 
6
- The version of the OpenAPI document: v0.0.1-alpha.177
6
+ The version of the OpenAPI document: v0.0.1-alpha.180
7
7
  Contact: support@ory.sh
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
5
5
 
6
- The version of the OpenAPI document: v0.0.1-alpha.177
6
+ The version of the OpenAPI document: v0.0.1-alpha.180
7
7
  Contact: support@ory.sh
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
5
5
 
6
- The version of the OpenAPI document: v0.0.1-alpha.177
6
+ The version of the OpenAPI document: v0.0.1-alpha.180
7
7
  Contact: support@ory.sh
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
5
5
 
6
- The version of the OpenAPI document: v0.0.1-alpha.177
6
+ The version of the OpenAPI document: v0.0.1-alpha.180
7
7
  Contact: support@ory.sh
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.4.0