ory-client 1.22.34 → 1.22.36

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (723) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +20 -5
  4. data/docs/AcceptOAuth2ConsentRequest.md +2 -2
  5. data/docs/AcceptOAuth2LoginRequest.md +1 -1
  6. data/docs/AdminIdentityImportCredentialsLookupSecret.md +18 -0
  7. data/docs/AdminIdentityImportCredentialsLookupSecretConfig.md +18 -0
  8. data/docs/BasicOrganization.md +1 -1
  9. data/docs/CloudAccount.md +2 -0
  10. data/docs/CourierApi.md +4 -4
  11. data/docs/CreateProjectNormalizedPayload.md +103 -101
  12. data/docs/DeviceUserAuthRequest.md +2 -2
  13. data/docs/FrontendApi.md +22 -20
  14. data/docs/IdentityApi.md +30 -30
  15. data/docs/IdentityCredentialsLookupSecretCode.md +20 -0
  16. data/docs/IdentityCredentialsWebAuthn.md +36 -0
  17. data/docs/IdentityCredentialsWebAuthnAttestation.md +26 -0
  18. data/docs/IdentityCredentialsWebAuthnAuthenticator.md +22 -0
  19. data/docs/IdentityCredentialsWebAuthnFlags.md +24 -0
  20. data/docs/IdentityPatchResponse.md +1 -1
  21. data/docs/IdentityWithCredentials.md +9 -1
  22. data/docs/IdentityWithCredentialsPasskey.md +18 -0
  23. data/docs/IdentityWithCredentialsPasskeyConfig.md +20 -0
  24. data/docs/IdentityWithCredentialsPasswordConfig.md +1 -1
  25. data/docs/IdentityWithCredentialsTotp.md +18 -0
  26. data/docs/IdentityWithCredentialsTotpConfig.md +18 -0
  27. data/docs/IdentityWithCredentialsWebAuthn.md +18 -0
  28. data/docs/IdentityWithCredentialsWebAuthnConfig.md +20 -0
  29. data/docs/KeysetPaginationRequestParameters.md +2 -2
  30. data/docs/NormalizedProject.md +1 -1
  31. data/docs/NormalizedProjectRevision.md +103 -101
  32. data/docs/NormalizedProjectRevisionSAMLProvider.md +1 -1
  33. data/docs/NormalizedProjectRevisionThirdPartyProvider.md +2 -2
  34. data/docs/OAuth2Api.md +12 -12
  35. data/docs/OAuth2Client.md +12 -12
  36. data/docs/OAuth2ConsentRequest.md +3 -3
  37. data/docs/OAuth2ConsentSession.md +2 -2
  38. data/docs/OAuth2LoginRequest.md +2 -2
  39. data/docs/Organization.md +1 -1
  40. data/docs/PatchWorkspaceMemberBody.md +18 -0
  41. data/docs/PermissionApi.md +5 -5
  42. data/docs/ProjectApi.md +4 -4
  43. data/docs/ProjectMember.md +5 -1
  44. data/docs/ProjectMetadata.md +1 -1
  45. data/docs/QuotaUsage.md +1 -1
  46. data/docs/RecoveryIdentityAddress.md +2 -0
  47. data/docs/RelationshipApi.md +4 -4
  48. data/docs/TokenPagination.md +2 -2
  49. data/docs/TokenPaginationHeaders.md +1 -1
  50. data/docs/TokenPaginationRequestParameters.md +2 -2
  51. data/docs/UiNodeInputAttributes.md +2 -0
  52. data/docs/UiNodeInputAttributesOption.md +18 -0
  53. data/docs/UpdateRecoveryFlowWithCodeMethod.md +1 -1
  54. data/docs/UpdateVerificationFlowWithCodeMethod.md +1 -1
  55. data/docs/VerifyUserCodeRequest.md +2 -2
  56. data/docs/WorkspaceApi.md +4 -4
  57. data/docs/WorkspaceOrganization.md +1 -1
  58. data/lib/ory-client/api/courier_api.rb +5 -5
  59. data/lib/ory-client/api/events_api.rb +1 -1
  60. data/lib/ory-client/api/frontend_api.rb +38 -35
  61. data/lib/ory-client/api/identity_api.rb +39 -39
  62. data/lib/ory-client/api/jwk_api.rb +1 -1
  63. data/lib/ory-client/api/metadata_api.rb +1 -1
  64. data/lib/ory-client/api/o_auth2_api.rb +13 -13
  65. data/lib/ory-client/api/oidc_api.rb +1 -1
  66. data/lib/ory-client/api/permission_api.rb +11 -11
  67. data/lib/ory-client/api/project_api.rb +5 -5
  68. data/lib/ory-client/api/relationship_api.rb +5 -5
  69. data/lib/ory-client/api/wellknown_api.rb +1 -1
  70. data/lib/ory-client/api/workspace_api.rb +5 -5
  71. data/lib/ory-client/api_client.rb +1 -1
  72. data/lib/ory-client/api_error.rb +1 -1
  73. data/lib/ory-client/api_model_base.rb +1 -1
  74. data/lib/ory-client/configuration.rb +1 -1
  75. data/lib/ory-client/models/accept_device_user_code_request.rb +1 -1
  76. data/lib/ory-client/models/accept_o_auth2_consent_request.rb +3 -1
  77. data/lib/ory-client/models/accept_o_auth2_consent_request_session.rb +1 -1
  78. data/lib/ory-client/models/accept_o_auth2_login_request.rb +2 -1
  79. data/lib/ory-client/models/account_experience_colors.rb +1 -1
  80. data/lib/ory-client/models/account_experience_configuration.rb +1 -1
  81. data/lib/ory-client/models/add_project_to_workspace_body.rb +1 -1
  82. data/lib/ory-client/models/admin_identity_import_credentials_lookup_secret.rb +148 -0
  83. data/lib/ory-client/models/admin_identity_import_credentials_lookup_secret_config.rb +151 -0
  84. data/lib/ory-client/models/attribute.rb +1 -1
  85. data/lib/ory-client/models/attribute_filter.rb +1 -1
  86. data/lib/ory-client/models/attributes_count_datapoint.rb +1 -1
  87. data/lib/ory-client/models/authenticator_assurance_level.rb +1 -1
  88. data/lib/ory-client/models/basic_organization.rb +2 -1
  89. data/lib/ory-client/models/batch_check_permission_body.rb +1 -1
  90. data/lib/ory-client/models/batch_check_permission_result.rb +1 -1
  91. data/lib/ory-client/models/batch_patch_identities_response.rb +1 -1
  92. data/lib/ory-client/models/billing_period_bucket.rb +1 -1
  93. data/lib/ory-client/models/check_opl_syntax_result.rb +1 -1
  94. data/lib/ory-client/models/check_permission_result.rb +1 -1
  95. data/lib/ory-client/models/check_permission_result_with_error.rb +1 -1
  96. data/lib/ory-client/models/cloud_account.rb +12 -2
  97. data/lib/ory-client/models/consistency_request_parameters.rb +1 -1
  98. data/lib/ory-client/models/continue_with.rb +1 -1
  99. data/lib/ory-client/models/continue_with_recovery_ui.rb +1 -1
  100. data/lib/ory-client/models/continue_with_recovery_ui_flow.rb +1 -1
  101. data/lib/ory-client/models/continue_with_redirect_browser_to.rb +1 -1
  102. data/lib/ory-client/models/continue_with_set_ory_session_token.rb +1 -1
  103. data/lib/ory-client/models/continue_with_settings_ui.rb +1 -1
  104. data/lib/ory-client/models/continue_with_settings_ui_flow.rb +1 -1
  105. data/lib/ory-client/models/continue_with_verification_ui.rb +1 -1
  106. data/lib/ory-client/models/continue_with_verification_ui_flow.rb +1 -1
  107. data/lib/ory-client/models/courier_message_status.rb +1 -1
  108. data/lib/ory-client/models/courier_message_type.rb +1 -1
  109. data/lib/ory-client/models/create_custom_domain_body.rb +1 -1
  110. data/lib/ory-client/models/create_event_stream_body.rb +1 -1
  111. data/lib/ory-client/models/create_fedcm_flow_response.rb +1 -1
  112. data/lib/ory-client/models/create_identity_body.rb +1 -1
  113. data/lib/ory-client/models/create_invite_response.rb +1 -1
  114. data/lib/ory-client/models/create_json_web_key_set.rb +1 -1
  115. data/lib/ory-client/models/create_onboarding_link_response.rb +1 -1
  116. data/lib/ory-client/models/create_organization_onboarding_portal_link_body.rb +1 -1
  117. data/lib/ory-client/models/create_project_api_key_request.rb +1 -1
  118. data/lib/ory-client/models/create_project_body.rb +1 -1
  119. data/lib/ory-client/models/create_project_branding.rb +1 -1
  120. data/lib/ory-client/models/create_project_member_invite_body.rb +1 -1
  121. data/lib/ory-client/models/create_project_normalized_payload.rb +113 -85
  122. data/lib/ory-client/models/create_recovery_code_for_identity_body.rb +1 -1
  123. data/lib/ory-client/models/create_recovery_link_for_identity_body.rb +1 -1
  124. data/lib/ory-client/models/create_relationship_body.rb +1 -1
  125. data/lib/ory-client/models/create_subscription_body.rb +1 -1
  126. data/lib/ory-client/models/create_subscription_common.rb +1 -1
  127. data/lib/ory-client/models/create_verifiable_credential_request_body.rb +1 -1
  128. data/lib/ory-client/models/create_workspace_api_key_body.rb +1 -1
  129. data/lib/ory-client/models/create_workspace_body.rb +1 -1
  130. data/lib/ory-client/models/create_workspace_member_invite_body.rb +1 -1
  131. data/lib/ory-client/models/create_workspace_organization_body.rb +1 -1
  132. data/lib/ory-client/models/create_workspace_subscription_body.rb +1 -1
  133. data/lib/ory-client/models/credential_supported_draft00.rb +1 -1
  134. data/lib/ory-client/models/custom_domain.rb +1 -1
  135. data/lib/ory-client/models/delete_my_sessions_count.rb +1 -1
  136. data/lib/ory-client/models/device_authorization.rb +1 -1
  137. data/lib/ory-client/models/device_user_auth_request.rb +3 -1
  138. data/lib/ory-client/models/email_template_data.rb +1 -1
  139. data/lib/ory-client/models/email_template_data_body.rb +1 -1
  140. data/lib/ory-client/models/error_authenticator_assurance_level_not_satisfied.rb +1 -1
  141. data/lib/ory-client/models/error_browser_location_change_required.rb +1 -1
  142. data/lib/ory-client/models/error_flow_replaced.rb +1 -1
  143. data/lib/ory-client/models/error_generic.rb +1 -1
  144. data/lib/ory-client/models/error_o_auth2.rb +1 -1
  145. data/lib/ory-client/models/event_stream.rb +1 -1
  146. data/lib/ory-client/models/expanded_permission_tree.rb +1 -1
  147. data/lib/ory-client/models/flow_error.rb +1 -1
  148. data/lib/ory-client/models/generic_error.rb +1 -1
  149. data/lib/ory-client/models/generic_error_content.rb +1 -1
  150. data/lib/ory-client/models/generic_oidc_provider.rb +1 -1
  151. data/lib/ory-client/models/generic_usage.rb +1 -1
  152. data/lib/ory-client/models/get_attributes_count.rb +1 -1
  153. data/lib/ory-client/models/get_managed_identity_schema_location.rb +1 -1
  154. data/lib/ory-client/models/get_metrics_count.rb +1 -1
  155. data/lib/ory-client/models/get_metrics_event_attributes.rb +1 -1
  156. data/lib/ory-client/models/get_metrics_event_types.rb +1 -1
  157. data/lib/ory-client/models/get_organization_response.rb +1 -1
  158. data/lib/ory-client/models/get_project_events.rb +1 -1
  159. data/lib/ory-client/models/get_project_events_body.rb +1 -1
  160. data/lib/ory-client/models/get_project_metrics.rb +1 -1
  161. data/lib/ory-client/models/get_session_activity.rb +1 -1
  162. data/lib/ory-client/models/get_version200_response.rb +1 -1
  163. data/lib/ory-client/models/health_not_ready_status.rb +1 -1
  164. data/lib/ory-client/models/health_status.rb +1 -1
  165. data/lib/ory-client/models/identity.rb +2 -2
  166. data/lib/ory-client/models/identity_credentials.rb +1 -1
  167. data/lib/ory-client/models/identity_credentials_code.rb +1 -1
  168. data/lib/ory-client/models/identity_credentials_code_address.rb +1 -1
  169. data/lib/ory-client/models/identity_credentials_lookup_secret_code.rb +158 -0
  170. data/lib/ory-client/models/identity_credentials_oidc.rb +1 -1
  171. data/lib/ory-client/models/identity_credentials_oidc_provider.rb +1 -1
  172. data/lib/ory-client/models/identity_credentials_password.rb +1 -1
  173. data/lib/ory-client/models/identity_credentials_web_authn.rb +234 -0
  174. data/lib/ory-client/models/identity_credentials_web_authn_attestation.rb +191 -0
  175. data/lib/ory-client/models/identity_credentials_web_authn_authenticator.rb +167 -0
  176. data/lib/ory-client/models/identity_credentials_web_authn_flags.rb +174 -0
  177. data/lib/ory-client/models/identity_patch.rb +1 -1
  178. data/lib/ory-client/models/identity_patch_response.rb +2 -1
  179. data/lib/ory-client/models/identity_schema_container.rb +1 -1
  180. data/lib/ory-client/models/identity_schema_preset.rb +1 -1
  181. data/lib/ory-client/models/identity_with_credentials.rb +41 -5
  182. data/lib/ory-client/models/identity_with_credentials_oidc.rb +1 -1
  183. data/lib/ory-client/models/identity_with_credentials_oidc_config.rb +1 -1
  184. data/lib/ory-client/models/identity_with_credentials_oidc_config_provider.rb +1 -1
  185. data/lib/ory-client/models/identity_with_credentials_passkey.rb +148 -0
  186. data/lib/ory-client/models/identity_with_credentials_passkey_config.rb +162 -0
  187. data/lib/ory-client/models/identity_with_credentials_password.rb +1 -1
  188. data/lib/ory-client/models/identity_with_credentials_password_config.rb +2 -2
  189. data/lib/ory-client/models/identity_with_credentials_saml.rb +1 -1
  190. data/lib/ory-client/models/identity_with_credentials_saml_config.rb +1 -1
  191. data/lib/ory-client/models/identity_with_credentials_saml_config_provider.rb +1 -1
  192. data/lib/ory-client/models/identity_with_credentials_totp.rb +148 -0
  193. data/lib/ory-client/models/identity_with_credentials_totp_config.rb +149 -0
  194. data/lib/ory-client/models/identity_with_credentials_web_authn.rb +148 -0
  195. data/lib/ory-client/models/identity_with_credentials_web_authn_config.rb +162 -0
  196. data/lib/ory-client/models/internal_get_project_branding_body.rb +1 -1
  197. data/lib/ory-client/models/internal_is_ax_welcome_screen_enabled_for_project_body.rb +1 -1
  198. data/lib/ory-client/models/internal_is_owner_for_project_by_slug.rb +1 -1
  199. data/lib/ory-client/models/internal_is_owner_for_project_by_slug_body.rb +1 -1
  200. data/lib/ory-client/models/introspected_o_auth2_token.rb +1 -1
  201. data/lib/ory-client/models/invite_token_body.rb +1 -1
  202. data/lib/ory-client/models/invoice.rb +1 -1
  203. data/lib/ory-client/models/invoice_data_v1.rb +1 -1
  204. data/lib/ory-client/models/is_owner_for_project_by_slug.rb +1 -1
  205. data/lib/ory-client/models/json_patch.rb +1 -1
  206. data/lib/ory-client/models/json_web_key.rb +1 -1
  207. data/lib/ory-client/models/json_web_key_set.rb +1 -1
  208. data/lib/ory-client/models/keto_namespace.rb +1 -1
  209. data/lib/ory-client/models/keyset_pagination_request_parameters.rb +4 -4
  210. data/lib/ory-client/models/keyset_pagination_response_headers.rb +2 -2
  211. data/lib/ory-client/models/line_item_v1.rb +1 -1
  212. data/lib/ory-client/models/list_event_streams.rb +1 -1
  213. data/lib/ory-client/models/list_invoices_response.rb +1 -1
  214. data/lib/ory-client/models/list_organizations_response.rb +1 -1
  215. data/lib/ory-client/models/list_workspace_projects.rb +1 -1
  216. data/lib/ory-client/models/list_workspaces.rb +1 -1
  217. data/lib/ory-client/models/login_flow.rb +1 -1
  218. data/lib/ory-client/models/login_flow_state.rb +1 -1
  219. data/lib/ory-client/models/logout_flow.rb +1 -1
  220. data/lib/ory-client/models/managed_identity_schema.rb +1 -1
  221. data/lib/ory-client/models/managed_identity_schema_validation_result.rb +1 -1
  222. data/lib/ory-client/models/member_invite.rb +1 -1
  223. data/lib/ory-client/models/message.rb +1 -1
  224. data/lib/ory-client/models/message_dispatch.rb +1 -1
  225. data/lib/ory-client/models/metrics_datapoint.rb +1 -1
  226. data/lib/ory-client/models/money.rb +1 -1
  227. data/lib/ory-client/models/namespace.rb +1 -1
  228. data/lib/ory-client/models/needs_privileged_session_error.rb +1 -1
  229. data/lib/ory-client/models/normalized_project.rb +11 -1
  230. data/lib/ory-client/models/normalized_project_revision.rb +113 -85
  231. data/lib/ory-client/models/normalized_project_revision_courier_channel.rb +1 -1
  232. data/lib/ory-client/models/normalized_project_revision_hook.rb +1 -1
  233. data/lib/ory-client/models/normalized_project_revision_identity_schema.rb +1 -1
  234. data/lib/ory-client/models/normalized_project_revision_saml_provider.rb +2 -1
  235. data/lib/ory-client/models/normalized_project_revision_scim_client.rb +1 -1
  236. data/lib/ory-client/models/normalized_project_revision_third_party_provider.rb +3 -1
  237. data/lib/ory-client/models/normalized_project_revision_tokenizer_template.rb +1 -1
  238. data/lib/ory-client/models/o_auth2_client.rb +10 -2
  239. data/lib/ory-client/models/o_auth2_client_token_lifespans.rb +1 -1
  240. data/lib/ory-client/models/o_auth2_consent_request.rb +4 -1
  241. data/lib/ory-client/models/o_auth2_consent_request_open_id_connect_context.rb +1 -1
  242. data/lib/ory-client/models/o_auth2_consent_session.rb +3 -1
  243. data/lib/ory-client/models/o_auth2_login_request.rb +3 -1
  244. data/lib/ory-client/models/o_auth2_logout_request.rb +1 -1
  245. data/lib/ory-client/models/o_auth2_redirect_to.rb +1 -1
  246. data/lib/ory-client/models/o_auth2_token_exchange.rb +1 -1
  247. data/lib/ory-client/models/oidc_configuration.rb +1 -1
  248. data/lib/ory-client/models/oidc_user_info.rb +1 -1
  249. data/lib/ory-client/models/onboarding_portal_link.rb +1 -1
  250. data/lib/ory-client/models/onboarding_portal_organization.rb +1 -1
  251. data/lib/ory-client/models/organization.rb +2 -1
  252. data/lib/ory-client/models/organization_body.rb +1 -1
  253. data/lib/ory-client/models/organization_onboarding_portal_links_response.rb +1 -1
  254. data/lib/ory-client/models/parse_error.rb +1 -1
  255. data/lib/ory-client/models/patch_identities_body.rb +1 -1
  256. data/lib/ory-client/models/patch_workspace_member_body.rb +148 -0
  257. data/lib/ory-client/models/perform_native_logout_body.rb +1 -1
  258. data/lib/ory-client/models/permissions_on_workspace.rb +1 -1
  259. data/lib/ory-client/models/plan.rb +1 -1
  260. data/lib/ory-client/models/plan_details.rb +1 -1
  261. data/lib/ory-client/models/post_check_permission_body.rb +1 -1
  262. data/lib/ory-client/models/post_check_permission_or_error_body.rb +1 -1
  263. data/lib/ory-client/models/project.rb +1 -1
  264. data/lib/ory-client/models/project_api_key.rb +1 -1
  265. data/lib/ory-client/models/project_branding.rb +1 -1
  266. data/lib/ory-client/models/project_branding_colors.rb +1 -1
  267. data/lib/ory-client/models/project_branding_theme.rb +1 -1
  268. data/lib/ory-client/models/project_cors.rb +1 -1
  269. data/lib/ory-client/models/project_events_datapoint.rb +1 -1
  270. data/lib/ory-client/models/project_host.rb +1 -1
  271. data/lib/ory-client/models/project_member.rb +59 -5
  272. data/lib/ory-client/models/project_metadata.rb +2 -1
  273. data/lib/ory-client/models/project_service_account_experience.rb +1 -1
  274. data/lib/ory-client/models/project_service_identity.rb +1 -1
  275. data/lib/ory-client/models/project_service_o_auth2.rb +1 -1
  276. data/lib/ory-client/models/project_service_permission.rb +1 -1
  277. data/lib/ory-client/models/project_services.rb +1 -1
  278. data/lib/ory-client/models/provider.rb +1 -1
  279. data/lib/ory-client/models/quota_usage.rb +4 -4
  280. data/lib/ory-client/models/recovery_code_for_identity.rb +1 -1
  281. data/lib/ory-client/models/recovery_flow.rb +1 -1
  282. data/lib/ory-client/models/recovery_flow_state.rb +1 -1
  283. data/lib/ory-client/models/recovery_identity_address.rb +12 -2
  284. data/lib/ory-client/models/recovery_link_for_identity.rb +1 -1
  285. data/lib/ory-client/models/registration_flow.rb +1 -1
  286. data/lib/ory-client/models/registration_flow_state.rb +1 -1
  287. data/lib/ory-client/models/reject_o_auth2_request.rb +1 -1
  288. data/lib/ory-client/models/relation_query.rb +1 -1
  289. data/lib/ory-client/models/relationship.rb +1 -1
  290. data/lib/ory-client/models/relationship_namespaces.rb +1 -1
  291. data/lib/ory-client/models/relationship_patch.rb +1 -1
  292. data/lib/ory-client/models/relationships.rb +1 -1
  293. data/lib/ory-client/models/revision_account_experience_custom_translation.rb +1 -1
  294. data/lib/ory-client/models/rfc6749_error_json.rb +1 -1
  295. data/lib/ory-client/models/schema_patch.rb +1 -1
  296. data/lib/ory-client/models/self_service_flow_expired_error.rb +1 -1
  297. data/lib/ory-client/models/session.rb +1 -1
  298. data/lib/ory-client/models/session_activity_datapoint.rb +1 -1
  299. data/lib/ory-client/models/session_authentication_method.rb +1 -1
  300. data/lib/ory-client/models/session_device.rb +1 -1
  301. data/lib/ory-client/models/set_custom_domain_body.rb +1 -1
  302. data/lib/ory-client/models/set_event_stream_body.rb +1 -1
  303. data/lib/ory-client/models/set_organization_from_onboarding_portal_link_body.rb +1 -1
  304. data/lib/ory-client/models/set_project.rb +1 -1
  305. data/lib/ory-client/models/set_project_branding_theme_body.rb +1 -1
  306. data/lib/ory-client/models/settings_flow.rb +1 -1
  307. data/lib/ory-client/models/settings_flow_state.rb +1 -1
  308. data/lib/ory-client/models/source_position.rb +1 -1
  309. data/lib/ory-client/models/subject_set.rb +1 -1
  310. data/lib/ory-client/models/subscription.rb +1 -1
  311. data/lib/ory-client/models/successful_code_exchange_response.rb +1 -1
  312. data/lib/ory-client/models/successful_native_login.rb +1 -1
  313. data/lib/ory-client/models/successful_native_registration.rb +1 -1
  314. data/lib/ory-client/models/successful_project_update.rb +1 -1
  315. data/lib/ory-client/models/tax_line_item.rb +1 -1
  316. data/lib/ory-client/models/time_interval.rb +1 -1
  317. data/lib/ory-client/models/token_pagination.rb +3 -3
  318. data/lib/ory-client/models/token_pagination_headers.rb +2 -2
  319. data/lib/ory-client/models/token_pagination_request_parameters.rb +4 -4
  320. data/lib/ory-client/models/token_pagination_response_headers.rb +2 -2
  321. data/lib/ory-client/models/trust_o_auth2_jwt_grant_issuer.rb +1 -1
  322. data/lib/ory-client/models/trusted_o_auth2_jwt_grant_issuer.rb +1 -1
  323. data/lib/ory-client/models/trusted_o_auth2_jwt_grant_json_web_key.rb +1 -1
  324. data/lib/ory-client/models/ui_container.rb +1 -1
  325. data/lib/ory-client/models/ui_node.rb +1 -1
  326. data/lib/ory-client/models/ui_node_anchor_attributes.rb +1 -1
  327. data/lib/ory-client/models/ui_node_attributes.rb +1 -1
  328. data/lib/ory-client/models/ui_node_division_attributes.rb +1 -1
  329. data/lib/ory-client/models/ui_node_image_attributes.rb +1 -1
  330. data/lib/ory-client/models/ui_node_input_attributes.rb +14 -2
  331. data/lib/ory-client/models/ui_node_input_attributes_option.rb +152 -0
  332. data/lib/ory-client/models/ui_node_meta.rb +1 -1
  333. data/lib/ory-client/models/ui_node_script_attributes.rb +1 -1
  334. data/lib/ory-client/models/ui_node_text_attributes.rb +1 -1
  335. data/lib/ory-client/models/ui_text.rb +1 -1
  336. data/lib/ory-client/models/update_fedcm_flow_body.rb +1 -1
  337. data/lib/ory-client/models/update_identity_body.rb +1 -1
  338. data/lib/ory-client/models/update_login_flow_body.rb +1 -1
  339. data/lib/ory-client/models/update_login_flow_with_code_method.rb +1 -1
  340. data/lib/ory-client/models/update_login_flow_with_identifier_first_method.rb +1 -1
  341. data/lib/ory-client/models/update_login_flow_with_lookup_secret_method.rb +1 -1
  342. data/lib/ory-client/models/update_login_flow_with_oidc_method.rb +1 -1
  343. data/lib/ory-client/models/update_login_flow_with_passkey_method.rb +1 -1
  344. data/lib/ory-client/models/update_login_flow_with_password_method.rb +1 -1
  345. data/lib/ory-client/models/update_login_flow_with_saml_method.rb +1 -1
  346. data/lib/ory-client/models/update_login_flow_with_totp_method.rb +1 -1
  347. data/lib/ory-client/models/update_login_flow_with_web_authn_method.rb +1 -1
  348. data/lib/ory-client/models/update_organization_onboarding_portal_link_body.rb +1 -1
  349. data/lib/ory-client/models/update_recovery_flow_body.rb +1 -1
  350. data/lib/ory-client/models/update_recovery_flow_with_code_method.rb +2 -2
  351. data/lib/ory-client/models/update_recovery_flow_with_link_method.rb +1 -1
  352. data/lib/ory-client/models/update_registration_flow_body.rb +1 -1
  353. data/lib/ory-client/models/update_registration_flow_with_code_method.rb +1 -1
  354. data/lib/ory-client/models/update_registration_flow_with_oidc_method.rb +1 -1
  355. data/lib/ory-client/models/update_registration_flow_with_passkey_method.rb +1 -1
  356. data/lib/ory-client/models/update_registration_flow_with_password_method.rb +1 -1
  357. data/lib/ory-client/models/update_registration_flow_with_profile_method.rb +1 -1
  358. data/lib/ory-client/models/update_registration_flow_with_saml_method.rb +1 -1
  359. data/lib/ory-client/models/update_registration_flow_with_web_authn_method.rb +1 -1
  360. data/lib/ory-client/models/update_settings_flow_body.rb +1 -1
  361. data/lib/ory-client/models/update_settings_flow_with_lookup_method.rb +1 -1
  362. data/lib/ory-client/models/update_settings_flow_with_oidc_method.rb +1 -1
  363. data/lib/ory-client/models/update_settings_flow_with_passkey_method.rb +1 -1
  364. data/lib/ory-client/models/update_settings_flow_with_password_method.rb +1 -1
  365. data/lib/ory-client/models/update_settings_flow_with_profile_method.rb +1 -1
  366. data/lib/ory-client/models/update_settings_flow_with_saml_method.rb +1 -1
  367. data/lib/ory-client/models/update_settings_flow_with_totp_method.rb +1 -1
  368. data/lib/ory-client/models/update_settings_flow_with_web_authn_method.rb +1 -1
  369. data/lib/ory-client/models/update_subscription_body.rb +1 -1
  370. data/lib/ory-client/models/update_verification_flow_body.rb +1 -1
  371. data/lib/ory-client/models/update_verification_flow_with_code_method.rb +2 -2
  372. data/lib/ory-client/models/update_verification_flow_with_link_method.rb +1 -1
  373. data/lib/ory-client/models/update_workspace_body.rb +1 -1
  374. data/lib/ory-client/models/usage.rb +1 -1
  375. data/lib/ory-client/models/verifiable_credential_priming_response.rb +1 -1
  376. data/lib/ory-client/models/verifiable_credential_proof.rb +1 -1
  377. data/lib/ory-client/models/verifiable_credential_response.rb +1 -1
  378. data/lib/ory-client/models/verifiable_identity_address.rb +1 -1
  379. data/lib/ory-client/models/verification_flow.rb +2 -2
  380. data/lib/ory-client/models/verification_flow_state.rb +1 -1
  381. data/lib/ory-client/models/verify_user_code_request.rb +3 -1
  382. data/lib/ory-client/models/version.rb +1 -1
  383. data/lib/ory-client/models/warning.rb +1 -1
  384. data/lib/ory-client/models/workspace.rb +1 -1
  385. data/lib/ory-client/models/workspace_api_key.rb +1 -1
  386. data/lib/ory-client/models/workspace_organization.rb +2 -1
  387. data/lib/ory-client/version.rb +2 -2
  388. data/lib/ory-client.rb +16 -1
  389. data/ory-client.gemspec +1 -1
  390. data/spec/api/courier_api_spec.rb +3 -3
  391. data/spec/api/events_api_spec.rb +1 -1
  392. data/spec/api/frontend_api_spec.rb +19 -18
  393. data/spec/api/identity_api_spec.rb +20 -20
  394. data/spec/api/jwk_api_spec.rb +1 -1
  395. data/spec/api/metadata_api_spec.rb +1 -1
  396. data/spec/api/o_auth2_api_spec.rb +7 -7
  397. data/spec/api/oidc_api_spec.rb +1 -1
  398. data/spec/api/permission_api_spec.rb +6 -6
  399. data/spec/api/project_api_spec.rb +3 -3
  400. data/spec/api/relationship_api_spec.rb +3 -3
  401. data/spec/api/wellknown_api_spec.rb +1 -1
  402. data/spec/api/workspace_api_spec.rb +3 -3
  403. data/spec/models/accept_device_user_code_request_spec.rb +1 -1
  404. data/spec/models/accept_o_auth2_consent_request_session_spec.rb +1 -1
  405. data/spec/models/accept_o_auth2_consent_request_spec.rb +1 -1
  406. data/spec/models/accept_o_auth2_login_request_spec.rb +1 -1
  407. data/spec/models/account_experience_colors_spec.rb +1 -1
  408. data/spec/models/account_experience_configuration_spec.rb +1 -1
  409. data/spec/models/add_project_to_workspace_body_spec.rb +1 -1
  410. data/spec/models/admin_identity_import_credentials_lookup_secret_config_spec.rb +36 -0
  411. data/spec/models/admin_identity_import_credentials_lookup_secret_spec.rb +36 -0
  412. data/spec/models/attribute_filter_spec.rb +1 -1
  413. data/spec/models/attribute_spec.rb +1 -1
  414. data/spec/models/attributes_count_datapoint_spec.rb +1 -1
  415. data/spec/models/authenticator_assurance_level_spec.rb +1 -1
  416. data/spec/models/basic_organization_spec.rb +1 -1
  417. data/spec/models/batch_check_permission_body_spec.rb +1 -1
  418. data/spec/models/batch_check_permission_result_spec.rb +1 -1
  419. data/spec/models/batch_patch_identities_response_spec.rb +1 -1
  420. data/spec/models/billing_period_bucket_spec.rb +1 -1
  421. data/spec/models/check_opl_syntax_result_spec.rb +1 -1
  422. data/spec/models/check_permission_result_spec.rb +1 -1
  423. data/spec/models/check_permission_result_with_error_spec.rb +1 -1
  424. data/spec/models/cloud_account_spec.rb +7 -1
  425. data/spec/models/consistency_request_parameters_spec.rb +1 -1
  426. data/spec/models/continue_with_recovery_ui_flow_spec.rb +1 -1
  427. data/spec/models/continue_with_recovery_ui_spec.rb +1 -1
  428. data/spec/models/continue_with_redirect_browser_to_spec.rb +1 -1
  429. data/spec/models/continue_with_set_ory_session_token_spec.rb +1 -1
  430. data/spec/models/continue_with_settings_ui_flow_spec.rb +1 -1
  431. data/spec/models/continue_with_settings_ui_spec.rb +1 -1
  432. data/spec/models/continue_with_spec.rb +1 -1
  433. data/spec/models/continue_with_verification_ui_flow_spec.rb +1 -1
  434. data/spec/models/continue_with_verification_ui_spec.rb +1 -1
  435. data/spec/models/courier_message_status_spec.rb +1 -1
  436. data/spec/models/courier_message_type_spec.rb +1 -1
  437. data/spec/models/create_custom_domain_body_spec.rb +1 -1
  438. data/spec/models/create_event_stream_body_spec.rb +1 -1
  439. data/spec/models/create_fedcm_flow_response_spec.rb +1 -1
  440. data/spec/models/create_identity_body_spec.rb +1 -1
  441. data/spec/models/create_invite_response_spec.rb +1 -1
  442. data/spec/models/create_json_web_key_set_spec.rb +1 -1
  443. data/spec/models/create_onboarding_link_response_spec.rb +1 -1
  444. data/spec/models/create_organization_onboarding_portal_link_body_spec.rb +1 -1
  445. data/spec/models/create_project_api_key_request_spec.rb +1 -1
  446. data/spec/models/create_project_body_spec.rb +1 -1
  447. data/spec/models/create_project_branding_spec.rb +1 -1
  448. data/spec/models/create_project_member_invite_body_spec.rb +1 -1
  449. data/spec/models/create_project_normalized_payload_spec.rb +7 -1
  450. data/spec/models/create_recovery_code_for_identity_body_spec.rb +1 -1
  451. data/spec/models/create_recovery_link_for_identity_body_spec.rb +1 -1
  452. data/spec/models/create_relationship_body_spec.rb +1 -1
  453. data/spec/models/create_subscription_body_spec.rb +1 -1
  454. data/spec/models/create_subscription_common_spec.rb +1 -1
  455. data/spec/models/create_verifiable_credential_request_body_spec.rb +1 -1
  456. data/spec/models/create_workspace_api_key_body_spec.rb +1 -1
  457. data/spec/models/create_workspace_body_spec.rb +1 -1
  458. data/spec/models/create_workspace_member_invite_body_spec.rb +1 -1
  459. data/spec/models/create_workspace_organization_body_spec.rb +1 -1
  460. data/spec/models/create_workspace_subscription_body_spec.rb +1 -1
  461. data/spec/models/credential_supported_draft00_spec.rb +1 -1
  462. data/spec/models/custom_domain_spec.rb +1 -1
  463. data/spec/models/delete_my_sessions_count_spec.rb +1 -1
  464. data/spec/models/device_authorization_spec.rb +1 -1
  465. data/spec/models/device_user_auth_request_spec.rb +1 -1
  466. data/spec/models/email_template_data_body_spec.rb +1 -1
  467. data/spec/models/email_template_data_spec.rb +1 -1
  468. data/spec/models/error_authenticator_assurance_level_not_satisfied_spec.rb +1 -1
  469. data/spec/models/error_browser_location_change_required_spec.rb +1 -1
  470. data/spec/models/error_flow_replaced_spec.rb +1 -1
  471. data/spec/models/error_generic_spec.rb +1 -1
  472. data/spec/models/error_o_auth2_spec.rb +1 -1
  473. data/spec/models/event_stream_spec.rb +1 -1
  474. data/spec/models/expanded_permission_tree_spec.rb +1 -1
  475. data/spec/models/flow_error_spec.rb +1 -1
  476. data/spec/models/generic_error_content_spec.rb +1 -1
  477. data/spec/models/generic_error_spec.rb +1 -1
  478. data/spec/models/generic_oidc_provider_spec.rb +1 -1
  479. data/spec/models/generic_usage_spec.rb +1 -1
  480. data/spec/models/get_attributes_count_spec.rb +1 -1
  481. data/spec/models/get_managed_identity_schema_location_spec.rb +1 -1
  482. data/spec/models/get_metrics_count_spec.rb +1 -1
  483. data/spec/models/get_metrics_event_attributes_spec.rb +1 -1
  484. data/spec/models/get_metrics_event_types_spec.rb +1 -1
  485. data/spec/models/get_organization_response_spec.rb +1 -1
  486. data/spec/models/get_project_events_body_spec.rb +1 -1
  487. data/spec/models/get_project_events_spec.rb +1 -1
  488. data/spec/models/get_project_metrics_spec.rb +1 -1
  489. data/spec/models/get_session_activity_spec.rb +1 -1
  490. data/spec/models/get_version200_response_spec.rb +1 -1
  491. data/spec/models/health_not_ready_status_spec.rb +1 -1
  492. data/spec/models/health_status_spec.rb +1 -1
  493. data/spec/models/identity_credentials_code_address_spec.rb +1 -1
  494. data/spec/models/identity_credentials_code_spec.rb +1 -1
  495. data/spec/models/identity_credentials_lookup_secret_code_spec.rb +42 -0
  496. data/spec/models/identity_credentials_oidc_provider_spec.rb +1 -1
  497. data/spec/models/identity_credentials_oidc_spec.rb +1 -1
  498. data/spec/models/identity_credentials_password_spec.rb +1 -1
  499. data/spec/models/identity_credentials_spec.rb +1 -1
  500. data/spec/models/identity_credentials_web_authn_attestation_spec.rb +60 -0
  501. data/spec/models/identity_credentials_web_authn_authenticator_spec.rb +48 -0
  502. data/spec/models/identity_credentials_web_authn_flags_spec.rb +54 -0
  503. data/spec/models/identity_credentials_web_authn_spec.rb +90 -0
  504. data/spec/models/identity_patch_response_spec.rb +1 -1
  505. data/spec/models/identity_patch_spec.rb +1 -1
  506. data/spec/models/identity_schema_container_spec.rb +1 -1
  507. data/spec/models/identity_schema_preset_spec.rb +1 -1
  508. data/spec/models/identity_spec.rb +1 -1
  509. data/spec/models/identity_with_credentials_oidc_config_provider_spec.rb +1 -1
  510. data/spec/models/identity_with_credentials_oidc_config_spec.rb +1 -1
  511. data/spec/models/identity_with_credentials_oidc_spec.rb +1 -1
  512. data/spec/models/identity_with_credentials_passkey_config_spec.rb +42 -0
  513. data/spec/models/identity_with_credentials_passkey_spec.rb +36 -0
  514. data/spec/models/identity_with_credentials_password_config_spec.rb +1 -1
  515. data/spec/models/identity_with_credentials_password_spec.rb +1 -1
  516. data/spec/models/identity_with_credentials_saml_config_provider_spec.rb +1 -1
  517. data/spec/models/identity_with_credentials_saml_config_spec.rb +1 -1
  518. data/spec/models/identity_with_credentials_saml_spec.rb +1 -1
  519. data/spec/models/identity_with_credentials_spec.rb +25 -1
  520. data/spec/models/identity_with_credentials_totp_config_spec.rb +36 -0
  521. data/spec/models/identity_with_credentials_totp_spec.rb +36 -0
  522. data/spec/models/identity_with_credentials_web_authn_config_spec.rb +42 -0
  523. data/spec/models/identity_with_credentials_web_authn_spec.rb +36 -0
  524. data/spec/models/internal_get_project_branding_body_spec.rb +1 -1
  525. data/spec/models/internal_is_ax_welcome_screen_enabled_for_project_body_spec.rb +1 -1
  526. data/spec/models/internal_is_owner_for_project_by_slug_body_spec.rb +1 -1
  527. data/spec/models/internal_is_owner_for_project_by_slug_spec.rb +1 -1
  528. data/spec/models/introspected_o_auth2_token_spec.rb +1 -1
  529. data/spec/models/invite_token_body_spec.rb +1 -1
  530. data/spec/models/invoice_data_v1_spec.rb +1 -1
  531. data/spec/models/invoice_spec.rb +1 -1
  532. data/spec/models/is_owner_for_project_by_slug_spec.rb +1 -1
  533. data/spec/models/json_patch_spec.rb +1 -1
  534. data/spec/models/json_web_key_set_spec.rb +1 -1
  535. data/spec/models/json_web_key_spec.rb +1 -1
  536. data/spec/models/keto_namespace_spec.rb +1 -1
  537. data/spec/models/keyset_pagination_request_parameters_spec.rb +1 -1
  538. data/spec/models/keyset_pagination_response_headers_spec.rb +1 -1
  539. data/spec/models/line_item_v1_spec.rb +1 -1
  540. data/spec/models/list_event_streams_spec.rb +1 -1
  541. data/spec/models/list_invoices_response_spec.rb +1 -1
  542. data/spec/models/list_organizations_response_spec.rb +1 -1
  543. data/spec/models/list_workspace_projects_spec.rb +1 -1
  544. data/spec/models/list_workspaces_spec.rb +1 -1
  545. data/spec/models/login_flow_spec.rb +1 -1
  546. data/spec/models/login_flow_state_spec.rb +1 -1
  547. data/spec/models/logout_flow_spec.rb +1 -1
  548. data/spec/models/managed_identity_schema_spec.rb +1 -1
  549. data/spec/models/managed_identity_schema_validation_result_spec.rb +1 -1
  550. data/spec/models/member_invite_spec.rb +1 -1
  551. data/spec/models/message_dispatch_spec.rb +1 -1
  552. data/spec/models/message_spec.rb +1 -1
  553. data/spec/models/metrics_datapoint_spec.rb +1 -1
  554. data/spec/models/money_spec.rb +1 -1
  555. data/spec/models/namespace_spec.rb +1 -1
  556. data/spec/models/needs_privileged_session_error_spec.rb +1 -1
  557. data/spec/models/normalized_project_revision_courier_channel_spec.rb +1 -1
  558. data/spec/models/normalized_project_revision_hook_spec.rb +1 -1
  559. data/spec/models/normalized_project_revision_identity_schema_spec.rb +1 -1
  560. data/spec/models/normalized_project_revision_saml_provider_spec.rb +1 -1
  561. data/spec/models/normalized_project_revision_scim_client_spec.rb +1 -1
  562. data/spec/models/normalized_project_revision_spec.rb +7 -1
  563. data/spec/models/normalized_project_revision_third_party_provider_spec.rb +1 -1
  564. data/spec/models/normalized_project_revision_tokenizer_template_spec.rb +1 -1
  565. data/spec/models/normalized_project_spec.rb +1 -1
  566. data/spec/models/o_auth2_client_spec.rb +1 -1
  567. data/spec/models/o_auth2_client_token_lifespans_spec.rb +1 -1
  568. data/spec/models/o_auth2_consent_request_open_id_connect_context_spec.rb +1 -1
  569. data/spec/models/o_auth2_consent_request_spec.rb +1 -1
  570. data/spec/models/o_auth2_consent_session_spec.rb +1 -1
  571. data/spec/models/o_auth2_login_request_spec.rb +1 -1
  572. data/spec/models/o_auth2_logout_request_spec.rb +1 -1
  573. data/spec/models/o_auth2_redirect_to_spec.rb +1 -1
  574. data/spec/models/o_auth2_token_exchange_spec.rb +1 -1
  575. data/spec/models/oidc_configuration_spec.rb +1 -1
  576. data/spec/models/oidc_user_info_spec.rb +1 -1
  577. data/spec/models/onboarding_portal_link_spec.rb +1 -1
  578. data/spec/models/onboarding_portal_organization_spec.rb +1 -1
  579. data/spec/models/organization_body_spec.rb +1 -1
  580. data/spec/models/organization_onboarding_portal_links_response_spec.rb +1 -1
  581. data/spec/models/organization_spec.rb +1 -1
  582. data/spec/models/parse_error_spec.rb +1 -1
  583. data/spec/models/patch_identities_body_spec.rb +1 -1
  584. data/spec/models/patch_workspace_member_body_spec.rb +36 -0
  585. data/spec/models/perform_native_logout_body_spec.rb +1 -1
  586. data/spec/models/permissions_on_workspace_spec.rb +1 -1
  587. data/spec/models/plan_details_spec.rb +1 -1
  588. data/spec/models/plan_spec.rb +1 -1
  589. data/spec/models/post_check_permission_body_spec.rb +1 -1
  590. data/spec/models/post_check_permission_or_error_body_spec.rb +1 -1
  591. data/spec/models/project_api_key_spec.rb +1 -1
  592. data/spec/models/project_branding_colors_spec.rb +1 -1
  593. data/spec/models/project_branding_spec.rb +1 -1
  594. data/spec/models/project_branding_theme_spec.rb +1 -1
  595. data/spec/models/project_cors_spec.rb +1 -1
  596. data/spec/models/project_events_datapoint_spec.rb +1 -1
  597. data/spec/models/project_host_spec.rb +1 -1
  598. data/spec/models/project_member_spec.rb +17 -1
  599. data/spec/models/project_metadata_spec.rb +1 -1
  600. data/spec/models/project_service_account_experience_spec.rb +1 -1
  601. data/spec/models/project_service_identity_spec.rb +1 -1
  602. data/spec/models/project_service_o_auth2_spec.rb +1 -1
  603. data/spec/models/project_service_permission_spec.rb +1 -1
  604. data/spec/models/project_services_spec.rb +1 -1
  605. data/spec/models/project_spec.rb +1 -1
  606. data/spec/models/provider_spec.rb +1 -1
  607. data/spec/models/quota_usage_spec.rb +2 -2
  608. data/spec/models/recovery_code_for_identity_spec.rb +1 -1
  609. data/spec/models/recovery_flow_spec.rb +1 -1
  610. data/spec/models/recovery_flow_state_spec.rb +1 -1
  611. data/spec/models/recovery_identity_address_spec.rb +7 -1
  612. data/spec/models/recovery_link_for_identity_spec.rb +1 -1
  613. data/spec/models/registration_flow_spec.rb +1 -1
  614. data/spec/models/registration_flow_state_spec.rb +1 -1
  615. data/spec/models/reject_o_auth2_request_spec.rb +1 -1
  616. data/spec/models/relation_query_spec.rb +1 -1
  617. data/spec/models/relationship_namespaces_spec.rb +1 -1
  618. data/spec/models/relationship_patch_spec.rb +1 -1
  619. data/spec/models/relationship_spec.rb +1 -1
  620. data/spec/models/relationships_spec.rb +1 -1
  621. data/spec/models/revision_account_experience_custom_translation_spec.rb +1 -1
  622. data/spec/models/rfc6749_error_json_spec.rb +1 -1
  623. data/spec/models/schema_patch_spec.rb +1 -1
  624. data/spec/models/self_service_flow_expired_error_spec.rb +1 -1
  625. data/spec/models/session_activity_datapoint_spec.rb +1 -1
  626. data/spec/models/session_authentication_method_spec.rb +1 -1
  627. data/spec/models/session_device_spec.rb +1 -1
  628. data/spec/models/session_spec.rb +1 -1
  629. data/spec/models/set_custom_domain_body_spec.rb +1 -1
  630. data/spec/models/set_event_stream_body_spec.rb +1 -1
  631. data/spec/models/set_organization_from_onboarding_portal_link_body_spec.rb +1 -1
  632. data/spec/models/set_project_branding_theme_body_spec.rb +1 -1
  633. data/spec/models/set_project_spec.rb +1 -1
  634. data/spec/models/settings_flow_spec.rb +1 -1
  635. data/spec/models/settings_flow_state_spec.rb +1 -1
  636. data/spec/models/source_position_spec.rb +1 -1
  637. data/spec/models/subject_set_spec.rb +1 -1
  638. data/spec/models/subscription_spec.rb +1 -1
  639. data/spec/models/successful_code_exchange_response_spec.rb +1 -1
  640. data/spec/models/successful_native_login_spec.rb +1 -1
  641. data/spec/models/successful_native_registration_spec.rb +1 -1
  642. data/spec/models/successful_project_update_spec.rb +1 -1
  643. data/spec/models/tax_line_item_spec.rb +1 -1
  644. data/spec/models/time_interval_spec.rb +1 -1
  645. data/spec/models/token_pagination_headers_spec.rb +1 -1
  646. data/spec/models/token_pagination_request_parameters_spec.rb +1 -1
  647. data/spec/models/token_pagination_response_headers_spec.rb +1 -1
  648. data/spec/models/token_pagination_spec.rb +1 -1
  649. data/spec/models/trust_o_auth2_jwt_grant_issuer_spec.rb +1 -1
  650. data/spec/models/trusted_o_auth2_jwt_grant_issuer_spec.rb +1 -1
  651. data/spec/models/trusted_o_auth2_jwt_grant_json_web_key_spec.rb +1 -1
  652. data/spec/models/ui_container_spec.rb +1 -1
  653. data/spec/models/ui_node_anchor_attributes_spec.rb +1 -1
  654. data/spec/models/ui_node_attributes_spec.rb +1 -1
  655. data/spec/models/ui_node_division_attributes_spec.rb +1 -1
  656. data/spec/models/ui_node_image_attributes_spec.rb +1 -1
  657. data/spec/models/ui_node_input_attributes_option_spec.rb +36 -0
  658. data/spec/models/ui_node_input_attributes_spec.rb +7 -1
  659. data/spec/models/ui_node_meta_spec.rb +1 -1
  660. data/spec/models/ui_node_script_attributes_spec.rb +1 -1
  661. data/spec/models/ui_node_spec.rb +1 -1
  662. data/spec/models/ui_node_text_attributes_spec.rb +1 -1
  663. data/spec/models/ui_text_spec.rb +1 -1
  664. data/spec/models/update_fedcm_flow_body_spec.rb +1 -1
  665. data/spec/models/update_identity_body_spec.rb +1 -1
  666. data/spec/models/update_login_flow_body_spec.rb +1 -1
  667. data/spec/models/update_login_flow_with_code_method_spec.rb +1 -1
  668. data/spec/models/update_login_flow_with_identifier_first_method_spec.rb +1 -1
  669. data/spec/models/update_login_flow_with_lookup_secret_method_spec.rb +1 -1
  670. data/spec/models/update_login_flow_with_oidc_method_spec.rb +1 -1
  671. data/spec/models/update_login_flow_with_passkey_method_spec.rb +1 -1
  672. data/spec/models/update_login_flow_with_password_method_spec.rb +1 -1
  673. data/spec/models/update_login_flow_with_saml_method_spec.rb +1 -1
  674. data/spec/models/update_login_flow_with_totp_method_spec.rb +1 -1
  675. data/spec/models/update_login_flow_with_web_authn_method_spec.rb +1 -1
  676. data/spec/models/update_organization_onboarding_portal_link_body_spec.rb +1 -1
  677. data/spec/models/update_recovery_flow_body_spec.rb +1 -1
  678. data/spec/models/update_recovery_flow_with_code_method_spec.rb +1 -1
  679. data/spec/models/update_recovery_flow_with_link_method_spec.rb +1 -1
  680. data/spec/models/update_registration_flow_body_spec.rb +1 -1
  681. data/spec/models/update_registration_flow_with_code_method_spec.rb +1 -1
  682. data/spec/models/update_registration_flow_with_oidc_method_spec.rb +1 -1
  683. data/spec/models/update_registration_flow_with_passkey_method_spec.rb +1 -1
  684. data/spec/models/update_registration_flow_with_password_method_spec.rb +1 -1
  685. data/spec/models/update_registration_flow_with_profile_method_spec.rb +1 -1
  686. data/spec/models/update_registration_flow_with_saml_method_spec.rb +1 -1
  687. data/spec/models/update_registration_flow_with_web_authn_method_spec.rb +1 -1
  688. data/spec/models/update_settings_flow_body_spec.rb +1 -1
  689. data/spec/models/update_settings_flow_with_lookup_method_spec.rb +1 -1
  690. data/spec/models/update_settings_flow_with_oidc_method_spec.rb +1 -1
  691. data/spec/models/update_settings_flow_with_passkey_method_spec.rb +1 -1
  692. data/spec/models/update_settings_flow_with_password_method_spec.rb +1 -1
  693. data/spec/models/update_settings_flow_with_profile_method_spec.rb +1 -1
  694. data/spec/models/update_settings_flow_with_saml_method_spec.rb +1 -1
  695. data/spec/models/update_settings_flow_with_totp_method_spec.rb +1 -1
  696. data/spec/models/update_settings_flow_with_web_authn_method_spec.rb +1 -1
  697. data/spec/models/update_subscription_body_spec.rb +1 -1
  698. data/spec/models/update_verification_flow_body_spec.rb +1 -1
  699. data/spec/models/update_verification_flow_with_code_method_spec.rb +1 -1
  700. data/spec/models/update_verification_flow_with_link_method_spec.rb +1 -1
  701. data/spec/models/update_workspace_body_spec.rb +1 -1
  702. data/spec/models/usage_spec.rb +1 -1
  703. data/spec/models/verifiable_credential_priming_response_spec.rb +1 -1
  704. data/spec/models/verifiable_credential_proof_spec.rb +1 -1
  705. data/spec/models/verifiable_credential_response_spec.rb +1 -1
  706. data/spec/models/verifiable_identity_address_spec.rb +1 -1
  707. data/spec/models/verification_flow_spec.rb +1 -1
  708. data/spec/models/verification_flow_state_spec.rb +1 -1
  709. data/spec/models/verify_user_code_request_spec.rb +1 -1
  710. data/spec/models/version_spec.rb +1 -1
  711. data/spec/models/warning_spec.rb +1 -1
  712. data/spec/models/workspace_api_key_spec.rb +1 -1
  713. data/spec/models/workspace_organization_spec.rb +1 -1
  714. data/spec/models/workspace_spec.rb +1 -1
  715. data/spec/spec_helper.rb +1 -1
  716. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux-gnu/3.2.0/byebug-13.0.0/gem_make.out +5 -5
  717. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux-gnu/3.2.0/io-console-0.8.2/gem_make.out +5 -5
  718. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux-gnu/3.2.0/io-console-0.8.2/mkmf.log +3 -3
  719. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux-gnu/3.2.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  720. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux-gnu/3.2.0/psych-4.0.6/gem_make.out +5 -5
  721. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux-gnu/3.2.0/racc-1.8.1/gem_make.out +5 -5
  722. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux-gnu/3.2.0/stringio-3.2.0/gem_make.out +5 -5
  723. metadata +65 -5
data/lib/ory-client/api/courier_api.rb CHANGED
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Introduction 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. ## SDKs This document describes the APIs available in the Ory Network. The APIs are available as SDKs for the following languages: | Language | Download SDK | Documentation | | -------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | Dart | [pub.dev](https://pub.dev/packages/ory_client) | [README](https://github.com/ory/sdk/blob/master/clients/client/dart/README.md) | | .NET | [nuget.org](https://www.nuget.org/packages/Ory.Client/) | [README](https://github.com/ory/sdk/blob/master/clients/client/dotnet/README.md) | | Elixir | [hex.pm](https://hex.pm/packages/ory_client) | [README](https://github.com/ory/sdk/blob/master/clients/client/elixir/README.md) | | Go | [github.com](https://github.com/ory/client-go) | [README](https://github.com/ory/sdk/blob/master/clients/client/go/README.md) | | Java | [maven.org](https://search.maven.org/artifact/sh.ory/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/java/README.md) | | JavaScript | [npmjs.com](https://www.npmjs.com/package/@ory/client) | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript/README.md) | | JavaScript (With fetch) | [npmjs.com](https://www.npmjs.com/package/@ory/client-fetch) | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript-fetch/README.md) | | PHP | [packagist.org](https://packagist.org/packages/ory/client) | [README](https://github.com/ory/sdk/blob/master/clients/client/php/README.md) | | Python | [pypi.org](https://pypi.org/project/ory-client/) | [README](https://github.com/ory/sdk/blob/master/clients/client/python/README.md) | | Ruby | [rubygems.org](https://rubygems.org/gems/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/ruby/README.md) | | Rust | [crates.io](https://crates.io/crates/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/rust/README.md) |
5
5
 
6
- The version of the OpenAPI document: v1.22.34
6
+ The version of the OpenAPI document: v1.22.36
7
7
  Contact: support@ory.sh
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.17.0
@@ -85,8 +85,8 @@ module OryClient
85
85
  # List Messages
86
86
  # Lists all messages by given status and recipient.
87
87
  # @param [Hash] opts the optional parameters
88
- # @option opts [Integer] :page_size Items per Page This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). (default to 250)
89
- # @option opts [String] :page_token Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
88
+ # @option opts [Integer] :page_size Items per Page This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination). (default to 250)
89
+ # @option opts [String] :page_token Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination).
90
90
  # @option opts [CourierMessageStatus] :status Status filters out messages based on status. If no value is provided, it doesn't take effect on filter.
91
91
  # @option opts [String] :recipient Recipient filters out messages based on recipient. If no value is provided, it doesn't take effect on filter.
92
92
  # @return [Array<Message>]
@@ -98,8 +98,8 @@ module OryClient
98
98
  # List Messages
99
99
  # Lists all messages by given status and recipient.
100
100
  # @param [Hash] opts the optional parameters
101
- # @option opts [Integer] :page_size Items per Page This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). (default to 250)
102
- # @option opts [String] :page_token Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
101
+ # @option opts [Integer] :page_size Items per Page This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination). (default to 250)
102
+ # @option opts [String] :page_token Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination).
103
103
  # @option opts [CourierMessageStatus] :status Status filters out messages based on status. If no value is provided, it doesn&#39;t take effect on filter.
104
104
  # @option opts [String] :recipient Recipient filters out messages based on recipient. If no value is provided, it doesn&#39;t take effect on filter.
105
105
  # @return [Array<(Array<Message>, Integer, Hash)>] Array<Message> data, response status code and response headers
data/lib/ory-client/api/events_api.rb CHANGED
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Introduction 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. ## SDKs This document describes the APIs available in the Ory Network. The APIs are available as SDKs for the following languages: | Language | Download SDK | Documentation | | -------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | Dart | [pub.dev](https://pub.dev/packages/ory_client) | [README](https://github.com/ory/sdk/blob/master/clients/client/dart/README.md) | | .NET | [nuget.org](https://www.nuget.org/packages/Ory.Client/) | [README](https://github.com/ory/sdk/blob/master/clients/client/dotnet/README.md) | | Elixir | [hex.pm](https://hex.pm/packages/ory_client) | [README](https://github.com/ory/sdk/blob/master/clients/client/elixir/README.md) | | Go | [github.com](https://github.com/ory/client-go) | [README](https://github.com/ory/sdk/blob/master/clients/client/go/README.md) | | Java | [maven.org](https://search.maven.org/artifact/sh.ory/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/java/README.md) | | JavaScript | [npmjs.com](https://www.npmjs.com/package/@ory/client) | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript/README.md) | | JavaScript (With fetch) | [npmjs.com](https://www.npmjs.com/package/@ory/client-fetch) | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript-fetch/README.md) | | PHP | [packagist.org](https://packagist.org/packages/ory/client) | [README](https://github.com/ory/sdk/blob/master/clients/client/php/README.md) | | Python | [pypi.org](https://pypi.org/project/ory-client/) | [README](https://github.com/ory/sdk/blob/master/clients/client/python/README.md) | | Ruby | [rubygems.org](https://rubygems.org/gems/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/ruby/README.md) | | Rust | [crates.io](https://crates.io/crates/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/rust/README.md) |
5
5
 
6
- The version of the OpenAPI document: v1.22.34
6
+ The version of the OpenAPI document: v1.22.36
7
7
  Contact: support@ory.sh
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.17.0
data/lib/ory-client/api/frontend_api.rb CHANGED
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Introduction 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. ## SDKs This document describes the APIs available in the Ory Network. The APIs are available as SDKs for the following languages: | Language | Download SDK | Documentation | | -------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | Dart | [pub.dev](https://pub.dev/packages/ory_client) | [README](https://github.com/ory/sdk/blob/master/clients/client/dart/README.md) | | .NET | [nuget.org](https://www.nuget.org/packages/Ory.Client/) | [README](https://github.com/ory/sdk/blob/master/clients/client/dotnet/README.md) | | Elixir | [hex.pm](https://hex.pm/packages/ory_client) | [README](https://github.com/ory/sdk/blob/master/clients/client/elixir/README.md) | | Go | [github.com](https://github.com/ory/client-go) | [README](https://github.com/ory/sdk/blob/master/clients/client/go/README.md) | | Java | [maven.org](https://search.maven.org/artifact/sh.ory/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/java/README.md) | | JavaScript | [npmjs.com](https://www.npmjs.com/package/@ory/client) | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript/README.md) | | JavaScript (With fetch) | [npmjs.com](https://www.npmjs.com/package/@ory/client-fetch) | [README](https://github.com/ory/sdk/blob/master/clients/client/typescript-fetch/README.md) | | PHP | [packagist.org](https://packagist.org/packages/ory/client) | [README](https://github.com/ory/sdk/blob/master/clients/client/php/README.md) | | Python | [pypi.org](https://pypi.org/project/ory-client/) | [README](https://github.com/ory/sdk/blob/master/clients/client/python/README.md) | | Ruby | [rubygems.org](https://rubygems.org/gems/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/ruby/README.md) | | Rust | [crates.io](https://crates.io/crates/ory-client) | [README](https://github.com/ory/sdk/blob/master/clients/client/rust/README.md) |
5
5
 
6
- The version of the OpenAPI document: v1.22.34
6
+ The version of the OpenAPI document: v1.22.36
7
7
  Contact: support@ory.sh
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.17.0
@@ -20,7 +20,7 @@ module OryClient
20
20
  @api_client = api_client
21
21
  end
22
22
  # Create Login Flow for Browsers
23
- # This endpoint initializes a browser-based user login flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for browser-based flows. If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.login.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url` unless the query parameter `?refresh=true` was set. If this endpoint is called via an AJAX request, the response contains the 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. `session_aal1_required`: Multi-factor auth (e.g. 2fa) was requested but the user has no session yet. `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! The optional query parameter login_challenge is set when using Kratos with Hydra in an OAuth2 flow. See the oauth2_provider.url configuration option. This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Login](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).
23
+ # This endpoint initializes a browser-based user login flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for browser-based flows. If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.login.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url` unless the query parameter `?refresh=true` was set. If this endpoint is called via an AJAX request, the response contains the 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. `session_aal1_required`: Multi-factor auth (e.g. 2fa) was requested but the user has no session yet. `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! The optional query parameter login_challenge is set when using Kratos with Hydra in an OAuth2 flow. See the oauth2_provider.url configuration option. This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Login](https://www.ory.com/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-registration).
24
24
  # @param [Hash] opts the optional parameters
25
25
  # @option opts [Boolean] :refresh Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session.
26
26
  # @option opts [String] :aal Request a Specific AuthenticationMethod Assurance Level Use this parameter to upgrade an existing session&#39;s authenticator assurance level (AAL). This allows you to ask for multi-factor authentication. When an identity sign in using e.g. username+password, the AAL is 1. If you wish to \&quot;upgrade\&quot; the session&#39;s security by asking the user to perform TOTP / WebAuth/ ... you would set this to \&quot;aal2\&quot;.
@@ -37,7 +37,7 @@ module OryClient
37
37
  end
38
38
 
39
39
  # Create Login Flow for Browsers
40
- # This endpoint initializes a browser-based user login flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for browser-based flows. If this endpoint is opened as a link in the browser, it will be redirected to &#x60;selfservice.flows.login.ui_url&#x60; with the flow ID set as the query parameter &#x60;?flow&#x3D;&#x60;. If a valid user session exists already, the browser will be redirected to &#x60;urls.default_redirect_url&#x60; unless the query parameter &#x60;?refresh&#x3D;true&#x60; was set. If this endpoint is called via an AJAX request, the response contains the 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;session_aal1_required&#x60;: Multi-factor auth (e.g. 2fa) was requested but the user has no session yet. &#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! The optional query parameter login_challenge is set when using Kratos with Hydra in an OAuth2 flow. See the oauth2_provider.url configuration option. This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Login](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).
40
+ # This endpoint initializes a browser-based user login flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for browser-based flows. If this endpoint is opened as a link in the browser, it will be redirected to &#x60;selfservice.flows.login.ui_url&#x60; with the flow ID set as the query parameter &#x60;?flow&#x3D;&#x60;. If a valid user session exists already, the browser will be redirected to &#x60;urls.default_redirect_url&#x60; unless the query parameter &#x60;?refresh&#x3D;true&#x60; was set. If this endpoint is called via an AJAX request, the response contains the 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;session_aal1_required&#x60;: Multi-factor auth (e.g. 2fa) was requested but the user has no session yet. &#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! The optional query parameter login_challenge is set when using Kratos with Hydra in an OAuth2 flow. See the oauth2_provider.url configuration option. This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Login](https://www.ory.com/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-registration).
41
41
  # @param [Hash] opts the optional parameters
42
42
  # @option opts [Boolean] :refresh Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session.
43
43
  # @option opts [String] :aal Request a Specific AuthenticationMethod Assurance Level Use this parameter to upgrade an existing session&#39;s authenticator assurance level (AAL). This allows you to ask for multi-factor authentication. When an identity sign in using e.g. username+password, the AAL is 1. If you wish to \&quot;upgrade\&quot; the session&#39;s security by asking the user to perform TOTP / WebAuth/ ... you would set this to \&quot;aal2\&quot;.
@@ -167,6 +167,7 @@ module OryClient
167
167
  # This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to `selfservice.flows.recovery.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists, the browser is returned to the configured return URL. If this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects or a 400 bad request error if the user is already authenticated. This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).
168
168
  # @param [Hash] opts the optional parameters
169
169
  # @option opts [String] :return_to The URL to return the browser to after the flow was completed.
170
+ # @option opts [String] :skip_settings Skip redirection to the settings UI after the recovery flow was completed. Instead, the user will be redirected to the URL specified in &#x60;return_to&#x60; query parameter or the default return URL if &#x60;return_to&#x60; is not set.
170
171
  # @return [RecoveryFlow]
171
172
  def create_browser_recovery_flow(opts = {})
172
173
  data, _status_code, _headers = create_browser_recovery_flow_with_http_info(opts)
@@ -177,6 +178,7 @@ module OryClient
177
178
  # This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to &#x60;selfservice.flows.recovery.ui_url&#x60; with the flow ID set as the query parameter &#x60;?flow&#x3D;&#x60;. If a valid user session exists, the browser is returned to the configured return URL. If this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects or a 400 bad request error if the user is already authenticated. This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).
178
179
  # @param [Hash] opts the optional parameters
179
180
  # @option opts [String] :return_to The URL to return the browser to after the flow was completed.
181
+ # @option opts [String] :skip_settings Skip redirection to the settings UI after the recovery flow was completed. Instead, the user will be redirected to the URL specified in &#x60;return_to&#x60; query parameter or the default return URL if &#x60;return_to&#x60; is not set.
180
182
  # @return [Array<(RecoveryFlow, Integer, Hash)>] RecoveryFlow data, response status code and response headers
181
183
  def create_browser_recovery_flow_with_http_info(opts = {})
182
184
  if @api_client.config.debugging
@@ -188,6 +190,7 @@ module OryClient
188
190
  # query parameters
189
191
  query_params = opts[:query_params] || {}
190
192
  query_params[:'return_to'] = opts[:'return_to'] if !opts[:'return_to'].nil?
193
+ query_params[:'skip_settings'] = opts[:'skip_settings'] if !opts[:'skip_settings'].nil?
191
194
 
192
195
  # header parameters
193
196
  header_params = opts[:header_params] || {}
@@ -224,7 +227,7 @@ module OryClient
224
227
  end
225
228
 
226
229
  # Create Registration Flow for Browsers
227
- # This endpoint initializes a browser-based user registration flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for browser-based flows. If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.registration.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url`. If this endpoint is called via an AJAX request, the response contains the 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! If this endpoint is called via an AJAX request, the response contains the registration flow without a redirect. This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Login](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).
230
+ # This endpoint initializes a browser-based user registration flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for browser-based flows. If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.registration.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url`. If this endpoint is called via an AJAX request, the response contains the 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! If this endpoint is called via an AJAX request, the response contains the registration flow without a redirect. This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Login](https://www.ory.com/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-registration).
228
231
  # @param [Hash] opts the optional parameters
229
232
  # @option opts [String] :return_to The URL to return the browser to after the flow was completed.
230
233
  # @option opts [String] :login_challenge Ory OAuth 2.0 Login Challenge. If set will cooperate with Ory OAuth2 and OpenID to act as an OAuth2 server / OpenID Provider. The value for this parameter comes from &#x60;login_challenge&#x60; URL Query parameter sent to your application (e.g. &#x60;/registration?login_challenge&#x3D;abcde&#x60;). This feature is compatible with Ory Hydra when not running on the Ory Network.
@@ -238,7 +241,7 @@ module OryClient
238
241
  end
239
242
 
240
243
  # Create Registration Flow for Browsers
241
- # This endpoint initializes a browser-based user registration flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for browser-based flows. If this endpoint is opened as a link in the browser, it will be redirected to &#x60;selfservice.flows.registration.ui_url&#x60; with the flow ID set as the query parameter &#x60;?flow&#x3D;&#x60;. If a valid user session exists already, the browser will be redirected to &#x60;urls.default_redirect_url&#x60;. If this endpoint is called via an AJAX request, the response contains the 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! If this endpoint is called via an AJAX request, the response contains the registration flow without a redirect. This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Login](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).
244
+ # This endpoint initializes a browser-based user registration flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for browser-based flows. If this endpoint is opened as a link in the browser, it will be redirected to &#x60;selfservice.flows.registration.ui_url&#x60; with the flow ID set as the query parameter &#x60;?flow&#x3D;&#x60;. If a valid user session exists already, the browser will be redirected to &#x60;urls.default_redirect_url&#x60;. If this endpoint is called via an AJAX request, the response contains the 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! If this endpoint is called via an AJAX request, the response contains the registration flow without a redirect. This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Login](https://www.ory.com/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-registration).
242
245
  # @param [Hash] opts the optional parameters
243
246
  # @option opts [String] :return_to The URL to return the browser to after the flow was completed.
244
247
  # @option opts [String] :login_challenge Ory OAuth 2.0 Login Challenge. If set will cooperate with Ory OAuth2 and OpenID to act as an OAuth2 server / OpenID Provider. The value for this parameter comes from &#x60;login_challenge&#x60; URL Query parameter sent to your application (e.g. &#x60;/registration?login_challenge&#x3D;abcde&#x60;). This feature is compatible with Ory Hydra when not running on the Ory Network.
@@ -359,7 +362,7 @@ module OryClient
359
362
  end
360
363
 
361
364
  # Create Verification Flow for Browser Clients
362
- # This endpoint initializes a browser-based account verification flow. Once initialized, the browser will be redirected to `selfservice.flows.verification.ui_url` with the flow ID set as the query parameter `?flow=`. If this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/self-service/flows/verify-email-account-activation).
365
+ # This endpoint initializes a browser-based account verification flow. Once initialized, the browser will be redirected to `selfservice.flows.verification.ui_url` with the flow ID set as the query parameter `?flow=`. If this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.com/docs/kratos/self-service/flows/verify-email-account-activation).
363
366
  # @param [Hash] opts the optional parameters
364
367
  # @option opts [String] :return_to The URL to return the browser to after the flow was completed.
365
368
  # @return [VerificationFlow]
@@ -369,7 +372,7 @@ module OryClient
369
372
  end
370
373
 
371
374
  # Create Verification Flow for Browser Clients
372
- # This endpoint initializes a browser-based account verification flow. Once initialized, the browser will be redirected to &#x60;selfservice.flows.verification.ui_url&#x60; with the flow ID set as the query parameter &#x60;?flow&#x3D;&#x60;. If this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/self-service/flows/verify-email-account-activation).
375
+ # This endpoint initializes a browser-based account verification flow. Once initialized, the browser will be redirected to &#x60;selfservice.flows.verification.ui_url&#x60; with the flow ID set as the query parameter &#x60;?flow&#x3D;&#x60;. If this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.com/docs/kratos/self-service/flows/verify-email-account-activation).
373
376
  # @param [Hash] opts the optional parameters
374
377
  # @option opts [String] :return_to The URL to return the browser to after the flow was completed.
375
378
  # @return [Array<(VerificationFlow, Integer, Hash)>] VerificationFlow data, response status code and response headers
@@ -476,7 +479,7 @@ module OryClient
476
479
  end
477
480
 
478
481
  # Create Login Flow for Native Apps
479
- # This endpoint initiates a login flow for native apps that do not use a browser, such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing login flow call `/self-service/login/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks, including CSRF login attacks. 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. `session_aal1_required`: Multi-factor auth (e.g. 2fa) was requested but the user has no session yet. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. 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](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).
482
+ # This endpoint initiates a login flow for native apps that do not use a browser, such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing login flow call `/self-service/login/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks, including CSRF login attacks. 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. `session_aal1_required`: Multi-factor auth (e.g. 2fa) was requested but the user has no session yet. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. 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](https://www.ory.com/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-registration).
480
483
  # @param [Hash] opts the optional parameters
481
484
  # @option opts [Boolean] :refresh Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session.
482
485
  # @option opts [String] :aal Request a Specific AuthenticationMethod Assurance Level Use this parameter to upgrade an existing session&#39;s authenticator assurance level (AAL). This allows you to ask for multi-factor authentication. When an identity sign in using e.g. username+password, the AAL is 1. If you wish to \&quot;upgrade\&quot; the session&#39;s security by asking the user to perform TOTP / WebAuth/ ... you would set this to \&quot;aal2\&quot;.
@@ -493,7 +496,7 @@ module OryClient
493
496
  end
494
497
 
495
498
  # Create Login Flow for Native Apps
496
- # This endpoint initiates a login flow for native apps that do not use a browser, such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter &#x60;?refresh&#x3D;true&#x60; is set. To fetch an existing login flow call &#x60;/self-service/login/flows?flow&#x3D;&lt;flow_id&gt;&#x60;. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks, including CSRF login attacks. 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;session_aal1_required&#x60;: Multi-factor auth (e.g. 2fa) was requested but the user has no session yet. &#x60;security_csrf_violation&#x60;: Unable to fetch the flow because a CSRF violation occurred. 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](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).
499
+ # This endpoint initiates a login flow for native apps that do not use a browser, such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter &#x60;?refresh&#x3D;true&#x60; is set. To fetch an existing login flow call &#x60;/self-service/login/flows?flow&#x3D;&lt;flow_id&gt;&#x60;. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks, including CSRF login attacks. 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;session_aal1_required&#x60;: Multi-factor auth (e.g. 2fa) was requested but the user has no session yet. &#x60;security_csrf_violation&#x60;: Unable to fetch the flow because a CSRF violation occurred. 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](https://www.ory.com/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-registration).
497
500
  # @param [Hash] opts the optional parameters
498
501
  # @option opts [Boolean] :refresh Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session.
499
502
  # @option opts [String] :aal Request a Specific AuthenticationMethod Assurance Level Use this parameter to upgrade an existing session&#39;s authenticator assurance level (AAL). This allows you to ask for multi-factor authentication. When an identity sign in using e.g. username+password, the AAL is 1. If you wish to \&quot;upgrade\&quot; the session&#39;s security by asking the user to perform TOTP / WebAuth/ ... you would set this to \&quot;aal2\&quot;.
@@ -614,7 +617,7 @@ module OryClient
614
617
  end
615
618
 
616
619
  # Create Registration Flow for Native Apps
617
- # This endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing registration flow call `/self-service/registration/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. 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. 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](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).
620
+ # This endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing registration flow call `/self-service/registration/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. 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. 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](https://www.ory.com/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-registration).
618
621
  # @param [Hash] opts the optional parameters
619
622
  # @option opts [Boolean] :return_session_token_exchange_code EnableSessionTokenExchangeCode requests the login flow to include a code that can be used to retrieve the session token after the login flow has been completed.
620
623
  # @option opts [String] :return_to The URL to return the browser to after the flow was completed.
@@ -627,7 +630,7 @@ module OryClient
627
630
  end
628
631
 
629
632
  # Create Registration Flow for Native Apps
630
- # This endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter &#x60;?refresh&#x3D;true&#x60; is set. To fetch an existing registration flow call &#x60;/self-service/registration/flows?flow&#x3D;&lt;flow_id&gt;&#x60;. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. 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. 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](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).
633
+ # This endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter &#x60;?refresh&#x3D;true&#x60; is set. To fetch an existing registration flow call &#x60;/self-service/registration/flows?flow&#x3D;&lt;flow_id&gt;&#x60;. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. 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. 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](https://www.ory.com/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-registration).
631
634
  # @param [Hash] opts the optional parameters
632
635
  # @option opts [Boolean] :return_session_token_exchange_code EnableSessionTokenExchangeCode requests the login flow to include a code that can be used to retrieve the session token after the login flow has been completed.
633
636
  # @option opts [String] :return_to The URL to return the browser to after the flow was completed.
@@ -743,7 +746,7 @@ module OryClient
743
746
  end
744
747
 
745
748
  # Create Verification Flow for Native Apps
746
- # This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. To fetch an existing verification flow call `/self-service/verification/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/self-service/flows/verify-email-account-activation).
749
+ # This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. To fetch an existing verification flow call `/self-service/verification/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Email and Phone Verification Documentation](https://www.ory.com/docs/kratos/self-service/flows/verify-email-account-activation).
747
750
  # @param [Hash] opts the optional parameters
748
751
  # @option opts [String] :return_to A URL contained in the return_to key of the verification flow. This piece of data has no effect on the actual logic of the flow and is purely informational.
749
752
  # @return [VerificationFlow]
@@ -753,7 +756,7 @@ module OryClient
753
756
  end
754
757
 
755
758
  # Create Verification Flow for Native Apps
756
- # This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. To fetch an existing verification flow call &#x60;/self-service/verification/flows?flow&#x3D;&lt;flow_id&gt;&#x60;. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/self-service/flows/verify-email-account-activation).
759
+ # This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. To fetch an existing verification flow call &#x60;/self-service/verification/flows?flow&#x3D;&lt;flow_id&gt;&#x60;. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Email and Phone Verification Documentation](https://www.ory.com/docs/kratos/self-service/flows/verify-email-account-activation).
757
760
  # @param [Hash] opts the optional parameters
758
761
  # @option opts [String] :return_to A URL contained in the return_to key of the verification flow. This piece of data has no effect on the actual logic of the flow and is purely informational.
759
762
  # @return [Array<(VerificationFlow, Integer, Hash)>] VerificationFlow data, response status code and response headers
@@ -1004,7 +1007,7 @@ module OryClient
1004
1007
  end
1005
1008
 
1006
1009
  # Get User-Flow Errors
1007
- # This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: `?id=stub:500` - returns a stub 500 (Internal Server Error) error. More information can be found at [Ory Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
1010
+ # This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: `?id=stub:500` - returns a stub 500 (Internal Server Error) error. More information can be found at [Ory Kratos User User Facing Error Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-facing-errors).
1008
1011
  # @param id [String] Error is the error&#39;s ID
1009
1012
  # @param [Hash] opts the optional parameters
1010
1013
  # @return [FlowError]
@@ -1014,7 +1017,7 @@ module OryClient
1014
1017
  end
1015
1018
 
1016
1019
  # Get User-Flow Errors
1017
- # This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: &#x60;?id&#x3D;stub:500&#x60; - returns a stub 500 (Internal Server Error) error. More information can be found at [Ory Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
1020
+ # This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: &#x60;?id&#x3D;stub:500&#x60; - returns a stub 500 (Internal Server Error) error. More information can be found at [Ory Kratos User User Facing Error Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-facing-errors).
1018
1021
  # @param id [String] Error is the error&#39;s ID
1019
1022
  # @param [Hash] opts the optional parameters
1020
1023
  # @return [Array<(FlowError, Integer, Hash)>] FlowError data, response status code and response headers
@@ -1068,7 +1071,7 @@ module OryClient
1068
1071
  end
1069
1072
 
1070
1073
  # Get Login Flow
1071
- # 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.getLoginFlow(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).
1074
+ # 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.getLoginFlow(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.com/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-registration).
1072
1075
  # @param 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;).
1073
1076
  # @param [Hash] opts the optional parameters
1074
1077
  # @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.
@@ -1079,7 +1082,7 @@ module OryClient
1079
1082
  end
1080
1083
 
1081
1084
  # Get Login Flow
1082
- # This endpoint returns a login flow&#39;s context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request&#39;s HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: &#x60;&#x60;&#x60;js pseudo-code example router.get(&#39;/login&#39;, async function (req, res) { const flow &#x3D; await client.getLoginFlow(req.header(&#39;cookie&#39;), req.query[&#39;flow&#39;]) res.render(&#39;login&#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).
1085
+ # This endpoint returns a login flow&#39;s context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request&#39;s HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: &#x60;&#x60;&#x60;js pseudo-code example router.get(&#39;/login&#39;, async function (req, res) { const flow &#x3D; await client.getLoginFlow(req.header(&#39;cookie&#39;), req.query[&#39;flow&#39;]) res.render(&#39;login&#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.com/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-registration).
1083
1086
  # @param 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;).
1084
1087
  # @param [Hash] opts the optional parameters
1085
1088
  # @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.
@@ -1202,7 +1205,7 @@ module OryClient
1202
1205
  end
1203
1206
 
1204
1207
  # Get Registration Flow
1205
- # 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.getRegistrationFlow(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).
1208
+ # 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.getRegistrationFlow(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.com/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-registration).
1206
1209
  # @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;).
1207
1210
  # @param [Hash] opts the optional parameters
1208
1211
  # @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.
@@ -1213,7 +1216,7 @@ module OryClient
1213
1216
  end
1214
1217
 
1215
1218
  # Get Registration Flow
1216
- # 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.getRegistrationFlow(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).
1219
+ # 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.getRegistrationFlow(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.com/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-registration).
1217
1220
  # @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;).
1218
1221
  # @param [Hash] opts the optional parameters
1219
1222
  # @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.
@@ -1339,7 +1342,7 @@ module OryClient
1339
1342
  end
1340
1343
 
1341
1344
  # Get Verification Flow
1342
- # This endpoint returns a verification flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/recovery', async function (req, res) { const flow = await client.getVerificationFlow(req.header('cookie'), req.query['flow']) res.render('verification', flow) }) ``` More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/self-service/flows/verify-email-account-activation).
1345
+ # This endpoint returns a verification flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/recovery', async function (req, res) { const flow = await client.getVerificationFlow(req.header('cookie'), req.query['flow']) res.render('verification', flow) }) ``` More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.com/docs/kratos/self-service/flows/verify-email-account-activation).
1343
1346
  # @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;/verification?flow&#x3D;abcde&#x60;).
1344
1347
  # @param [Hash] opts the optional parameters
1345
1348
  # @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.
@@ -1350,7 +1353,7 @@ module OryClient
1350
1353
  end
1351
1354
 
1352
1355
  # Get Verification Flow
1353
- # This endpoint returns a verification flow&#39;s context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request&#39;s HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: &#x60;&#x60;&#x60;js pseudo-code example router.get(&#39;/recovery&#39;, async function (req, res) { const flow &#x3D; await client.getVerificationFlow(req.header(&#39;cookie&#39;), req.query[&#39;flow&#39;]) res.render(&#39;verification&#39;, flow) }) &#x60;&#x60;&#x60; More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/self-service/flows/verify-email-account-activation).
1356
+ # This endpoint returns a verification flow&#39;s context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request&#39;s HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: &#x60;&#x60;&#x60;js pseudo-code example router.get(&#39;/recovery&#39;, async function (req, res) { const flow &#x3D; await client.getVerificationFlow(req.header(&#39;cookie&#39;), req.query[&#39;flow&#39;]) res.render(&#39;verification&#39;, flow) }) &#x60;&#x60;&#x60; More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.com/docs/kratos/self-service/flows/verify-email-account-activation).
1354
1357
  # @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;/verification?flow&#x3D;abcde&#x60;).
1355
1358
  # @param [Hash] opts the optional parameters
1356
1359
  # @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.
@@ -1406,7 +1409,7 @@ module OryClient
1406
1409
  end
1407
1410
 
1408
1411
  # Get WebAuthn JavaScript
1409
- # This endpoint provides JavaScript which is needed in order to perform WebAuthn login and registration. If you are building a JavaScript Browser App (e.g. in ReactJS or AngularJS) you will need to load this file: ```html <script src=\"https://public-kratos.example.org/.well-known/ory/webauthn.js\" type=\"script\" async /> ``` 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).
1412
+ # This endpoint provides JavaScript which is needed in order to perform WebAuthn login and registration. If you are building a JavaScript Browser App (e.g. in ReactJS or AngularJS) you will need to load this file: ```html <script src=\"https://public-kratos.example.org/.well-known/ory/webauthn.js\" type=\"script\" async /> ``` More information can be found at [Ory Kratos User Login](https://www.ory.com/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-registration).
1410
1413
  # @param [Hash] opts the optional parameters
1411
1414
  # @return [String]
1412
1415
  def get_web_authn_java_script(opts = {})
@@ -1415,7 +1418,7 @@ module OryClient
1415
1418
  end
1416
1419
 
1417
1420
  # Get WebAuthn JavaScript
1418
- # This endpoint provides JavaScript which is needed in order to perform WebAuthn login and registration. If you are building a JavaScript Browser App (e.g. in ReactJS or AngularJS) you will need to load this file: &#x60;&#x60;&#x60;html &lt;script src&#x3D;\&quot;https://public-kratos.example.org/.well-known/ory/webauthn.js\&quot; type&#x3D;\&quot;script\&quot; async /&gt; &#x60;&#x60;&#x60; 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).
1421
+ # This endpoint provides JavaScript which is needed in order to perform WebAuthn login and registration. If you are building a JavaScript Browser App (e.g. in ReactJS or AngularJS) you will need to load this file: &#x60;&#x60;&#x60;html &lt;script src&#x3D;\&quot;https://public-kratos.example.org/.well-known/ory/webauthn.js\&quot; type&#x3D;\&quot;script\&quot; async /&gt; &#x60;&#x60;&#x60; More information can be found at [Ory Kratos User Login](https://www.ory.com/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-registration).
1419
1422
  # @param [Hash] opts the optional parameters
1420
1423
  # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
1421
1424
  def get_web_authn_java_script_with_http_info(opts = {})
@@ -1467,8 +1470,8 @@ module OryClient
1467
1470
  # @param [Hash] opts the optional parameters
1468
1471
  # @option opts [Integer] :per_page Deprecated Items per Page DEPRECATED: Please use &#x60;page_token&#x60; instead. This parameter will be removed in the future. This is the number of items per page. (default to 250)
1469
1472
  # @option opts [Integer] :page Deprecated Pagination Page DEPRECATED: Please use &#x60;page_token&#x60; instead. This parameter will be removed in the future. This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. The first page can be retrieved by omitting this parameter. Following page pointers will be returned in the &#x60;Link&#x60; header.
1470
- # @option opts [Integer] :page_size Page Size This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). (default to 250)
1471
- # @option opts [String] :page_token Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
1473
+ # @option opts [Integer] :page_size Page Size This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination). (default to 250)
1474
+ # @option opts [String] :page_token Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination).
1472
1475
  # @option opts [String] :x_session_token Set the Session Token when calling from non-browser clients. A session token has a format of &#x60;MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj&#x60;.
1473
1476
  # @option opts [String] :cookie Set the Cookie Header. This is especially useful when calling this endpoint from a server-side application. In that scenario you must include the HTTP Cookie Header which originally was included in the request to your server. An example of a session in the HTTP Cookie Header is: &#x60;ory_kratos_session&#x3D;a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f&#x3D;&#x3D;&#x60;. It is ok if more than one cookie are included here as all other cookies will be ignored.
1474
1477
  # @return [Array<Session>]
@@ -1482,8 +1485,8 @@ module OryClient
1482
1485
  # @param [Hash] opts the optional parameters
1483
1486
  # @option opts [Integer] :per_page Deprecated Items per Page DEPRECATED: Please use &#x60;page_token&#x60; instead. This parameter will be removed in the future. This is the number of items per page. (default to 250)
1484
1487
  # @option opts [Integer] :page Deprecated Pagination Page DEPRECATED: Please use &#x60;page_token&#x60; instead. This parameter will be removed in the future. This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. The first page can be retrieved by omitting this parameter. Following page pointers will be returned in the &#x60;Link&#x60; header.
1485
- # @option opts [Integer] :page_size Page Size This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination). (default to 250)
1486
- # @option opts [String] :page_token Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
1488
+ # @option opts [Integer] :page_size Page Size This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination). (default to 250)
1489
+ # @option opts [String] :page_token Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination).
1487
1490
  # @option opts [String] :x_session_token Set the Session Token when calling from non-browser clients. A session token has a format of &#x60;MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj&#x60;.
1488
1491
  # @option opts [String] :cookie Set the Cookie Header. This is especially useful when calling this endpoint from a server-side application. In that scenario you must include the HTTP Cookie Header which originally was included in the request to your server. An example of a session in the HTTP Cookie Header is: &#x60;ory_kratos_session&#x3D;a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f&#x3D;&#x3D;&#x60;. It is ok if more than one cookie are included here as all other cookies will be ignored.
1489
1492
  # @return [Array<(Array<Session>, Integer, Hash)>] Array<Session> data, response status code and response headers
@@ -1756,7 +1759,7 @@ module OryClient
1756
1759
  end
1757
1760
 
1758
1761
  # Submit a Login Flow
1759
- # 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).
1762
+ # 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.com/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-registration).
1760
1763
  # @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;).
1761
1764
  # @param update_login_flow_body [UpdateLoginFlowBody]
1762
1765
  # @param [Hash] opts the optional parameters
@@ -1769,7 +1772,7 @@ module OryClient
1769
1772
  end
1770
1773
 
1771
1774
  # Submit a Login Flow
1772
- # 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).
1775
+ # 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.com/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-registration).
1773
1776
  # @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;).
1774
1777
  # @param update_login_flow_body [UpdateLoginFlowBody]
1775
1778
  # @param [Hash] opts the optional parameters
@@ -1837,7 +1840,7 @@ module OryClient
1837
1840
  end
1838
1841
 
1839
1842
  # Update Logout Flow
1840
- # This endpoint logs out an identity in a self-service manner. If the `Accept` HTTP header is not set to `application/json`, the browser will be redirected (HTTP 303 See Other) to the `return_to` parameter of the initial request or fall back to `urls.default_return_to`. If the `Accept` HTTP header is set to `application/json`, a 204 No Content response will be sent on successful logout instead. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). For API clients you can call the `/self-service/logout/api` URL directly with the Ory Session Token. More information can be found at [Ory Kratos User Logout Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-logout).
1843
+ # This endpoint logs out an identity in a self-service manner. If the `Accept` HTTP header is not set to `application/json`, the browser will be redirected (HTTP 303 See Other) to the `return_to` parameter of the initial request or fall back to `urls.default_return_to`. If the `Accept` HTTP header is set to `application/json`, a 204 No Content response will be sent on successful logout instead. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). For API clients you can call the `/self-service/logout/api` URL directly with the Ory Session Token. More information can be found at [Ory Kratos User Logout Documentation](https://www.ory.com/docs/next/kratos/self-service/flows/user-logout).
1841
1844
  # @param [Hash] opts the optional parameters
1842
1845
  # @option opts [String] :token A Valid Logout Token If you do not have a logout token because you only have a session cookie, call &#x60;/self-service/logout/browser&#x60; to generate a URL for this endpoint.
1843
1846
  # @option opts [String] :return_to The URL to return to after the logout was completed.
@@ -1849,7 +1852,7 @@ module OryClient
1849
1852
  end
1850
1853
 
1851
1854
  # Update Logout Flow
1852
- # This endpoint logs out an identity in a self-service manner. If the &#x60;Accept&#x60; HTTP header is not set to &#x60;application/json&#x60;, the browser will be redirected (HTTP 303 See Other) to the &#x60;return_to&#x60; parameter of the initial request or fall back to &#x60;urls.default_return_to&#x60;. If the &#x60;Accept&#x60; HTTP header is set to &#x60;application/json&#x60;, a 204 No Content response will be sent on successful logout instead. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). For API clients you can call the &#x60;/self-service/logout/api&#x60; URL directly with the Ory Session Token. More information can be found at [Ory Kratos User Logout Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-logout).
1855
+ # This endpoint logs out an identity in a self-service manner. If the &#x60;Accept&#x60; HTTP header is not set to &#x60;application/json&#x60;, the browser will be redirected (HTTP 303 See Other) to the &#x60;return_to&#x60; parameter of the initial request or fall back to &#x60;urls.default_return_to&#x60;. If the &#x60;Accept&#x60; HTTP header is set to &#x60;application/json&#x60;, a 204 No Content response will be sent on successful logout instead. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). For API clients you can call the &#x60;/self-service/logout/api&#x60; URL directly with the Ory Session Token. More information can be found at [Ory Kratos User Logout Documentation](https://www.ory.com/docs/next/kratos/self-service/flows/user-logout).
1853
1856
  # @param [Hash] opts the optional parameters
1854
1857
  # @option opts [String] :token A Valid Logout Token If you do not have a logout token because you only have a session cookie, call &#x60;/self-service/logout/browser&#x60; to generate a URL for this endpoint.
1855
1858
  # @option opts [String] :return_to The URL to return to after the logout was completed.
@@ -1984,7 +1987,7 @@ module OryClient
1984
1987
  end
1985
1988
 
1986
1989
  # Update Registration Flow
1987
- # 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).
1990
+ # 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.com/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-registration).
1988
1991
  # @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;).
1989
1992
  # @param update_registration_flow_body [UpdateRegistrationFlowBody]
1990
1993
  # @param [Hash] opts the optional parameters
@@ -1996,7 +1999,7 @@ module OryClient
1996
1999
  end
1997
2000
 
1998
2001
  # Update Registration Flow
1999
- # 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).
2002
+ # 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.com/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-registration).
2000
2003
  # @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;).
2001
2004
  # @param update_registration_flow_body [UpdateRegistrationFlowBody]
2002
2005
  # @param [Hash] opts the optional parameters
@@ -2143,7 +2146,7 @@ module OryClient
2143
2146
  end
2144
2147
 
2145
2148
  # Complete Verification Flow
2146
- # 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/self-service/flows/verify-email-account-activation).
2149
+ # 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.com/docs/kratos/self-service/flows/verify-email-account-activation).
2147
2150
  # @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;).
2148
2151
  # @param update_verification_flow_body [UpdateVerificationFlowBody]
2149
2152
  # @param [Hash] opts the optional parameters
@@ -2156,7 +2159,7 @@ module OryClient
2156
2159
  end
2157
2160
 
2158
2161
  # Complete Verification Flow
2159
- # 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/self-service/flows/verify-email-account-activation).
2162
+ # 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.com/docs/kratos/self-service/flows/verify-email-account-activation).
2160
2163
  # @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;).
2161
2164
  # @param update_verification_flow_body [UpdateVerificationFlowBody]
2162
2165
  # @param [Hash] opts the optional parameters