ory-client 1.22.66 → 1.22.79

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 (957) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +3 -3
  3. data/README.md +29 -7
  4. data/docs/AccountExperienceConfiguration.md +2 -2
  5. data/docs/AddProjectToWorkspaceBody.md +1 -1
  6. data/docs/AddWorkspaceOrganizationDomainBody.md +18 -0
  7. data/docs/AiAssistantSessionToken.md +20 -0
  8. data/docs/ApiKeysApi.md +2 -2
  9. data/docs/AttributeFilter.md +1 -1
  10. data/docs/CreateProjectNormalizedPayload.md +20 -8
  11. data/docs/CreateRecoveryCodeForIdentityBody.md +1 -1
  12. data/docs/CreateRecoveryLinkForIdentityBody.md +1 -1
  13. data/docs/CreateSubscriptionBody.md +2 -2
  14. data/docs/CreateSubscriptionCommon.md +2 -2
  15. data/docs/CreateWorkspaceContactBody.md +26 -0
  16. data/docs/CreateWorkspaceSubscriptionBody.md +2 -2
  17. data/docs/CustomDomain.md +1 -1
  18. data/docs/DomainVerificationStatus.md +28 -0
  19. data/docs/ErrorOAuth2.md +1 -1
  20. data/docs/EventStream.md +5 -3
  21. data/docs/FeatureFlagsCatalogEntry.md +26 -0
  22. data/docs/FrontendApi.md +479 -16
  23. data/docs/GenericError.md +2 -2
  24. data/docs/IdentityApi.md +10 -10
  25. data/docs/IdentityCredentials.md +1 -1
  26. data/docs/JwkApi.md +5 -5
  27. data/docs/KeysetPaginationResponseHeaders.md +1 -1
  28. data/docs/ListWorkspaceContacts.md +22 -0
  29. data/docs/LoginFlow.md +2 -2
  30. data/docs/ManageSessionsBody.md +1 -1
  31. data/docs/Message.md +1 -1
  32. data/docs/NormalizedProjectRevision.md +18 -6
  33. data/docs/NormalizedProjectRevisionCourierChannel.md +1 -1
  34. data/docs/NormalizedProjectRevisionIdentitySchema.md +1 -1
  35. data/docs/NormalizedProjectRevisionSAMLProvider.md +3 -1
  36. data/docs/NormalizedProjectRevisionThirdPartyProvider.md +5 -3
  37. data/docs/NormalizedProjectRevisionTokenizerTemplate.md +1 -1
  38. data/docs/OAuth2Api.md +10 -6
  39. data/docs/OAuth2Client.md +3 -3
  40. data/docs/OAuth2ConsentRequestOpenIDConnectContext.md +1 -1
  41. data/docs/OidcApi.md +1 -1
  42. data/docs/OidcConfiguration.md +1 -1
  43. data/docs/OplParseError.md +22 -0
  44. data/docs/OplSourcePosition.md +20 -0
  45. data/docs/OplValidateResult.md +18 -0
  46. data/docs/PatchIdentitiesBody.md +3 -1
  47. data/docs/PatchWorkspaceContactBody.md +26 -0
  48. data/docs/ProjectApi.md +79 -5
  49. data/docs/Provider.md +1 -1
  50. data/docs/QuotaUsage.md +1 -1
  51. data/docs/RateLimitPolicy.md +2 -2
  52. data/docs/RecoveryFlow.md +1 -1
  53. data/docs/RegistrationFlow.md +2 -2
  54. data/docs/RotateOAuth2ClientSecretBody.md +18 -0
  55. data/docs/SessionAuthenticationMethod.md +3 -1
  56. data/docs/SettingsFlow.md +1 -1
  57. data/docs/TokenPaginationHeaders.md +2 -2
  58. data/docs/TokenPaginationResponseHeaders.md +1 -1
  59. data/docs/UpdateLoginFlowWithOidcMethod.md +2 -2
  60. data/docs/UpdateRegistrationFlowWithOidcMethod.md +2 -2
  61. data/docs/UpdateSettingsFlowWithOidcMethod.md +7 -5
  62. data/docs/UpdateSettingsFlowWithSamlMethod.md +4 -4
  63. data/docs/UpdateSubscriptionBody.md +1 -1
  64. data/docs/VerificationFlow.md +1 -1
  65. data/docs/WebAuthnRelatedOrigins.md +18 -0
  66. data/docs/WorkspaceContact.md +32 -0
  67. data/docs/WorkspaceContactRecipient.md +22 -0
  68. data/docs/WorkspaceContactRecipientInput.md +20 -0
  69. data/docs/WorkspaceOrganization.md +2 -0
  70. data/lib/ory-client/api/api_keys_api.rb +5 -5
  71. data/lib/ory-client/api/courier_api.rb +1 -1
  72. data/lib/ory-client/api/elements_api.rb +1 -1
  73. data/lib/ory-client/api/events_api.rb +1 -1
  74. data/lib/ory-client/api/frontend_api.rb +527 -34
  75. data/lib/ory-client/api/identity_api.rb +15 -15
  76. data/lib/ory-client/api/jwk_api.rb +11 -11
  77. data/lib/ory-client/api/metadata_api.rb +1 -1
  78. data/lib/ory-client/api/o_auth2_api.rb +11 -4
  79. data/lib/ory-client/api/oidc_api.rb +3 -3
  80. data/lib/ory-client/api/permission_api.rb +1 -1
  81. data/lib/ory-client/api/project_api.rb +75 -5
  82. data/lib/ory-client/api/relationship_api.rb +1 -1
  83. data/lib/ory-client/api/wellknown_api.rb +1 -1
  84. data/lib/ory-client/api/workspace_api.rb +1 -1
  85. data/lib/ory-client/api_client.rb +2 -2
  86. data/lib/ory-client/api_error.rb +1 -1
  87. data/lib/ory-client/api_model_base.rb +1 -1
  88. data/lib/ory-client/configuration.rb +7 -1
  89. data/lib/ory-client/models/accept_device_user_code_request.rb +1 -1
  90. data/lib/ory-client/models/accept_o_auth2_consent_request.rb +1 -1
  91. data/lib/ory-client/models/accept_o_auth2_consent_request_session.rb +1 -1
  92. data/lib/ory-client/models/accept_o_auth2_login_request.rb +1 -1
  93. data/lib/ory-client/models/account_experience_colors.rb +1 -1
  94. data/lib/ory-client/models/account_experience_configuration.rb +3 -2
  95. data/lib/ory-client/models/add_project_to_workspace_body.rb +2 -2
  96. data/lib/ory-client/models/add_workspace_organization_domain_body.rb +165 -0
  97. data/lib/ory-client/models/admin_identity_import_credentials_lookup_secret.rb +1 -1
  98. data/lib/ory-client/models/admin_identity_import_credentials_lookup_secret_config.rb +1 -1
  99. data/lib/ory-client/models/admin_revoke_imported_api_key_body.rb +1 -1
  100. data/lib/ory-client/models/admin_revoke_issued_api_key_body.rb +1 -1
  101. data/lib/ory-client/models/admin_rotate_issued_api_key_body.rb +1 -1
  102. data/lib/ory-client/models/admin_update_imported_api_key_request.rb +1 -1
  103. data/lib/ory-client/models/admin_update_issued_api_key_request.rb +1 -1
  104. data/lib/ory-client/models/ai_assistant_session_token.rb +193 -0
  105. data/lib/ory-client/models/any.rb +1 -1
  106. data/lib/ory-client/models/attribute.rb +1 -1
  107. data/lib/ory-client/models/attribute_filter.rb +2 -1
  108. data/lib/ory-client/models/attributes_count_datapoint.rb +1 -1
  109. data/lib/ory-client/models/authenticator_assurance_level.rb +1 -1
  110. data/lib/ory-client/models/basic_organization.rb +1 -1
  111. data/lib/ory-client/models/batch_check_permission_body.rb +1 -1
  112. data/lib/ory-client/models/batch_check_permission_result.rb +1 -1
  113. data/lib/ory-client/models/batch_create_imported_api_keys_error_code.rb +1 -1
  114. data/lib/ory-client/models/batch_create_imported_api_keys_request.rb +1 -1
  115. data/lib/ory-client/models/batch_create_imported_api_keys_response.rb +1 -1
  116. data/lib/ory-client/models/batch_create_imported_api_keys_result.rb +1 -1
  117. data/lib/ory-client/models/batch_patch_identities_response.rb +1 -1
  118. data/lib/ory-client/models/batch_verify_api_keys_request.rb +1 -1
  119. data/lib/ory-client/models/batch_verify_api_keys_response.rb +1 -1
  120. data/lib/ory-client/models/billing_period_bucket.rb +1 -1
  121. data/lib/ory-client/models/check_opl_syntax_result.rb +1 -1
  122. data/lib/ory-client/models/check_permission_result.rb +1 -1
  123. data/lib/ory-client/models/check_permission_result_with_error.rb +1 -1
  124. data/lib/ory-client/models/cloud_account.rb +1 -1
  125. data/lib/ory-client/models/continue_with.rb +1 -1
  126. data/lib/ory-client/models/continue_with_device_authn_pin_entry_ui.rb +1 -1
  127. data/lib/ory-client/models/continue_with_device_authn_pin_entry_ui_data.rb +1 -1
  128. data/lib/ory-client/models/continue_with_recovery_ui.rb +1 -1
  129. data/lib/ory-client/models/continue_with_recovery_ui_flow.rb +1 -1
  130. data/lib/ory-client/models/continue_with_redirect_browser_to.rb +1 -1
  131. data/lib/ory-client/models/continue_with_set_ory_session_token.rb +1 -1
  132. data/lib/ory-client/models/continue_with_settings_ui.rb +1 -1
  133. data/lib/ory-client/models/continue_with_settings_ui_flow.rb +1 -1
  134. data/lib/ory-client/models/continue_with_verification_ui.rb +1 -1
  135. data/lib/ory-client/models/continue_with_verification_ui_flow.rb +1 -1
  136. data/lib/ory-client/models/courier_message_status.rb +1 -1
  137. data/lib/ory-client/models/courier_message_type.rb +3 -3
  138. data/lib/ory-client/models/create_custom_domain_body.rb +1 -1
  139. data/lib/ory-client/models/create_event_stream_body.rb +1 -1
  140. data/lib/ory-client/models/create_fedcm_flow_response.rb +1 -1
  141. data/lib/ory-client/models/create_identity_body.rb +1 -1
  142. data/lib/ory-client/models/create_invite_response.rb +1 -1
  143. data/lib/ory-client/models/create_json_web_key_set.rb +1 -1
  144. data/lib/ory-client/models/create_onboarding_link_response.rb +1 -1
  145. data/lib/ory-client/models/create_organization_onboarding_portal_link_body.rb +2 -1
  146. data/lib/ory-client/models/create_project_api_key_body.rb +2 -1
  147. data/lib/ory-client/models/create_project_body.rb +1 -1
  148. data/lib/ory-client/models/create_project_branding.rb +1 -1
  149. data/lib/ory-client/models/create_project_member_invite_body.rb +1 -1
  150. data/lib/ory-client/models/create_project_normalized_payload.rb +72 -10
  151. data/lib/ory-client/models/create_recovery_code_for_identity_body.rb +1 -1
  152. data/lib/ory-client/models/create_recovery_link_for_identity_body.rb +1 -1
  153. data/lib/ory-client/models/create_relationship_body.rb +1 -1
  154. data/lib/ory-client/models/create_subscription_body.rb +3 -3
  155. data/lib/ory-client/models/create_subscription_common.rb +3 -3
  156. data/lib/ory-client/models/create_test_login_flow_body.rb +1 -1
  157. data/lib/ory-client/models/create_test_login_flow_from_onboarding_portal_link_body.rb +1 -1
  158. data/lib/ory-client/models/create_verifiable_credential_request_body.rb +1 -1
  159. data/lib/ory-client/models/create_workspace_api_key_body.rb +2 -1
  160. data/lib/ory-client/models/create_workspace_body.rb +1 -1
  161. data/lib/ory-client/models/create_workspace_contact_body.rb +272 -0
  162. data/lib/ory-client/models/create_workspace_member_invite_body.rb +1 -1
  163. data/lib/ory-client/models/create_workspace_organization_body.rb +1 -1
  164. data/lib/ory-client/models/create_workspace_subscription_body.rb +3 -3
  165. data/lib/ory-client/models/credential_supported_draft00.rb +1 -1
  166. data/lib/ory-client/models/custom_domain.rb +2 -1
  167. data/lib/ory-client/models/customer_portal_availability.rb +1 -1
  168. data/lib/ory-client/models/delete_my_sessions_count.rb +1 -1
  169. data/lib/ory-client/models/derive_token_request.rb +1 -1
  170. data/lib/ory-client/models/derive_token_response.rb +1 -1
  171. data/lib/ory-client/models/device_authn_android_authorization_list.rb +1 -1
  172. data/lib/ory-client/models/device_authn_android_key_description.rb +1 -1
  173. data/lib/ory-client/models/device_authn_android_root_of_trust.rb +1 -1
  174. data/lib/ory-client/models/device_authn_attestation.rb +1 -1
  175. data/lib/ory-client/models/device_authn_ios_att_stmt.rb +1 -1
  176. data/lib/ory-client/models/device_authn_ios_attestation.rb +1 -1
  177. data/lib/ory-client/models/device_authn_key.rb +1 -1
  178. data/lib/ory-client/models/device_authorization.rb +1 -1
  179. data/lib/ory-client/models/device_type.rb +1 -1
  180. data/lib/ory-client/models/device_user_auth_request.rb +1 -1
  181. data/lib/ory-client/models/domain_verification_status.rb +296 -0
  182. data/lib/ory-client/models/elements_configuration.rb +1 -1
  183. data/lib/ory-client/models/email_template_data.rb +1 -1
  184. data/lib/ory-client/models/email_template_data_body.rb +1 -1
  185. data/lib/ory-client/models/error_authenticator_assurance_level_not_satisfied.rb +1 -1
  186. data/lib/ory-client/models/error_browser_location_change_required.rb +1 -1
  187. data/lib/ory-client/models/error_flow_replaced.rb +1 -1
  188. data/lib/ory-client/models/error_generic.rb +1 -1
  189. data/lib/ory-client/models/error_o_auth2.rb +1 -1
  190. data/lib/ory-client/models/event_stream.rb +16 -2
  191. data/lib/ory-client/models/expanded_permission_tree.rb +1 -1
  192. data/lib/ory-client/models/feature_flags_catalog_entry.rb +256 -0
  193. data/lib/ory-client/models/flow_error.rb +1 -1
  194. data/lib/ory-client/models/generic_error.rb +1 -1
  195. data/lib/ory-client/models/generic_error_content.rb +1 -1
  196. data/lib/ory-client/models/generic_oidc_provider.rb +1 -1
  197. data/lib/ory-client/models/generic_usage.rb +1 -1
  198. data/lib/ory-client/models/get_attributes_count.rb +1 -1
  199. data/lib/ory-client/models/get_jwks_response.rb +1 -1
  200. data/lib/ory-client/models/get_jwks_response_jwks.rb +1 -1
  201. data/lib/ory-client/models/get_jwks_response_jwks_keys_inner.rb +1 -1
  202. data/lib/ory-client/models/get_managed_identity_schema_location.rb +1 -1
  203. data/lib/ory-client/models/get_metrics_count.rb +1 -1
  204. data/lib/ory-client/models/get_metrics_event_attributes.rb +1 -1
  205. data/lib/ory-client/models/get_metrics_event_types.rb +1 -1
  206. data/lib/ory-client/models/get_organization_response.rb +1 -1
  207. data/lib/ory-client/models/get_organizations_by_hostname_response.rb +1 -1
  208. data/lib/ory-client/models/get_project_events.rb +1 -1
  209. data/lib/ory-client/models/get_project_events_body.rb +1 -1
  210. data/lib/ory-client/models/get_project_metrics.rb +1 -1
  211. data/lib/ory-client/models/get_session_activity.rb +1 -1
  212. data/lib/ory-client/models/get_version200_response.rb +1 -1
  213. data/lib/ory-client/models/health_not_ready_status.rb +1 -1
  214. data/lib/ory-client/models/health_status.rb +1 -1
  215. data/lib/ory-client/models/identity.rb +1 -1
  216. data/lib/ory-client/models/identity_credentials.rb +2 -2
  217. data/lib/ory-client/models/identity_credentials_code.rb +1 -1
  218. data/lib/ory-client/models/identity_credentials_code_address.rb +1 -1
  219. data/lib/ory-client/models/identity_credentials_lookup_secret_code.rb +1 -1
  220. data/lib/ory-client/models/identity_credentials_oidc.rb +1 -1
  221. data/lib/ory-client/models/identity_credentials_oidc_provider.rb +1 -1
  222. data/lib/ory-client/models/identity_credentials_password.rb +1 -1
  223. data/lib/ory-client/models/identity_credentials_web_authn.rb +1 -1
  224. data/lib/ory-client/models/identity_credentials_web_authn_attestation.rb +1 -1
  225. data/lib/ory-client/models/identity_credentials_web_authn_authenticator.rb +1 -1
  226. data/lib/ory-client/models/identity_credentials_web_authn_flags.rb +1 -1
  227. data/lib/ory-client/models/identity_patch.rb +1 -1
  228. data/lib/ory-client/models/identity_patch_response.rb +1 -1
  229. data/lib/ory-client/models/identity_schema_container.rb +1 -1
  230. data/lib/ory-client/models/identity_schema_preset.rb +1 -1
  231. data/lib/ory-client/models/identity_with_credentials.rb +1 -1
  232. data/lib/ory-client/models/identity_with_credentials_oidc.rb +1 -1
  233. data/lib/ory-client/models/identity_with_credentials_oidc_config.rb +1 -1
  234. data/lib/ory-client/models/identity_with_credentials_oidc_config_provider.rb +1 -1
  235. data/lib/ory-client/models/identity_with_credentials_passkey.rb +1 -1
  236. data/lib/ory-client/models/identity_with_credentials_passkey_config.rb +1 -1
  237. data/lib/ory-client/models/identity_with_credentials_password.rb +1 -1
  238. data/lib/ory-client/models/identity_with_credentials_password_config.rb +1 -1
  239. data/lib/ory-client/models/identity_with_credentials_saml.rb +1 -1
  240. data/lib/ory-client/models/identity_with_credentials_saml_config.rb +1 -1
  241. data/lib/ory-client/models/identity_with_credentials_saml_config_provider.rb +1 -1
  242. data/lib/ory-client/models/identity_with_credentials_totp.rb +1 -1
  243. data/lib/ory-client/models/identity_with_credentials_totp_config.rb +1 -1
  244. data/lib/ory-client/models/identity_with_credentials_web_authn.rb +1 -1
  245. data/lib/ory-client/models/identity_with_credentials_web_authn_config.rb +1 -1
  246. data/lib/ory-client/models/import_api_key_request.rb +1 -1
  247. data/lib/ory-client/models/imported_api_key.rb +1 -1
  248. data/lib/ory-client/models/internal_get_project_branding_body.rb +1 -1
  249. data/lib/ory-client/models/internal_is_ax_welcome_screen_enabled_for_project_body.rb +1 -1
  250. data/lib/ory-client/models/internal_is_owner_for_project_by_slug.rb +1 -1
  251. data/lib/ory-client/models/internal_is_owner_for_project_by_slug_body.rb +3 -3
  252. data/lib/ory-client/models/introspected_o_auth2_token.rb +1 -1
  253. data/lib/ory-client/models/invite_token_body.rb +1 -1
  254. data/lib/ory-client/models/invoice.rb +2 -16
  255. data/lib/ory-client/models/invoice_data_v1.rb +1 -1
  256. data/lib/ory-client/models/ip_restriction.rb +1 -1
  257. data/lib/ory-client/models/is_owner_for_project_by_slug.rb +1 -1
  258. data/lib/ory-client/models/issue_api_key_request.rb +1 -1
  259. data/lib/ory-client/models/issue_api_key_response.rb +1 -1
  260. data/lib/ory-client/models/issued_api_key.rb +1 -1
  261. data/lib/ory-client/models/json_patch.rb +1 -1
  262. data/lib/ory-client/models/json_web_key.rb +1 -1
  263. data/lib/ory-client/models/json_web_key_set.rb +1 -1
  264. data/lib/ory-client/models/keto_namespace.rb +1 -1
  265. data/lib/ory-client/models/key_state.rb +1 -1
  266. data/lib/ory-client/models/key_status.rb +1 -1
  267. data/lib/ory-client/models/key_visibility.rb +1 -1
  268. data/lib/ory-client/models/keyset_pagination_request_parameters.rb +1 -1
  269. data/lib/ory-client/models/keyset_pagination_response_headers.rb +2 -2
  270. data/lib/ory-client/models/line_item_v1.rb +1 -1
  271. data/lib/ory-client/models/list_event_streams.rb +1 -1
  272. data/lib/ory-client/models/list_imported_api_keys_response.rb +1 -1
  273. data/lib/ory-client/models/list_invoices_response.rb +1 -1
  274. data/lib/ory-client/models/list_issued_api_keys_response.rb +1 -1
  275. data/lib/ory-client/models/list_organizations_response.rb +1 -1
  276. data/lib/ory-client/models/list_workspace_contacts.rb +218 -0
  277. data/lib/ory-client/models/list_workspace_projects.rb +1 -1
  278. data/lib/ory-client/models/list_workspaces.rb +1 -1
  279. data/lib/ory-client/models/login_flow.rb +18 -5
  280. data/lib/ory-client/models/login_flow_state.rb +1 -1
  281. data/lib/ory-client/models/login_flow_test_context.rb +1 -1
  282. data/lib/ory-client/models/login_flow_test_debug_payload.rb +1 -1
  283. data/lib/ory-client/models/login_flow_test_schema_validation_error.rb +1 -1
  284. data/lib/ory-client/models/login_flow_test_step_error.rb +1 -1
  285. data/lib/ory-client/models/logout_flow.rb +1 -1
  286. data/lib/ory-client/models/manage_sessions_body.rb +2 -2
  287. data/lib/ory-client/models/manage_sessions_response.rb +1 -1
  288. data/lib/ory-client/models/managed_identity_schema.rb +1 -1
  289. data/lib/ory-client/models/managed_identity_schema_validation_result.rb +1 -1
  290. data/lib/ory-client/models/member_invite.rb +1 -1
  291. data/lib/ory-client/models/message.rb +2 -2
  292. data/lib/ory-client/models/message_dispatch.rb +1 -1
  293. data/lib/ory-client/models/metrics_datapoint.rb +1 -1
  294. data/lib/ory-client/models/namespace.rb +1 -1
  295. data/lib/ory-client/models/needs_privileged_session_error.rb +1 -1
  296. data/lib/ory-client/models/normalized_project.rb +1 -1
  297. data/lib/ory-client/models/normalized_project_revision.rb +70 -8
  298. data/lib/ory-client/models/normalized_project_revision_courier_channel.rb +2 -2
  299. data/lib/ory-client/models/normalized_project_revision_hook.rb +1 -1
  300. data/lib/ory-client/models/normalized_project_revision_identity_schema.rb +1 -1
  301. data/lib/ory-client/models/normalized_project_revision_saml_provider.rb +13 -3
  302. data/lib/ory-client/models/normalized_project_revision_scim_client.rb +1 -1
  303. data/lib/ory-client/models/normalized_project_revision_third_party_provider.rb +15 -5
  304. data/lib/ory-client/models/normalized_project_revision_tokenizer_template.rb +2 -2
  305. data/lib/ory-client/models/null_value.rb +1 -1
  306. data/lib/ory-client/models/o_auth2_client.rb +4 -4
  307. data/lib/ory-client/models/o_auth2_client_token_lifespans.rb +1 -1
  308. data/lib/ory-client/models/o_auth2_consent_request.rb +1 -1
  309. data/lib/ory-client/models/o_auth2_consent_request_open_id_connect_context.rb +2 -2
  310. data/lib/ory-client/models/o_auth2_consent_session.rb +1 -1
  311. data/lib/ory-client/models/o_auth2_login_request.rb +1 -1
  312. data/lib/ory-client/models/o_auth2_logout_request.rb +1 -1
  313. data/lib/ory-client/models/o_auth2_redirect_to.rb +1 -1
  314. data/lib/ory-client/models/o_auth2_token_exchange.rb +1 -1
  315. data/lib/ory-client/models/oidc_configuration.rb +1 -1
  316. data/lib/ory-client/models/oidc_user_info.rb +1 -1
  317. data/lib/ory-client/models/onboarding_portal_link.rb +1 -1
  318. data/lib/ory-client/models/onboarding_portal_organization.rb +1 -1
  319. data/lib/ory-client/models/onboarding_portal_test_login_flow.rb +1 -1
  320. data/lib/ory-client/models/opl_parse_error.rb +165 -0
  321. data/lib/ory-client/models/opl_source_position.rb +156 -0
  322. data/lib/ory-client/models/opl_validate_result.rb +149 -0
  323. data/lib/ory-client/models/organization.rb +1 -1
  324. data/lib/ory-client/models/organization_body.rb +1 -1
  325. data/lib/ory-client/models/organization_by_hostname.rb +1 -1
  326. data/lib/ory-client/models/organization_onboarding_portal_links_response.rb +1 -1
  327. data/lib/ory-client/models/parse_error.rb +1 -1
  328. data/lib/ory-client/models/patch_identities_body.rb +15 -5
  329. data/lib/ory-client/models/patch_workspace_contact_body.rb +183 -0
  330. data/lib/ory-client/models/patch_workspace_member_body.rb +1 -1
  331. data/lib/ory-client/models/perform_native_logout_body.rb +1 -1
  332. data/lib/ory-client/models/permissions_on_workspace.rb +1 -1
  333. data/lib/ory-client/models/pin_config.rb +1 -1
  334. data/lib/ory-client/models/plan_details.rb +1 -1
  335. data/lib/ory-client/models/post_check_permission_body.rb +1 -1
  336. data/lib/ory-client/models/post_check_permission_or_error_body.rb +1 -1
  337. data/lib/ory-client/models/project.rb +1 -1
  338. data/lib/ory-client/models/project_api_key.rb +2 -1
  339. data/lib/ory-client/models/project_branding.rb +1 -1
  340. data/lib/ory-client/models/project_branding_colors.rb +1 -1
  341. data/lib/ory-client/models/project_branding_theme.rb +1 -1
  342. data/lib/ory-client/models/project_cors.rb +1 -1
  343. data/lib/ory-client/models/project_events_datapoint.rb +1 -1
  344. data/lib/ory-client/models/project_host.rb +1 -1
  345. data/lib/ory-client/models/project_member.rb +1 -1
  346. data/lib/ory-client/models/project_metadata.rb +1 -1
  347. data/lib/ory-client/models/project_service_account_experience.rb +1 -1
  348. data/lib/ory-client/models/project_service_identity.rb +1 -1
  349. data/lib/ory-client/models/project_service_o_auth2.rb +1 -1
  350. data/lib/ory-client/models/project_service_permission.rb +1 -1
  351. data/lib/ory-client/models/project_service_talos.rb +1 -1
  352. data/lib/ory-client/models/project_services.rb +1 -1
  353. data/lib/ory-client/models/provider.rb +2 -2
  354. data/lib/ory-client/models/quota_usage.rb +4 -4
  355. data/lib/ory-client/models/rate_limit_policy.rb +3 -2
  356. data/lib/ory-client/models/recovery_code_for_identity.rb +1 -1
  357. data/lib/ory-client/models/recovery_flow.rb +39 -4
  358. data/lib/ory-client/models/recovery_flow_state.rb +6 -2
  359. data/lib/ory-client/models/recovery_identity_address.rb +1 -1
  360. data/lib/ory-client/models/recovery_link_for_identity.rb +1 -1
  361. data/lib/ory-client/models/registration_flow.rb +18 -5
  362. data/lib/ory-client/models/registration_flow_state.rb +1 -1
  363. data/lib/ory-client/models/reject_o_auth2_request.rb +1 -1
  364. data/lib/ory-client/models/relation_query.rb +1 -1
  365. data/lib/ory-client/models/relationship.rb +1 -1
  366. data/lib/ory-client/models/relationship_namespaces.rb +1 -1
  367. data/lib/ory-client/models/relationship_patch.rb +1 -1
  368. data/lib/ory-client/models/relationships.rb +1 -1
  369. data/lib/ory-client/models/revision_account_experience_custom_translation.rb +1 -1
  370. data/lib/ory-client/models/revocation_reason.rb +1 -1
  371. data/lib/ory-client/models/rfc6749_error_json.rb +1 -1
  372. data/lib/ory-client/models/rotate_issued_api_key_response.rb +1 -1
  373. data/lib/ory-client/models/rotate_o_auth2_client_secret_body.rb +149 -0
  374. data/lib/ory-client/models/rotate_talos_key_body.rb +1 -1
  375. data/lib/ory-client/models/schema_patch.rb +1 -1
  376. data/lib/ory-client/models/self_revoke_api_key_request.rb +1 -1
  377. data/lib/ory-client/models/self_service_flow_expired_error.rb +1 -1
  378. data/lib/ory-client/models/session.rb +1 -1
  379. data/lib/ory-client/models/session_activity_datapoint.rb +1 -1
  380. data/lib/ory-client/models/session_authentication_method.rb +12 -3
  381. data/lib/ory-client/models/session_device.rb +1 -1
  382. data/lib/ory-client/models/set_custom_domain_body.rb +1 -1
  383. data/lib/ory-client/models/set_event_stream_body.rb +1 -1
  384. data/lib/ory-client/models/set_organization_from_onboarding_portal_link_body.rb +1 -1
  385. data/lib/ory-client/models/set_project.rb +1 -1
  386. data/lib/ory-client/models/set_project_branding_theme_body.rb +1 -1
  387. data/lib/ory-client/models/settings_flow.rb +39 -4
  388. data/lib/ory-client/models/settings_flow_state.rb +1 -1
  389. data/lib/ory-client/models/source_position.rb +1 -1
  390. data/lib/ory-client/models/status.rb +1 -1
  391. data/lib/ory-client/models/subject_set.rb +1 -1
  392. data/lib/ory-client/models/subscription.rb +3 -1
  393. data/lib/ory-client/models/successful_code_exchange_response.rb +1 -1
  394. data/lib/ory-client/models/successful_native_login.rb +1 -1
  395. data/lib/ory-client/models/successful_native_registration.rb +1 -1
  396. data/lib/ory-client/models/successful_project_update.rb +1 -1
  397. data/lib/ory-client/models/talos_retired_value.rb +1 -1
  398. data/lib/ory-client/models/tax_line_item.rb +1 -1
  399. data/lib/ory-client/models/time_interval.rb +1 -1
  400. data/lib/ory-client/models/token.rb +1 -1
  401. data/lib/ory-client/models/token_algorithm.rb +1 -1
  402. data/lib/ory-client/models/token_pagination.rb +1 -1
  403. data/lib/ory-client/models/token_pagination_headers.rb +3 -3
  404. data/lib/ory-client/models/token_pagination_request_parameters.rb +1 -1
  405. data/lib/ory-client/models/token_pagination_response_headers.rb +2 -2
  406. data/lib/ory-client/models/trust_o_auth2_jwt_grant_issuer.rb +1 -1
  407. data/lib/ory-client/models/trusted_o_auth2_jwt_grant_issuer.rb +1 -1
  408. data/lib/ory-client/models/trusted_o_auth2_jwt_grant_json_web_key.rb +1 -1
  409. data/lib/ory-client/models/ui_container.rb +1 -1
  410. data/lib/ory-client/models/ui_node.rb +1 -1
  411. data/lib/ory-client/models/ui_node_anchor_attributes.rb +1 -1
  412. data/lib/ory-client/models/ui_node_attributes.rb +1 -1
  413. data/lib/ory-client/models/ui_node_division_attributes.rb +1 -1
  414. data/lib/ory-client/models/ui_node_image_attributes.rb +1 -1
  415. data/lib/ory-client/models/ui_node_input_attributes.rb +1 -1
  416. data/lib/ory-client/models/ui_node_input_attributes_option.rb +1 -1
  417. data/lib/ory-client/models/ui_node_meta.rb +1 -1
  418. data/lib/ory-client/models/ui_node_script_attributes.rb +1 -1
  419. data/lib/ory-client/models/ui_node_text_attributes.rb +1 -1
  420. data/lib/ory-client/models/ui_text.rb +1 -1
  421. data/lib/ory-client/models/update_fedcm_flow_body.rb +1 -1
  422. data/lib/ory-client/models/update_identity_body.rb +1 -1
  423. data/lib/ory-client/models/update_login_flow_body.rb +1 -1
  424. data/lib/ory-client/models/update_login_flow_with_code_method.rb +1 -1
  425. data/lib/ory-client/models/update_login_flow_with_device_authn_method.rb +1 -1
  426. data/lib/ory-client/models/update_login_flow_with_identifier_first_method.rb +1 -1
  427. data/lib/ory-client/models/update_login_flow_with_lookup_secret_method.rb +1 -1
  428. data/lib/ory-client/models/update_login_flow_with_oidc_method.rb +3 -3
  429. data/lib/ory-client/models/update_login_flow_with_passkey_method.rb +1 -1
  430. data/lib/ory-client/models/update_login_flow_with_password_method.rb +1 -1
  431. data/lib/ory-client/models/update_login_flow_with_saml_method.rb +1 -1
  432. data/lib/ory-client/models/update_login_flow_with_totp_method.rb +1 -1
  433. data/lib/ory-client/models/update_login_flow_with_web_authn_method.rb +1 -1
  434. data/lib/ory-client/models/update_organization_onboarding_portal_link_body.rb +2 -1
  435. data/lib/ory-client/models/update_recovery_flow_body.rb +1 -1
  436. data/lib/ory-client/models/update_recovery_flow_with_code_method.rb +1 -1
  437. data/lib/ory-client/models/update_recovery_flow_with_link_method.rb +1 -1
  438. data/lib/ory-client/models/update_registration_flow_body.rb +1 -1
  439. data/lib/ory-client/models/update_registration_flow_with_code_method.rb +1 -1
  440. data/lib/ory-client/models/update_registration_flow_with_oidc_method.rb +3 -3
  441. data/lib/ory-client/models/update_registration_flow_with_passkey_method.rb +1 -1
  442. data/lib/ory-client/models/update_registration_flow_with_password_method.rb +1 -1
  443. data/lib/ory-client/models/update_registration_flow_with_profile_method.rb +1 -1
  444. data/lib/ory-client/models/update_registration_flow_with_saml_method.rb +1 -1
  445. data/lib/ory-client/models/update_registration_flow_with_web_authn_method.rb +1 -1
  446. data/lib/ory-client/models/update_settings_flow_body.rb +1 -1
  447. data/lib/ory-client/models/update_settings_flow_with_device_authn_method.rb +1 -1
  448. data/lib/ory-client/models/update_settings_flow_with_device_authn_method_register.rb +1 -1
  449. data/lib/ory-client/models/update_settings_flow_with_device_authn_method_rotate_secret.rb +1 -1
  450. data/lib/ory-client/models/update_settings_flow_with_lookup_method.rb +1 -1
  451. data/lib/ory-client/models/update_settings_flow_with_oidc_method.rb +17 -7
  452. data/lib/ory-client/models/update_settings_flow_with_passkey_method.rb +1 -1
  453. data/lib/ory-client/models/update_settings_flow_with_password_method.rb +1 -1
  454. data/lib/ory-client/models/update_settings_flow_with_profile_method.rb +1 -1
  455. data/lib/ory-client/models/update_settings_flow_with_saml_method.rb +5 -5
  456. data/lib/ory-client/models/update_settings_flow_with_totp_method.rb +1 -1
  457. data/lib/ory-client/models/update_settings_flow_with_web_authn_method.rb +1 -1
  458. data/lib/ory-client/models/update_subscription_body.rb +2 -2
  459. data/lib/ory-client/models/update_verification_flow_body.rb +1 -1
  460. data/lib/ory-client/models/update_verification_flow_with_code_method.rb +1 -1
  461. data/lib/ory-client/models/update_verification_flow_with_link_method.rb +1 -1
  462. data/lib/ory-client/models/update_workspace_body.rb +1 -1
  463. data/lib/ory-client/models/update_workspace_organization_body.rb +1 -1
  464. data/lib/ory-client/models/usage.rb +1 -1
  465. data/lib/ory-client/models/user_verification.rb +1 -1
  466. data/lib/ory-client/models/validate_base_url_rewrite_request.rb +1 -1
  467. data/lib/ory-client/models/validate_base_url_rewrite_response.rb +1 -1
  468. data/lib/ory-client/models/verifiable_credential_priming_response.rb +1 -1
  469. data/lib/ory-client/models/verifiable_credential_proof.rb +1 -1
  470. data/lib/ory-client/models/verifiable_credential_response.rb +1 -1
  471. data/lib/ory-client/models/verifiable_identity_address.rb +1 -1
  472. data/lib/ory-client/models/verification_error_code.rb +1 -1
  473. data/lib/ory-client/models/verification_flow.rb +39 -4
  474. data/lib/ory-client/models/verification_flow_state.rb +1 -1
  475. data/lib/ory-client/models/verify_api_key_request.rb +1 -1
  476. data/lib/ory-client/models/verify_api_key_response.rb +1 -1
  477. data/lib/ory-client/models/verify_user_code_request.rb +1 -1
  478. data/lib/ory-client/models/version.rb +1 -1
  479. data/lib/ory-client/models/warning.rb +1 -1
  480. data/lib/ory-client/models/web_authn_related_origins.rb +168 -0
  481. data/lib/ory-client/models/workspace.rb +1 -1
  482. data/lib/ory-client/models/workspace_api_key.rb +2 -1
  483. data/lib/ory-client/models/workspace_contact.rb +210 -0
  484. data/lib/ory-client/models/{plan.rb → workspace_contact_recipient.rb} +26 -53
  485. data/lib/ory-client/models/workspace_contact_recipient_input.rb +158 -0
  486. data/lib/ory-client/models/workspace_organization.rb +14 -2
  487. data/lib/ory-client/version.rb +2 -2
  488. data/lib/ory-client.rb +16 -2
  489. data/ory-client.gemspec +1 -1
  490. data/spec/api/api_keys_api_spec.rb +3 -3
  491. data/spec/api/courier_api_spec.rb +1 -1
  492. data/spec/api/elements_api_spec.rb +1 -1
  493. data/spec/api/events_api_spec.rb +1 -1
  494. data/spec/api/frontend_api_spec.rb +106 -17
  495. data/spec/api/identity_api_spec.rb +8 -8
  496. data/spec/api/jwk_api_spec.rb +6 -6
  497. data/spec/api/metadata_api_spec.rb +1 -1
  498. data/spec/api/o_auth2_api_spec.rb +3 -2
  499. data/spec/api/oidc_api_spec.rb +2 -2
  500. data/spec/api/permission_api_spec.rb +1 -1
  501. data/spec/api/project_api_spec.rb +16 -3
  502. data/spec/api/relationship_api_spec.rb +1 -1
  503. data/spec/api/wellknown_api_spec.rb +1 -1
  504. data/spec/api/workspace_api_spec.rb +1 -1
  505. data/spec/models/accept_device_user_code_request_spec.rb +1 -1
  506. data/spec/models/accept_o_auth2_consent_request_session_spec.rb +1 -1
  507. data/spec/models/accept_o_auth2_consent_request_spec.rb +1 -1
  508. data/spec/models/accept_o_auth2_login_request_spec.rb +1 -1
  509. data/spec/models/account_experience_colors_spec.rb +1 -1
  510. data/spec/models/account_experience_configuration_spec.rb +1 -1
  511. data/spec/models/add_project_to_workspace_body_spec.rb +1 -1
  512. data/spec/models/add_workspace_organization_domain_body_spec.rb +36 -0
  513. data/spec/models/admin_identity_import_credentials_lookup_secret_config_spec.rb +1 -1
  514. data/spec/models/admin_identity_import_credentials_lookup_secret_spec.rb +1 -1
  515. data/spec/models/admin_revoke_imported_api_key_body_spec.rb +1 -1
  516. data/spec/models/admin_revoke_issued_api_key_body_spec.rb +1 -1
  517. data/spec/models/admin_rotate_issued_api_key_body_spec.rb +1 -1
  518. data/spec/models/admin_update_imported_api_key_request_spec.rb +1 -1
  519. data/spec/models/admin_update_issued_api_key_request_spec.rb +1 -1
  520. data/spec/models/ai_assistant_session_token_spec.rb +42 -0
  521. data/spec/models/any_spec.rb +1 -1
  522. data/spec/models/attribute_filter_spec.rb +1 -1
  523. data/spec/models/attribute_spec.rb +1 -1
  524. data/spec/models/attributes_count_datapoint_spec.rb +1 -1
  525. data/spec/models/authenticator_assurance_level_spec.rb +1 -1
  526. data/spec/models/basic_organization_spec.rb +1 -1
  527. data/spec/models/batch_check_permission_body_spec.rb +1 -1
  528. data/spec/models/batch_check_permission_result_spec.rb +1 -1
  529. data/spec/models/batch_create_imported_api_keys_error_code_spec.rb +1 -1
  530. data/spec/models/batch_create_imported_api_keys_request_spec.rb +1 -1
  531. data/spec/models/batch_create_imported_api_keys_response_spec.rb +1 -1
  532. data/spec/models/batch_create_imported_api_keys_result_spec.rb +1 -1
  533. data/spec/models/batch_patch_identities_response_spec.rb +1 -1
  534. data/spec/models/batch_verify_api_keys_request_spec.rb +1 -1
  535. data/spec/models/batch_verify_api_keys_response_spec.rb +1 -1
  536. data/spec/models/billing_period_bucket_spec.rb +1 -1
  537. data/spec/models/check_opl_syntax_result_spec.rb +1 -1
  538. data/spec/models/check_permission_result_spec.rb +1 -1
  539. data/spec/models/check_permission_result_with_error_spec.rb +1 -1
  540. data/spec/models/cloud_account_spec.rb +1 -1
  541. data/spec/models/continue_with_device_authn_pin_entry_ui_data_spec.rb +1 -1
  542. data/spec/models/continue_with_device_authn_pin_entry_ui_spec.rb +1 -1
  543. data/spec/models/continue_with_recovery_ui_flow_spec.rb +1 -1
  544. data/spec/models/continue_with_recovery_ui_spec.rb +1 -1
  545. data/spec/models/continue_with_redirect_browser_to_spec.rb +1 -1
  546. data/spec/models/continue_with_set_ory_session_token_spec.rb +1 -1
  547. data/spec/models/continue_with_settings_ui_flow_spec.rb +1 -1
  548. data/spec/models/continue_with_settings_ui_spec.rb +1 -1
  549. data/spec/models/continue_with_spec.rb +1 -1
  550. data/spec/models/continue_with_verification_ui_flow_spec.rb +1 -1
  551. data/spec/models/continue_with_verification_ui_spec.rb +1 -1
  552. data/spec/models/courier_message_status_spec.rb +1 -1
  553. data/spec/models/courier_message_type_spec.rb +1 -1
  554. data/spec/models/create_custom_domain_body_spec.rb +1 -1
  555. data/spec/models/create_event_stream_body_spec.rb +1 -1
  556. data/spec/models/create_fedcm_flow_response_spec.rb +1 -1
  557. data/spec/models/create_identity_body_spec.rb +1 -1
  558. data/spec/models/create_invite_response_spec.rb +1 -1
  559. data/spec/models/create_json_web_key_set_spec.rb +1 -1
  560. data/spec/models/create_onboarding_link_response_spec.rb +1 -1
  561. data/spec/models/create_organization_onboarding_portal_link_body_spec.rb +1 -1
  562. data/spec/models/create_project_api_key_body_spec.rb +1 -1
  563. data/spec/models/create_project_body_spec.rb +1 -1
  564. data/spec/models/create_project_branding_spec.rb +1 -1
  565. data/spec/models/create_project_member_invite_body_spec.rb +1 -1
  566. data/spec/models/create_project_normalized_payload_spec.rb +37 -1
  567. data/spec/models/create_recovery_code_for_identity_body_spec.rb +1 -1
  568. data/spec/models/create_recovery_link_for_identity_body_spec.rb +1 -1
  569. data/spec/models/create_relationship_body_spec.rb +1 -1
  570. data/spec/models/create_subscription_body_spec.rb +1 -1
  571. data/spec/models/create_subscription_common_spec.rb +1 -1
  572. data/spec/models/create_test_login_flow_body_spec.rb +1 -1
  573. data/spec/models/create_test_login_flow_from_onboarding_portal_link_body_spec.rb +1 -1
  574. data/spec/models/create_verifiable_credential_request_body_spec.rb +1 -1
  575. data/spec/models/create_workspace_api_key_body_spec.rb +1 -1
  576. data/spec/models/create_workspace_body_spec.rb +1 -1
  577. data/spec/models/create_workspace_contact_body_spec.rb +60 -0
  578. data/spec/models/create_workspace_member_invite_body_spec.rb +1 -1
  579. data/spec/models/create_workspace_organization_body_spec.rb +1 -1
  580. data/spec/models/create_workspace_subscription_body_spec.rb +1 -1
  581. data/spec/models/credential_supported_draft00_spec.rb +1 -1
  582. data/spec/models/custom_domain_spec.rb +1 -1
  583. data/spec/models/customer_portal_availability_spec.rb +1 -1
  584. data/spec/models/delete_my_sessions_count_spec.rb +1 -1
  585. data/spec/models/derive_token_request_spec.rb +1 -1
  586. data/spec/models/derive_token_response_spec.rb +1 -1
  587. data/spec/models/device_authn_android_authorization_list_spec.rb +1 -1
  588. data/spec/models/device_authn_android_key_description_spec.rb +1 -1
  589. data/spec/models/device_authn_android_root_of_trust_spec.rb +1 -1
  590. data/spec/models/device_authn_attestation_spec.rb +1 -1
  591. data/spec/models/device_authn_ios_att_stmt_spec.rb +1 -1
  592. data/spec/models/device_authn_ios_attestation_spec.rb +1 -1
  593. data/spec/models/device_authn_key_spec.rb +1 -1
  594. data/spec/models/device_authorization_spec.rb +1 -1
  595. data/spec/models/device_type_spec.rb +1 -1
  596. data/spec/models/device_user_auth_request_spec.rb +1 -1
  597. data/spec/models/domain_verification_status_spec.rb +74 -0
  598. data/spec/models/elements_configuration_spec.rb +1 -1
  599. data/spec/models/email_template_data_body_spec.rb +1 -1
  600. data/spec/models/email_template_data_spec.rb +1 -1
  601. data/spec/models/error_authenticator_assurance_level_not_satisfied_spec.rb +1 -1
  602. data/spec/models/error_browser_location_change_required_spec.rb +1 -1
  603. data/spec/models/error_flow_replaced_spec.rb +1 -1
  604. data/spec/models/error_generic_spec.rb +1 -1
  605. data/spec/models/error_o_auth2_spec.rb +1 -1
  606. data/spec/models/event_stream_spec.rb +7 -1
  607. data/spec/models/expanded_permission_tree_spec.rb +1 -1
  608. data/spec/models/feature_flags_catalog_entry_spec.rb +60 -0
  609. data/spec/models/flow_error_spec.rb +1 -1
  610. data/spec/models/generic_error_content_spec.rb +1 -1
  611. data/spec/models/generic_error_spec.rb +1 -1
  612. data/spec/models/generic_oidc_provider_spec.rb +1 -1
  613. data/spec/models/generic_usage_spec.rb +1 -1
  614. data/spec/models/get_attributes_count_spec.rb +1 -1
  615. data/spec/models/get_jwks_response_jwks_keys_inner_spec.rb +1 -1
  616. data/spec/models/get_jwks_response_jwks_spec.rb +1 -1
  617. data/spec/models/get_jwks_response_spec.rb +1 -1
  618. data/spec/models/get_managed_identity_schema_location_spec.rb +1 -1
  619. data/spec/models/get_metrics_count_spec.rb +1 -1
  620. data/spec/models/get_metrics_event_attributes_spec.rb +1 -1
  621. data/spec/models/get_metrics_event_types_spec.rb +1 -1
  622. data/spec/models/get_organization_response_spec.rb +1 -1
  623. data/spec/models/get_organizations_by_hostname_response_spec.rb +1 -1
  624. data/spec/models/get_project_events_body_spec.rb +1 -1
  625. data/spec/models/get_project_events_spec.rb +1 -1
  626. data/spec/models/get_project_metrics_spec.rb +1 -1
  627. data/spec/models/get_session_activity_spec.rb +1 -1
  628. data/spec/models/get_version200_response_spec.rb +1 -1
  629. data/spec/models/health_not_ready_status_spec.rb +1 -1
  630. data/spec/models/health_status_spec.rb +1 -1
  631. data/spec/models/identity_credentials_code_address_spec.rb +1 -1
  632. data/spec/models/identity_credentials_code_spec.rb +1 -1
  633. data/spec/models/identity_credentials_lookup_secret_code_spec.rb +1 -1
  634. data/spec/models/identity_credentials_oidc_provider_spec.rb +1 -1
  635. data/spec/models/identity_credentials_oidc_spec.rb +1 -1
  636. data/spec/models/identity_credentials_password_spec.rb +1 -1
  637. data/spec/models/identity_credentials_spec.rb +1 -1
  638. data/spec/models/identity_credentials_web_authn_attestation_spec.rb +1 -1
  639. data/spec/models/identity_credentials_web_authn_authenticator_spec.rb +1 -1
  640. data/spec/models/identity_credentials_web_authn_flags_spec.rb +1 -1
  641. data/spec/models/identity_credentials_web_authn_spec.rb +1 -1
  642. data/spec/models/identity_patch_response_spec.rb +1 -1
  643. data/spec/models/identity_patch_spec.rb +1 -1
  644. data/spec/models/identity_schema_container_spec.rb +1 -1
  645. data/spec/models/identity_schema_preset_spec.rb +1 -1
  646. data/spec/models/identity_spec.rb +1 -1
  647. data/spec/models/identity_with_credentials_oidc_config_provider_spec.rb +1 -1
  648. data/spec/models/identity_with_credentials_oidc_config_spec.rb +1 -1
  649. data/spec/models/identity_with_credentials_oidc_spec.rb +1 -1
  650. data/spec/models/identity_with_credentials_passkey_config_spec.rb +1 -1
  651. data/spec/models/identity_with_credentials_passkey_spec.rb +1 -1
  652. data/spec/models/identity_with_credentials_password_config_spec.rb +1 -1
  653. data/spec/models/identity_with_credentials_password_spec.rb +1 -1
  654. data/spec/models/identity_with_credentials_saml_config_provider_spec.rb +1 -1
  655. data/spec/models/identity_with_credentials_saml_config_spec.rb +1 -1
  656. data/spec/models/identity_with_credentials_saml_spec.rb +1 -1
  657. data/spec/models/identity_with_credentials_spec.rb +1 -1
  658. data/spec/models/identity_with_credentials_totp_config_spec.rb +1 -1
  659. data/spec/models/identity_with_credentials_totp_spec.rb +1 -1
  660. data/spec/models/identity_with_credentials_web_authn_config_spec.rb +1 -1
  661. data/spec/models/identity_with_credentials_web_authn_spec.rb +1 -1
  662. data/spec/models/import_api_key_request_spec.rb +1 -1
  663. data/spec/models/imported_api_key_spec.rb +1 -1
  664. data/spec/models/internal_get_project_branding_body_spec.rb +1 -1
  665. data/spec/models/internal_is_ax_welcome_screen_enabled_for_project_body_spec.rb +1 -1
  666. data/spec/models/internal_is_owner_for_project_by_slug_body_spec.rb +2 -2
  667. data/spec/models/internal_is_owner_for_project_by_slug_spec.rb +1 -1
  668. data/spec/models/introspected_o_auth2_token_spec.rb +1 -1
  669. data/spec/models/invite_token_body_spec.rb +1 -1
  670. data/spec/models/invoice_data_v1_spec.rb +1 -1
  671. data/spec/models/invoice_spec.rb +1 -1
  672. data/spec/models/ip_restriction_spec.rb +1 -1
  673. data/spec/models/is_owner_for_project_by_slug_spec.rb +1 -1
  674. data/spec/models/issue_api_key_request_spec.rb +1 -1
  675. data/spec/models/issue_api_key_response_spec.rb +1 -1
  676. data/spec/models/issued_api_key_spec.rb +1 -1
  677. data/spec/models/json_patch_spec.rb +1 -1
  678. data/spec/models/json_web_key_set_spec.rb +1 -1
  679. data/spec/models/json_web_key_spec.rb +1 -1
  680. data/spec/models/keto_namespace_spec.rb +1 -1
  681. data/spec/models/key_state_spec.rb +1 -1
  682. data/spec/models/key_status_spec.rb +1 -1
  683. data/spec/models/key_visibility_spec.rb +1 -1
  684. data/spec/models/keyset_pagination_request_parameters_spec.rb +1 -1
  685. data/spec/models/keyset_pagination_response_headers_spec.rb +1 -1
  686. data/spec/models/line_item_v1_spec.rb +1 -1
  687. data/spec/models/list_event_streams_spec.rb +1 -1
  688. data/spec/models/list_imported_api_keys_response_spec.rb +1 -1
  689. data/spec/models/list_invoices_response_spec.rb +1 -1
  690. data/spec/models/list_issued_api_keys_response_spec.rb +1 -1
  691. data/spec/models/list_organizations_response_spec.rb +1 -1
  692. data/spec/models/list_workspace_contacts_spec.rb +48 -0
  693. data/spec/models/list_workspace_projects_spec.rb +1 -1
  694. data/spec/models/list_workspaces_spec.rb +1 -1
  695. data/spec/models/login_flow_spec.rb +1 -1
  696. data/spec/models/login_flow_state_spec.rb +1 -1
  697. data/spec/models/login_flow_test_context_spec.rb +1 -1
  698. data/spec/models/login_flow_test_debug_payload_spec.rb +1 -1
  699. data/spec/models/login_flow_test_schema_validation_error_spec.rb +1 -1
  700. data/spec/models/login_flow_test_step_error_spec.rb +1 -1
  701. data/spec/models/logout_flow_spec.rb +1 -1
  702. data/spec/models/manage_sessions_body_spec.rb +1 -1
  703. data/spec/models/manage_sessions_response_spec.rb +1 -1
  704. data/spec/models/managed_identity_schema_spec.rb +1 -1
  705. data/spec/models/managed_identity_schema_validation_result_spec.rb +1 -1
  706. data/spec/models/member_invite_spec.rb +1 -1
  707. data/spec/models/message_dispatch_spec.rb +1 -1
  708. data/spec/models/message_spec.rb +1 -1
  709. data/spec/models/metrics_datapoint_spec.rb +1 -1
  710. data/spec/models/namespace_spec.rb +1 -1
  711. data/spec/models/needs_privileged_session_error_spec.rb +1 -1
  712. data/spec/models/normalized_project_revision_courier_channel_spec.rb +1 -1
  713. data/spec/models/normalized_project_revision_hook_spec.rb +1 -1
  714. data/spec/models/normalized_project_revision_identity_schema_spec.rb +1 -1
  715. data/spec/models/normalized_project_revision_saml_provider_spec.rb +7 -1
  716. data/spec/models/normalized_project_revision_scim_client_spec.rb +1 -1
  717. data/spec/models/normalized_project_revision_spec.rb +37 -1
  718. data/spec/models/normalized_project_revision_third_party_provider_spec.rb +7 -1
  719. data/spec/models/normalized_project_revision_tokenizer_template_spec.rb +1 -1
  720. data/spec/models/normalized_project_spec.rb +1 -1
  721. data/spec/models/null_value_spec.rb +1 -1
  722. data/spec/models/o_auth2_client_spec.rb +1 -1
  723. data/spec/models/o_auth2_client_token_lifespans_spec.rb +1 -1
  724. data/spec/models/o_auth2_consent_request_open_id_connect_context_spec.rb +1 -1
  725. data/spec/models/o_auth2_consent_request_spec.rb +1 -1
  726. data/spec/models/o_auth2_consent_session_spec.rb +1 -1
  727. data/spec/models/o_auth2_login_request_spec.rb +1 -1
  728. data/spec/models/o_auth2_logout_request_spec.rb +1 -1
  729. data/spec/models/o_auth2_redirect_to_spec.rb +1 -1
  730. data/spec/models/o_auth2_token_exchange_spec.rb +1 -1
  731. data/spec/models/oidc_configuration_spec.rb +1 -1
  732. data/spec/models/oidc_user_info_spec.rb +1 -1
  733. data/spec/models/onboarding_portal_link_spec.rb +1 -1
  734. data/spec/models/onboarding_portal_organization_spec.rb +1 -1
  735. data/spec/models/onboarding_portal_test_login_flow_spec.rb +1 -1
  736. data/spec/models/opl_parse_error_spec.rb +48 -0
  737. data/spec/models/{plan_spec.rb → opl_source_position_spec.rb} +9 -9
  738. data/spec/models/opl_validate_result_spec.rb +36 -0
  739. data/spec/models/organization_body_spec.rb +1 -1
  740. data/spec/models/organization_by_hostname_spec.rb +1 -1
  741. data/spec/models/organization_onboarding_portal_links_response_spec.rb +1 -1
  742. data/spec/models/organization_spec.rb +1 -1
  743. data/spec/models/parse_error_spec.rb +1 -1
  744. data/spec/models/patch_identities_body_spec.rb +7 -1
  745. data/spec/models/patch_workspace_contact_body_spec.rb +60 -0
  746. data/spec/models/patch_workspace_member_body_spec.rb +1 -1
  747. data/spec/models/perform_native_logout_body_spec.rb +1 -1
  748. data/spec/models/permissions_on_workspace_spec.rb +1 -1
  749. data/spec/models/pin_config_spec.rb +1 -1
  750. data/spec/models/plan_details_spec.rb +1 -1
  751. data/spec/models/post_check_permission_body_spec.rb +1 -1
  752. data/spec/models/post_check_permission_or_error_body_spec.rb +1 -1
  753. data/spec/models/project_api_key_spec.rb +1 -1
  754. data/spec/models/project_branding_colors_spec.rb +1 -1
  755. data/spec/models/project_branding_spec.rb +1 -1
  756. data/spec/models/project_branding_theme_spec.rb +1 -1
  757. data/spec/models/project_cors_spec.rb +1 -1
  758. data/spec/models/project_events_datapoint_spec.rb +1 -1
  759. data/spec/models/project_host_spec.rb +1 -1
  760. data/spec/models/project_member_spec.rb +1 -1
  761. data/spec/models/project_metadata_spec.rb +1 -1
  762. data/spec/models/project_service_account_experience_spec.rb +1 -1
  763. data/spec/models/project_service_identity_spec.rb +1 -1
  764. data/spec/models/project_service_o_auth2_spec.rb +1 -1
  765. data/spec/models/project_service_permission_spec.rb +1 -1
  766. data/spec/models/project_service_talos_spec.rb +1 -1
  767. data/spec/models/project_services_spec.rb +1 -1
  768. data/spec/models/project_spec.rb +1 -1
  769. data/spec/models/provider_spec.rb +1 -1
  770. data/spec/models/quota_usage_spec.rb +2 -2
  771. data/spec/models/rate_limit_policy_spec.rb +1 -1
  772. data/spec/models/recovery_code_for_identity_spec.rb +1 -1
  773. data/spec/models/recovery_flow_spec.rb +1 -1
  774. data/spec/models/recovery_flow_state_spec.rb +1 -1
  775. data/spec/models/recovery_identity_address_spec.rb +1 -1
  776. data/spec/models/recovery_link_for_identity_spec.rb +1 -1
  777. data/spec/models/registration_flow_spec.rb +1 -1
  778. data/spec/models/registration_flow_state_spec.rb +1 -1
  779. data/spec/models/reject_o_auth2_request_spec.rb +1 -1
  780. data/spec/models/relation_query_spec.rb +1 -1
  781. data/spec/models/relationship_namespaces_spec.rb +1 -1
  782. data/spec/models/relationship_patch_spec.rb +1 -1
  783. data/spec/models/relationship_spec.rb +1 -1
  784. data/spec/models/relationships_spec.rb +1 -1
  785. data/spec/models/revision_account_experience_custom_translation_spec.rb +1 -1
  786. data/spec/models/revocation_reason_spec.rb +1 -1
  787. data/spec/models/rfc6749_error_json_spec.rb +1 -1
  788. data/spec/models/rotate_issued_api_key_response_spec.rb +1 -1
  789. data/spec/models/rotate_o_auth2_client_secret_body_spec.rb +36 -0
  790. data/spec/models/rotate_talos_key_body_spec.rb +1 -1
  791. data/spec/models/schema_patch_spec.rb +1 -1
  792. data/spec/models/self_revoke_api_key_request_spec.rb +1 -1
  793. data/spec/models/self_service_flow_expired_error_spec.rb +1 -1
  794. data/spec/models/session_activity_datapoint_spec.rb +1 -1
  795. data/spec/models/session_authentication_method_spec.rb +7 -1
  796. data/spec/models/session_device_spec.rb +1 -1
  797. data/spec/models/session_spec.rb +1 -1
  798. data/spec/models/set_custom_domain_body_spec.rb +1 -1
  799. data/spec/models/set_event_stream_body_spec.rb +1 -1
  800. data/spec/models/set_organization_from_onboarding_portal_link_body_spec.rb +1 -1
  801. data/spec/models/set_project_branding_theme_body_spec.rb +1 -1
  802. data/spec/models/set_project_spec.rb +1 -1
  803. data/spec/models/settings_flow_spec.rb +1 -1
  804. data/spec/models/settings_flow_state_spec.rb +1 -1
  805. data/spec/models/source_position_spec.rb +1 -1
  806. data/spec/models/status_spec.rb +1 -1
  807. data/spec/models/subject_set_spec.rb +1 -1
  808. data/spec/models/subscription_spec.rb +1 -1
  809. data/spec/models/successful_code_exchange_response_spec.rb +1 -1
  810. data/spec/models/successful_native_login_spec.rb +1 -1
  811. data/spec/models/successful_native_registration_spec.rb +1 -1
  812. data/spec/models/successful_project_update_spec.rb +1 -1
  813. data/spec/models/talos_retired_value_spec.rb +1 -1
  814. data/spec/models/tax_line_item_spec.rb +1 -1
  815. data/spec/models/time_interval_spec.rb +1 -1
  816. data/spec/models/token_algorithm_spec.rb +1 -1
  817. data/spec/models/token_pagination_headers_spec.rb +1 -1
  818. data/spec/models/token_pagination_request_parameters_spec.rb +1 -1
  819. data/spec/models/token_pagination_response_headers_spec.rb +1 -1
  820. data/spec/models/token_pagination_spec.rb +1 -1
  821. data/spec/models/token_spec.rb +1 -1
  822. data/spec/models/trust_o_auth2_jwt_grant_issuer_spec.rb +1 -1
  823. data/spec/models/trusted_o_auth2_jwt_grant_issuer_spec.rb +1 -1
  824. data/spec/models/trusted_o_auth2_jwt_grant_json_web_key_spec.rb +1 -1
  825. data/spec/models/ui_container_spec.rb +1 -1
  826. data/spec/models/ui_node_anchor_attributes_spec.rb +1 -1
  827. data/spec/models/ui_node_attributes_spec.rb +1 -1
  828. data/spec/models/ui_node_division_attributes_spec.rb +1 -1
  829. data/spec/models/ui_node_image_attributes_spec.rb +1 -1
  830. data/spec/models/ui_node_input_attributes_option_spec.rb +1 -1
  831. data/spec/models/ui_node_input_attributes_spec.rb +1 -1
  832. data/spec/models/ui_node_meta_spec.rb +1 -1
  833. data/spec/models/ui_node_script_attributes_spec.rb +1 -1
  834. data/spec/models/ui_node_spec.rb +1 -1
  835. data/spec/models/ui_node_text_attributes_spec.rb +1 -1
  836. data/spec/models/ui_text_spec.rb +1 -1
  837. data/spec/models/update_fedcm_flow_body_spec.rb +1 -1
  838. data/spec/models/update_identity_body_spec.rb +1 -1
  839. data/spec/models/update_login_flow_body_spec.rb +1 -1
  840. data/spec/models/update_login_flow_with_code_method_spec.rb +1 -1
  841. data/spec/models/update_login_flow_with_device_authn_method_spec.rb +1 -1
  842. data/spec/models/update_login_flow_with_identifier_first_method_spec.rb +1 -1
  843. data/spec/models/update_login_flow_with_lookup_secret_method_spec.rb +1 -1
  844. data/spec/models/update_login_flow_with_oidc_method_spec.rb +1 -1
  845. data/spec/models/update_login_flow_with_passkey_method_spec.rb +1 -1
  846. data/spec/models/update_login_flow_with_password_method_spec.rb +1 -1
  847. data/spec/models/update_login_flow_with_saml_method_spec.rb +1 -1
  848. data/spec/models/update_login_flow_with_totp_method_spec.rb +1 -1
  849. data/spec/models/update_login_flow_with_web_authn_method_spec.rb +1 -1
  850. data/spec/models/update_organization_onboarding_portal_link_body_spec.rb +1 -1
  851. data/spec/models/update_recovery_flow_body_spec.rb +1 -1
  852. data/spec/models/update_recovery_flow_with_code_method_spec.rb +1 -1
  853. data/spec/models/update_recovery_flow_with_link_method_spec.rb +1 -1
  854. data/spec/models/update_registration_flow_body_spec.rb +1 -1
  855. data/spec/models/update_registration_flow_with_code_method_spec.rb +1 -1
  856. data/spec/models/update_registration_flow_with_oidc_method_spec.rb +1 -1
  857. data/spec/models/update_registration_flow_with_passkey_method_spec.rb +1 -1
  858. data/spec/models/update_registration_flow_with_password_method_spec.rb +1 -1
  859. data/spec/models/update_registration_flow_with_profile_method_spec.rb +1 -1
  860. data/spec/models/update_registration_flow_with_saml_method_spec.rb +1 -1
  861. data/spec/models/update_registration_flow_with_web_authn_method_spec.rb +1 -1
  862. data/spec/models/update_settings_flow_body_spec.rb +1 -1
  863. data/spec/models/update_settings_flow_with_device_authn_method_register_spec.rb +1 -1
  864. data/spec/models/update_settings_flow_with_device_authn_method_rotate_secret_spec.rb +1 -1
  865. data/spec/models/update_settings_flow_with_device_authn_method_spec.rb +1 -1
  866. data/spec/models/update_settings_flow_with_lookup_method_spec.rb +1 -1
  867. data/spec/models/update_settings_flow_with_oidc_method_spec.rb +7 -1
  868. data/spec/models/update_settings_flow_with_passkey_method_spec.rb +1 -1
  869. data/spec/models/update_settings_flow_with_password_method_spec.rb +1 -1
  870. data/spec/models/update_settings_flow_with_profile_method_spec.rb +1 -1
  871. data/spec/models/update_settings_flow_with_saml_method_spec.rb +1 -1
  872. data/spec/models/update_settings_flow_with_totp_method_spec.rb +1 -1
  873. data/spec/models/update_settings_flow_with_web_authn_method_spec.rb +1 -1
  874. data/spec/models/update_subscription_body_spec.rb +1 -1
  875. data/spec/models/update_verification_flow_body_spec.rb +1 -1
  876. data/spec/models/update_verification_flow_with_code_method_spec.rb +1 -1
  877. data/spec/models/update_verification_flow_with_link_method_spec.rb +1 -1
  878. data/spec/models/update_workspace_body_spec.rb +1 -1
  879. data/spec/models/update_workspace_organization_body_spec.rb +1 -1
  880. data/spec/models/usage_spec.rb +1 -1
  881. data/spec/models/user_verification_spec.rb +1 -1
  882. data/spec/models/validate_base_url_rewrite_request_spec.rb +1 -1
  883. data/spec/models/validate_base_url_rewrite_response_spec.rb +1 -1
  884. data/spec/models/verifiable_credential_priming_response_spec.rb +1 -1
  885. data/spec/models/verifiable_credential_proof_spec.rb +1 -1
  886. data/spec/models/verifiable_credential_response_spec.rb +1 -1
  887. data/spec/models/verifiable_identity_address_spec.rb +1 -1
  888. data/spec/models/verification_error_code_spec.rb +1 -1
  889. data/spec/models/verification_flow_spec.rb +1 -1
  890. data/spec/models/verification_flow_state_spec.rb +1 -1
  891. data/spec/models/verify_api_key_request_spec.rb +1 -1
  892. data/spec/models/verify_api_key_response_spec.rb +1 -1
  893. data/spec/models/verify_user_code_request_spec.rb +1 -1
  894. data/spec/models/version_spec.rb +1 -1
  895. data/spec/models/warning_spec.rb +1 -1
  896. data/spec/models/web_authn_related_origins_spec.rb +36 -0
  897. data/spec/models/workspace_api_key_spec.rb +1 -1
  898. data/spec/models/workspace_contact_recipient_input_spec.rb +42 -0
  899. data/spec/models/workspace_contact_recipient_spec.rb +48 -0
  900. data/spec/models/workspace_contact_spec.rb +78 -0
  901. data/spec/models/workspace_organization_spec.rb +7 -1
  902. data/spec/models/workspace_spec.rb +1 -1
  903. data/spec/spec_helper.rb +1 -1
  904. data/vendor/bundle/ruby/3.2.0/cache/io-console-0.9.4.gem +0 -0
  905. data/vendor/bundle/ruby/3.2.0/cache/reline-0.7.0.gem +0 -0
  906. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux-gnu/3.2.0/byebug-13.0.0/gem_make.out +5 -5
  907. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux-gnu/3.2.0/{io-console-0.8.2 → io-console-0.9.4}/gem_make.out +17 -14
  908. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux-gnu/3.2.0/io-console-0.9.4/io/console.so +0 -0
  909. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux-gnu/3.2.0/{io-console-0.8.2 → io-console-0.9.4}/mkmf.log +131 -93
  910. 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
  911. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux-gnu/3.2.0/psych-4.0.6/gem_make.out +5 -5
  912. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux-gnu/3.2.0/racc-1.8.1/gem_make.out +5 -5
  913. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux-gnu/3.2.0/stringio-3.2.0/gem_make.out +5 -5
  914. data/vendor/bundle/ruby/3.2.0/gems/{io-console-0.8.2 → io-console-0.9.4}/ext/io/console/Makefile +3 -3
  915. data/vendor/bundle/ruby/3.2.0/gems/{io-console-0.8.2 → io-console-0.9.4}/ext/io/console/console.c +621 -40
  916. data/vendor/bundle/ruby/3.2.0/gems/{io-console-0.8.2 → io-console-0.9.4}/ext/io/console/extconf.rb +39 -15
  917. data/vendor/bundle/ruby/3.2.0/gems/{io-console-0.8.2 → io-console-0.9.4}/ext/io/console/win32_vk.inc +313 -165
  918. data/vendor/bundle/ruby/3.2.0/gems/{io-console-0.8.2 → io-console-0.9.4}/lib/io/console/size.rb +4 -2
  919. data/vendor/bundle/ruby/3.2.0/gems/io-console-0.9.4/lib/io/console.so +0 -0
  920. data/vendor/bundle/ruby/3.2.0/gems/{reline-0.6.3 → reline-0.7.0}/lib/reline/io/ansi.rb +6 -4
  921. data/vendor/bundle/ruby/3.2.0/gems/{reline-0.6.3 → reline-0.7.0}/lib/reline/io/windows.rb +49 -23
  922. data/vendor/bundle/ruby/3.2.0/gems/{reline-0.6.3 → reline-0.7.0}/lib/reline/io.rb +8 -2
  923. data/vendor/bundle/ruby/3.2.0/gems/{reline-0.6.3 → reline-0.7.0}/lib/reline/line_editor.rb +49 -21
  924. data/vendor/bundle/ruby/3.2.0/gems/reline-0.7.0/lib/reline/version.rb +3 -0
  925. data/vendor/bundle/ruby/3.2.0/gems/{reline-0.6.3 → reline-0.7.0}/lib/reline.rb +10 -9
  926. data/vendor/bundle/ruby/3.2.0/specifications/{io-console-0.8.2.gemspec → io-console-0.9.4.gemspec} +3 -3
  927. data/vendor/bundle/ruby/3.2.0/specifications/{reline-0.6.3.gemspec → reline-0.7.0.gemspec} +2 -2
  928. metadata +108 -52
  929. data/docs/Plan.md +0 -20
  930. data/vendor/bundle/ruby/3.2.0/cache/io-console-0.8.2.gem +0 -0
  931. data/vendor/bundle/ruby/3.2.0/cache/reline-0.6.3.gem +0 -0
  932. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux-gnu/3.2.0/io-console-0.8.2/io/console.so +0 -0
  933. data/vendor/bundle/ruby/3.2.0/gems/io-console-0.8.2/lib/io/console.so +0 -0
  934. data/vendor/bundle/ruby/3.2.0/gems/reline-0.6.3/lib/reline/version.rb +0 -3
  935. data/vendor/bundle/ruby/3.2.0/extensions/x86_64-linux-gnu/3.2.0/{io-console-0.8.2 → io-console-0.9.4}/gem.build_complete +0 -0
  936. data/vendor/bundle/ruby/3.2.0/gems/{io-console-0.8.2 → io-console-0.9.4}/.document +0 -0
  937. data/vendor/bundle/ruby/3.2.0/gems/{io-console-0.8.2 → io-console-0.9.4}/BSDL +0 -0
  938. data/vendor/bundle/ruby/3.2.0/gems/{io-console-0.8.2 → io-console-0.9.4}/COPYING +0 -0
  939. data/vendor/bundle/ruby/3.2.0/gems/{io-console-0.8.2 → io-console-0.9.4}/README.md +0 -0
  940. data/vendor/bundle/ruby/3.2.0/gems/{reline-0.6.3 → reline-0.7.0}/BSDL +0 -0
  941. data/vendor/bundle/ruby/3.2.0/gems/{reline-0.6.3 → reline-0.7.0}/COPYING +0 -0
  942. data/vendor/bundle/ruby/3.2.0/gems/{reline-0.6.3 → reline-0.7.0}/README.md +0 -0
  943. data/vendor/bundle/ruby/3.2.0/gems/{reline-0.6.3 → reline-0.7.0}/lib/reline/config.rb +0 -0
  944. data/vendor/bundle/ruby/3.2.0/gems/{reline-0.6.3 → reline-0.7.0}/lib/reline/face.rb +0 -0
  945. data/vendor/bundle/ruby/3.2.0/gems/{reline-0.6.3 → reline-0.7.0}/lib/reline/history.rb +0 -0
  946. data/vendor/bundle/ruby/3.2.0/gems/{reline-0.6.3 → reline-0.7.0}/lib/reline/io/dumb.rb +0 -0
  947. data/vendor/bundle/ruby/3.2.0/gems/{reline-0.6.3 → reline-0.7.0}/lib/reline/key_actor/base.rb +0 -0
  948. data/vendor/bundle/ruby/3.2.0/gems/{reline-0.6.3 → reline-0.7.0}/lib/reline/key_actor/composite.rb +0 -0
  949. data/vendor/bundle/ruby/3.2.0/gems/{reline-0.6.3 → reline-0.7.0}/lib/reline/key_actor/emacs.rb +2 -2
  950. /data/vendor/bundle/ruby/3.2.0/gems/{reline-0.6.3 → reline-0.7.0}/lib/reline/key_actor/vi_command.rb +0 -0
  951. /data/vendor/bundle/ruby/3.2.0/gems/{reline-0.6.3 → reline-0.7.0}/lib/reline/key_actor/vi_insert.rb +0 -0
  952. /data/vendor/bundle/ruby/3.2.0/gems/{reline-0.6.3 → reline-0.7.0}/lib/reline/key_actor.rb +0 -0
  953. /data/vendor/bundle/ruby/3.2.0/gems/{reline-0.6.3 → reline-0.7.0}/lib/reline/key_stroke.rb +0 -0
  954. /data/vendor/bundle/ruby/3.2.0/gems/{reline-0.6.3 → reline-0.7.0}/lib/reline/kill_ring.rb +0 -0
  955. /data/vendor/bundle/ruby/3.2.0/gems/{reline-0.6.3 → reline-0.7.0}/lib/reline/unicode/east_asian_width.rb +0 -0
  956. /data/vendor/bundle/ruby/3.2.0/gems/{reline-0.6.3 → reline-0.7.0}/lib/reline/unicode.rb +0 -0
  957. /data/vendor/bundle/ruby/3.2.0/gems/{reline-0.6.3 → reline-0.7.0}/license_of_rb-readline +0 -0
@@ -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.66
6
+ The version of the OpenAPI document: v1.22.79
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.com/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.com/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. - `session_aal2_enrollment_required`: Second-factor auth is required but the identity has no second factor enrolled. Follow `redirect_browser_to` to the settings flow to enroll one. - `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'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 \"upgrade\" the session's security by asking the user to perform TOTP / WebAuth/ ... you would set this to \"aal2\".
@@ -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 `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).
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 `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. - `session_aal2_enrollment_required`: Second-factor auth is required but the identity has no second factor enrolled. Follow `redirect_browser_to` to the settings flow to enroll one. - `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).
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'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 \"upgrade\" the session's security by asking the user to perform TOTP / WebAuth/ ... you would set this to \"aal2\".
@@ -227,7 +227,7 @@ module OryClient
227
227
  end
228
228
 
229
229
  # Create Registration Flow for Browsers
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).
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).
231
231
  # @param [Hash] opts the optional parameters
232
232
  # @option opts [String] :return_to The URL to return the browser to after the flow was completed.
233
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 `login_challenge` URL Query parameter sent to your application (e.g. `/registration?login_challenge=abcde`). This feature is compatible with Ory Hydra when not running on the Ory Network.
@@ -241,7 +241,7 @@ module OryClient
241
241
  end
242
242
 
243
243
  # Create Registration Flow for Browsers
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 `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).
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 `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).
245
245
  # @param [Hash] opts the optional parameters
246
246
  # @option opts [String] :return_to The URL to return the browser to after the flow was completed.
247
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 `login_challenge` URL Query parameter sent to your application (e.g. `/registration?login_challenge=abcde`). This feature is compatible with Ory Hydra when not running on the Ory Network.
@@ -299,7 +299,7 @@ module OryClient
299
299
  end
300
300
 
301
301
  # Create Settings Flow for Browsers
302
- # This endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid Ory Kratos Session Cookie is included in the request, a login flow will be initialized. If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid user session was set, the browser will be redirected to the login endpoint. If this endpoint is called via an AJAX request, the response contains the settings flow without any redirects or a 401 forbidden error if no valid session was set. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor (happens automatically for server-side browser flows) or change the configuration. If this endpoint is called 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: `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `session_inactive`: No Ory Session was found - sign in a user first. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
302
+ # This endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid Ory Kratos Session Cookie is included in the request, a login flow will be initialized. If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid user session was set, the browser will be redirected to the login endpoint. If this endpoint is called via an AJAX request, the response contains the settings flow without any redirects or a 401 forbidden error if no valid session was set. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor (happens automatically for server-side browser flows) or change the configuration. If this endpoint is called 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: - `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. - `session_inactive`: No Ory Session was found - sign in a user first. - `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
303
303
  # @param [Hash] opts the optional parameters
304
304
  # @option opts [String] :return_to The URL to return the browser to after the flow was completed.
305
305
  # @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.
@@ -311,7 +311,7 @@ module OryClient
311
311
  end
312
312
 
313
313
  # Create Settings Flow for Browsers
314
- # This endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid Ory Kratos Session Cookie is included in the request, a login flow will be initialized. If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid user session was set, the browser will be redirected to the login endpoint. If this endpoint is called via an AJAX request, the response contains the settings flow without any redirects or a 401 forbidden error if no valid session was set. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor (happens automatically for server-side browser flows) or change the configuration. If this endpoint is called 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: `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `session_inactive`: No Ory Session was found - sign in a user first. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
314
+ # This endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid Ory Kratos Session Cookie is included in the request, a login flow will be initialized. If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid user session was set, the browser will be redirected to the login endpoint. If this endpoint is called via an AJAX request, the response contains the settings flow without any redirects or a 401 forbidden error if no valid session was set. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor (happens automatically for server-side browser flows) or change the configuration. If this endpoint is called 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: - `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. - `session_inactive`: No Ory Session was found - sign in a user first. - `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
315
315
  # @param [Hash] opts the optional parameters
316
316
  # @option opts [String] :return_to The URL to return the browser to after the flow was completed.
317
317
  # @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.
@@ -481,8 +481,78 @@ module OryClient
481
481
  return data, status_code, headers
482
482
  end
483
483
 
484
+ # Complete IdP-Initiated SAML Login for Browsers
485
+ # This endpoint is the entry point for IdP-initiated login through Ory Polis. Ory Polis redirects the browser here with a single-use authorization code after validating an unsolicited SAML response; Kratos then starts a regular browser login flow and forwards the code as a `code_hint` so Polis can complete the flow without a second round-trip to the identity provider. The provider must be a `jackson` provider with `idp_initiated_login_enabled` set to `true` in its configuration. This endpoint is NOT INTENDED for API clients and only works with browsers.
486
+ # @param provider [String] The SAML provider ID as configured in the Ory Kratos configuration.
487
+ # @param code [String] The single-use authorization code issued by Ory Polis for the unsolicited SAML response.
488
+ # @param [Hash] opts the optional parameters
489
+ # @return [ErrorGeneric]
490
+ def create_id_p_initiated_saml_browser_login_flow(provider, code, opts = {})
491
+ data, _status_code, _headers = create_id_p_initiated_saml_browser_login_flow_with_http_info(provider, code, opts)
492
+ data
493
+ end
494
+
495
+ # Complete IdP-Initiated SAML Login for Browsers
496
+ # This endpoint is the entry point for IdP-initiated login through Ory Polis. Ory Polis redirects the browser here with a single-use authorization code after validating an unsolicited SAML response; Kratos then starts a regular browser login flow and forwards the code as a `code_hint` so Polis can complete the flow without a second round-trip to the identity provider. The provider must be a `jackson` provider with `idp_initiated_login_enabled` set to `true` in its configuration. This endpoint is NOT INTENDED for API clients and only works with browsers.
497
+ # @param provider [String] The SAML provider ID as configured in the Ory Kratos configuration.
498
+ # @param code [String] The single-use authorization code issued by Ory Polis for the unsolicited SAML response.
499
+ # @param [Hash] opts the optional parameters
500
+ # @return [Array<(ErrorGeneric, Integer, Hash)>] ErrorGeneric data, response status code and response headers
501
+ def create_id_p_initiated_saml_browser_login_flow_with_http_info(provider, code, opts = {})
502
+ if @api_client.config.debugging
503
+ @api_client.config.logger.debug 'Calling API: FrontendApi.create_id_p_initiated_saml_browser_login_flow ...'
504
+ end
505
+ # verify the required parameter 'provider' is set
506
+ if @api_client.config.client_side_validation && provider.nil?
507
+ fail ArgumentError, "Missing the required parameter 'provider' when calling FrontendApi.create_id_p_initiated_saml_browser_login_flow"
508
+ end
509
+ # verify the required parameter 'code' is set
510
+ if @api_client.config.client_side_validation && code.nil?
511
+ fail ArgumentError, "Missing the required parameter 'code' when calling FrontendApi.create_id_p_initiated_saml_browser_login_flow"
512
+ end
513
+ # resource path
514
+ local_var_path = '/self-service/methods/saml/idp-initiated/{provider}'.sub('{' + 'provider' + '}', CGI.escape(provider.to_s))
515
+
516
+ # query parameters
517
+ query_params = opts[:query_params] || {}
518
+ query_params[:'code'] = code
519
+
520
+ # header parameters
521
+ header_params = opts[:header_params] || {}
522
+ # HTTP header 'Accept' (if needed)
523
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
524
+
525
+ # form parameters
526
+ form_params = opts[:form_params] || {}
527
+
528
+ # http body (model)
529
+ post_body = opts[:debug_body]
530
+
531
+ # return_type
532
+ return_type = opts[:debug_return_type] || 'ErrorGeneric'
533
+
534
+ # auth_names
535
+ auth_names = opts[:debug_auth_names] || []
536
+
537
+ new_options = opts.merge(
538
+ :operation => :"FrontendApi.create_id_p_initiated_saml_browser_login_flow",
539
+ :header_params => header_params,
540
+ :query_params => query_params,
541
+ :form_params => form_params,
542
+ :body => post_body,
543
+ :auth_names => auth_names,
544
+ :return_type => return_type
545
+ )
546
+
547
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
548
+ if @api_client.config.debugging
549
+ @api_client.config.logger.debug "API called: FrontendApi#create_id_p_initiated_saml_browser_login_flow\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
550
+ end
551
+ return data, status_code, headers
552
+ end
553
+
484
554
  # Create Login Flow for Native Apps
485
- # 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).
555
+ # 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. - `session_aal2_enrollment_required`: Second-factor auth is required but the identity has no second factor enrolled. Follow `redirect_browser_to` to the settings flow to enroll one. - `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).
486
556
  # @param [Hash] opts the optional parameters
487
557
  # @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.
488
558
  # @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;.
@@ -499,7 +569,7 @@ module OryClient
499
569
  end
500
570
 
501
571
  # Create Login Flow for Native Apps
502
- # 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).
572
+ # 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;session_aal2_enrollment_required&#x60;: Second-factor auth is required but the identity has no second factor enrolled. Follow &#x60;redirect_browser_to&#x60; to the settings flow to enroll one. - &#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).
503
573
  # @param [Hash] opts the optional parameters
504
574
  # @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.
505
575
  # @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;.
@@ -620,7 +690,7 @@ module OryClient
620
690
  end
621
691
 
622
692
  # Create Registration Flow for Native Apps
623
- # 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).
693
+ # 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).
624
694
  # @param [Hash] opts the optional parameters
625
695
  # @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.
626
696
  # @option opts [String] :return_to The URL to return the browser to after the flow was completed.
@@ -633,7 +703,7 @@ module OryClient
633
703
  end
634
704
 
635
705
  # Create Registration Flow for Native Apps
636
- # 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).
706
+ # 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).
637
707
  # @param [Hash] opts the optional parameters
638
708
  # @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.
639
709
  # @option opts [String] :return_to The URL to return the browser to after the flow was completed.
@@ -689,7 +759,7 @@ module OryClient
689
759
  end
690
760
 
691
761
  # Create Settings Flow for Native Apps
692
- # This endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on. You must provide a valid Ory Kratos Session Token for this endpoint to respond with HTTP 200 OK. To fetch an existing settings flow call `/self-service/settings/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration. In the case of an error, the `error.id` of the JSON response body can be one of: `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `session_inactive`: No Ory Session was found - sign in a user first. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
762
+ # This endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on. You must provide a valid Ory Kratos Session Token for this endpoint to respond with HTTP 200 OK. To fetch an existing settings flow call `/self-service/settings/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration. In the case of an error, the `error.id` of the JSON response body can be one of: - `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. - `session_inactive`: No Ory Session was found - sign in a user first. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
693
763
  # @param [Hash] opts the optional parameters
694
764
  # @option opts [String] :x_session_token The Session Token of the Identity performing the settings flow.
695
765
  # @option opts [String] :organization An optional organization ID that scopes the settings flow to providers of that organization. This parameter is only effective in the Ory Network.
@@ -700,7 +770,7 @@ module OryClient
700
770
  end
701
771
 
702
772
  # Create Settings Flow for Native Apps
703
- # This endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on. You must provide a valid Ory Kratos Session Token for this endpoint to respond with HTTP 200 OK. To fetch an existing settings flow call &#x60;/self-service/settings/flows?flow&#x3D;&lt;flow_id&gt;&#x60;. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration. In the case of an error, the &#x60;error.id&#x60; of the JSON response body can be one of: &#x60;security_csrf_violation&#x60;: Unable to fetch the flow because a CSRF violation occurred. &#x60;session_inactive&#x60;: No Ory Session was found - sign in a user first. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
773
+ # This endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on. You must provide a valid Ory Kratos Session Token for this endpoint to respond with HTTP 200 OK. To fetch an existing settings flow call &#x60;/self-service/settings/flows?flow&#x3D;&lt;flow_id&gt;&#x60;. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration. In the case of an error, the &#x60;error.id&#x60; of the JSON response body can be one of: - &#x60;security_csrf_violation&#x60;: Unable to fetch the flow because a CSRF violation occurred. - &#x60;session_inactive&#x60;: No Ory Session was found - sign in a user first. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
704
774
  # @param [Hash] opts the optional parameters
705
775
  # @option opts [String] :x_session_token The Session Token of the Identity performing the settings flow.
706
776
  # @option opts [String] :organization An optional organization ID that scopes the settings flow to providers of that organization. This parameter is only effective in the Ory Network.
@@ -1080,7 +1150,7 @@ module OryClient
1080
1150
  end
1081
1151
 
1082
1152
  # Get User-Flow Errors
1083
- # 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).
1153
+ # 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).
1084
1154
  # @param id [String] Error is the error&#39;s ID
1085
1155
  # @param [Hash] opts the optional parameters
1086
1156
  # @return [FlowError]
@@ -1090,7 +1160,7 @@ module OryClient
1090
1160
  end
1091
1161
 
1092
1162
  # Get User-Flow Errors
1093
- # 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).
1163
+ # 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).
1094
1164
  # @param id [String] Error is the error&#39;s ID
1095
1165
  # @param [Hash] opts the optional parameters
1096
1166
  # @return [Array<(FlowError, Integer, Hash)>] FlowError data, response status code and response headers
@@ -1144,7 +1214,7 @@ module OryClient
1144
1214
  end
1145
1215
 
1146
1216
  # Get Login Flow
1147
- # 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).
1217
+ # 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).
1148
1218
  # @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;).
1149
1219
  # @param [Hash] opts the optional parameters
1150
1220
  # @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.
@@ -1155,7 +1225,7 @@ module OryClient
1155
1225
  end
1156
1226
 
1157
1227
  # Get Login Flow
1158
- # 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).
1228
+ # 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).
1159
1229
  # @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;).
1160
1230
  # @param [Hash] opts the optional parameters
1161
1231
  # @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.
@@ -1278,7 +1348,7 @@ module OryClient
1278
1348
  end
1279
1349
 
1280
1350
  # Get Registration Flow
1281
- # 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).
1351
+ # 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).
1282
1352
  # @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;).
1283
1353
  # @param [Hash] opts the optional parameters
1284
1354
  # @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.
@@ -1289,7 +1359,7 @@ module OryClient
1289
1359
  end
1290
1360
 
1291
1361
  # Get Registration Flow
1292
- # 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).
1362
+ # 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).
1293
1363
  # @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;).
1294
1364
  # @param [Hash] opts the optional parameters
1295
1365
  # @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.
@@ -1344,8 +1414,128 @@ module OryClient
1344
1414
  return data, status_code, headers
1345
1415
  end
1346
1416
 
1417
+ # Get SAML SP Metadata
1418
+ # This endpoint serves the per-project SAML Service Provider metadata document: the SP entity ID and certificates this Ory Network project presents to every SAML identity provider by default. It is a public, unauthenticated, cacheable endpoint and never contains a private key. By SAML SP convention, the returned entity ID is this endpoint's own URL. The native engine derives and uses it automatically as the default SP entity ID for every connection, so there is nothing to copy; share it with an identity provider administrator setting up SSO. A connection can present a different SP entity ID via `sp_entity_id_override`. This endpoint 404s if no native SAML connection has been configured for this project yet (no SP signing key exists to publish).
1419
+ # @param [Hash] opts the optional parameters
1420
+ # @return [String]
1421
+ def get_saml_metadata(opts = {})
1422
+ data, _status_code, _headers = get_saml_metadata_with_http_info(opts)
1423
+ data
1424
+ end
1425
+
1426
+ # Get SAML SP Metadata
1427
+ # This endpoint serves the per-project SAML Service Provider metadata document: the SP entity ID and certificates this Ory Network project presents to every SAML identity provider by default. It is a public, unauthenticated, cacheable endpoint and never contains a private key. By SAML SP convention, the returned entity ID is this endpoint&#39;s own URL. The native engine derives and uses it automatically as the default SP entity ID for every connection, so there is nothing to copy; share it with an identity provider administrator setting up SSO. A connection can present a different SP entity ID via &#x60;sp_entity_id_override&#x60;. This endpoint 404s if no native SAML connection has been configured for this project yet (no SP signing key exists to publish).
1428
+ # @param [Hash] opts the optional parameters
1429
+ # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
1430
+ def get_saml_metadata_with_http_info(opts = {})
1431
+ if @api_client.config.debugging
1432
+ @api_client.config.logger.debug 'Calling API: FrontendApi.get_saml_metadata ...'
1433
+ end
1434
+ # resource path
1435
+ local_var_path = '/self-service/methods/saml/metadata'
1436
+
1437
+ # query parameters
1438
+ query_params = opts[:query_params] || {}
1439
+
1440
+ # header parameters
1441
+ header_params = opts[:header_params] || {}
1442
+ # HTTP header 'Accept' (if needed)
1443
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1444
+
1445
+ # form parameters
1446
+ form_params = opts[:form_params] || {}
1447
+
1448
+ # http body (model)
1449
+ post_body = opts[:debug_body]
1450
+
1451
+ # return_type
1452
+ return_type = opts[:debug_return_type] || 'String'
1453
+
1454
+ # auth_names
1455
+ auth_names = opts[:debug_auth_names] || []
1456
+
1457
+ new_options = opts.merge(
1458
+ :operation => :"FrontendApi.get_saml_metadata",
1459
+ :header_params => header_params,
1460
+ :query_params => query_params,
1461
+ :form_params => form_params,
1462
+ :body => post_body,
1463
+ :auth_names => auth_names,
1464
+ :return_type => return_type
1465
+ )
1466
+
1467
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1468
+ if @api_client.config.debugging
1469
+ @api_client.config.logger.debug "API called: FrontendApi#get_saml_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1470
+ end
1471
+ return data, status_code, headers
1472
+ end
1473
+
1474
+ # Get Per-Connection SAML SP Metadata
1475
+ # This endpoint serves per-connection SAML Service Provider metadata: the identity and certificate a single native connection presents to its identity provider, including the connection's own Assertion Consumer Service (ACS) URL. It serves a document for any native connection; when the connection sets `sp_entity_id_override` the SP entity ID is that value, otherwise it is the project default. It 404s -- with the identical generic response -- for an unknown connection ID, a connection disabled by invalid configuration, and a non-native connection, which manages its SP identity out of band.
1476
+ # @param provider [String] The SAML connection ID to get metadata for.
1477
+ # @param [Hash] opts the optional parameters
1478
+ # @return [String]
1479
+ def get_saml_provider_metadata(provider, opts = {})
1480
+ data, _status_code, _headers = get_saml_provider_metadata_with_http_info(provider, opts)
1481
+ data
1482
+ end
1483
+
1484
+ # Get Per-Connection SAML SP Metadata
1485
+ # This endpoint serves per-connection SAML Service Provider metadata: the identity and certificate a single native connection presents to its identity provider, including the connection&#39;s own Assertion Consumer Service (ACS) URL. It serves a document for any native connection; when the connection sets &#x60;sp_entity_id_override&#x60; the SP entity ID is that value, otherwise it is the project default. It 404s -- with the identical generic response -- for an unknown connection ID, a connection disabled by invalid configuration, and a non-native connection, which manages its SP identity out of band.
1486
+ # @param provider [String] The SAML connection ID to get metadata for.
1487
+ # @param [Hash] opts the optional parameters
1488
+ # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
1489
+ def get_saml_provider_metadata_with_http_info(provider, opts = {})
1490
+ if @api_client.config.debugging
1491
+ @api_client.config.logger.debug 'Calling API: FrontendApi.get_saml_provider_metadata ...'
1492
+ end
1493
+ # verify the required parameter 'provider' is set
1494
+ if @api_client.config.client_side_validation && provider.nil?
1495
+ fail ArgumentError, "Missing the required parameter 'provider' when calling FrontendApi.get_saml_provider_metadata"
1496
+ end
1497
+ # resource path
1498
+ local_var_path = '/self-service/methods/saml/metadata/{provider}'.sub('{' + 'provider' + '}', CGI.escape(provider.to_s))
1499
+
1500
+ # query parameters
1501
+ query_params = opts[:query_params] || {}
1502
+
1503
+ # header parameters
1504
+ header_params = opts[:header_params] || {}
1505
+ # HTTP header 'Accept' (if needed)
1506
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1507
+
1508
+ # form parameters
1509
+ form_params = opts[:form_params] || {}
1510
+
1511
+ # http body (model)
1512
+ post_body = opts[:debug_body]
1513
+
1514
+ # return_type
1515
+ return_type = opts[:debug_return_type] || 'String'
1516
+
1517
+ # auth_names
1518
+ auth_names = opts[:debug_auth_names] || []
1519
+
1520
+ new_options = opts.merge(
1521
+ :operation => :"FrontendApi.get_saml_provider_metadata",
1522
+ :header_params => header_params,
1523
+ :query_params => query_params,
1524
+ :form_params => form_params,
1525
+ :body => post_body,
1526
+ :auth_names => auth_names,
1527
+ :return_type => return_type
1528
+ )
1529
+
1530
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1531
+ if @api_client.config.debugging
1532
+ @api_client.config.logger.debug "API called: FrontendApi#get_saml_provider_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1533
+ end
1534
+ return data, status_code, headers
1535
+ end
1536
+
1347
1537
  # Get Settings Flow
1348
- # When accessing this endpoint through Ory Kratos' Public API you must ensure that either the Ory Kratos Session Cookie or the Ory Kratos Session Token are set. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration. You can access this endpoint without credentials when using Ory Kratos' Admin API. 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: `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `session_inactive`: No Ory Session was found - sign in a user first. `security_identity_mismatch`: The flow was interrupted with `session_refresh_required` but apparently some other identity logged in instead. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
1538
+ # When accessing this endpoint through Ory Kratos' Public API you must ensure that either the Ory Kratos Session Cookie or the Ory Kratos Session Token are set. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration. You can access this endpoint without credentials when using Ory Kratos' Admin API. 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: - `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. - `session_inactive`: No Ory Session was found - sign in a user first. - `security_identity_mismatch`: The flow was interrupted with `session_refresh_required` but apparently some other identity logged in instead. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
1349
1539
  # @param id [String] ID is the Settings Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/settings?flow&#x3D;abcde&#x60;).
1350
1540
  # @param [Hash] opts the optional parameters
1351
1541
  # @option opts [String] :x_session_token The Session Token When using the SDK in an app without a browser, please include the session token here.
@@ -1357,7 +1547,7 @@ module OryClient
1357
1547
  end
1358
1548
 
1359
1549
  # Get Settings Flow
1360
- # When accessing this endpoint through Ory Kratos&#39; Public API you must ensure that either the Ory Kratos Session Cookie or the Ory Kratos Session Token are set. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration. You can access this endpoint without credentials when using Ory Kratos&#39; Admin API. 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;security_csrf_violation&#x60;: Unable to fetch the flow because a CSRF violation occurred. &#x60;session_inactive&#x60;: No Ory Session was found - sign in a user first. &#x60;security_identity_mismatch&#x60;: The flow was interrupted with &#x60;session_refresh_required&#x60; but apparently some other identity logged in instead. More information can be found at [Ory Kratos User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
1550
+ # When accessing this endpoint through Ory Kratos&#39; Public API you must ensure that either the Ory Kratos Session Cookie or the Ory Kratos Session Token are set. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration. You can access this endpoint without credentials when using Ory Kratos&#39; Admin API. 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;security_csrf_violation&#x60;: Unable to fetch the flow because a CSRF violation occurred. - &#x60;session_inactive&#x60;: No Ory Session was found - sign in a user first. - &#x60;security_identity_mismatch&#x60;: The flow was interrupted with &#x60;session_refresh_required&#x60; but apparently some other identity logged in instead. More information can be found at [Ory Kratos User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
1361
1551
  # @param id [String] ID is the Settings Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/settings?flow&#x3D;abcde&#x60;).
1362
1552
  # @param [Hash] opts the optional parameters
1363
1553
  # @option opts [String] :x_session_token The Session Token When using the SDK in an app without a browser, please include the session token here.
@@ -1450,7 +1640,7 @@ module OryClient
1450
1640
  header_params = opts[:header_params] || {}
1451
1641
  # HTTP header 'Accept' (if needed)
1452
1642
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1453
- header_params[:'cookie'] = opts[:'cookie'] if !opts[:'cookie'].nil?
1643
+ header_params[:'Cookie'] = opts[:'cookie'] if !opts[:'cookie'].nil?
1454
1644
 
1455
1645
  # form parameters
1456
1646
  form_params = opts[:form_params] || {}
@@ -1538,6 +1728,63 @@ module OryClient
1538
1728
  return data, status_code, headers
1539
1729
  end
1540
1730
 
1731
+ # Get WebAuthn Related Origins
1732
+ # This endpoint serves the WebAuthn Related Origin Requests document specified in https://www.w3.org/TR/webauthn-3/#sctn-related-origins. It lists the web origins allowed to use this domain as their WebAuthn relying party ID. Browsers fetch it when a page requests a relying party ID that does not match the page's own origin. The document contains the relying party origins configured for the enabled WebAuthn and passkey methods.
1733
+ # @param [Hash] opts the optional parameters
1734
+ # @return [WebAuthnRelatedOrigins]
1735
+ def get_web_authn_related_origins(opts = {})
1736
+ data, _status_code, _headers = get_web_authn_related_origins_with_http_info(opts)
1737
+ data
1738
+ end
1739
+
1740
+ # Get WebAuthn Related Origins
1741
+ # This endpoint serves the WebAuthn Related Origin Requests document specified in https://www.w3.org/TR/webauthn-3/#sctn-related-origins. It lists the web origins allowed to use this domain as their WebAuthn relying party ID. Browsers fetch it when a page requests a relying party ID that does not match the page&#39;s own origin. The document contains the relying party origins configured for the enabled WebAuthn and passkey methods.
1742
+ # @param [Hash] opts the optional parameters
1743
+ # @return [Array<(WebAuthnRelatedOrigins, Integer, Hash)>] WebAuthnRelatedOrigins data, response status code and response headers
1744
+ def get_web_authn_related_origins_with_http_info(opts = {})
1745
+ if @api_client.config.debugging
1746
+ @api_client.config.logger.debug 'Calling API: FrontendApi.get_web_authn_related_origins ...'
1747
+ end
1748
+ # resource path
1749
+ local_var_path = '/.well-known/webauthn'
1750
+
1751
+ # query parameters
1752
+ query_params = opts[:query_params] || {}
1753
+
1754
+ # header parameters
1755
+ header_params = opts[:header_params] || {}
1756
+ # HTTP header 'Accept' (if needed)
1757
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1758
+
1759
+ # form parameters
1760
+ form_params = opts[:form_params] || {}
1761
+
1762
+ # http body (model)
1763
+ post_body = opts[:debug_body]
1764
+
1765
+ # return_type
1766
+ return_type = opts[:debug_return_type] || 'WebAuthnRelatedOrigins'
1767
+
1768
+ # auth_names
1769
+ auth_names = opts[:debug_auth_names] || []
1770
+
1771
+ new_options = opts.merge(
1772
+ :operation => :"FrontendApi.get_web_authn_related_origins",
1773
+ :header_params => header_params,
1774
+ :query_params => query_params,
1775
+ :form_params => form_params,
1776
+ :body => post_body,
1777
+ :auth_names => auth_names,
1778
+ :return_type => return_type
1779
+ )
1780
+
1781
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1782
+ if @api_client.config.debugging
1783
+ @api_client.config.logger.debug "API called: FrontendApi#get_web_authn_related_origins\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1784
+ end
1785
+ return data, status_code, headers
1786
+ end
1787
+
1541
1788
  # Change Password URL
1542
1789
  # This endpoint implements the W3C \"change password URL\" well-known location by redirecting the browser to the configured settings UI. Password managers follow this redirect to take users straight to the page where they can change their password.
1543
1790
  # @param [Hash] opts the optional parameters
@@ -1595,6 +1842,170 @@ module OryClient
1595
1842
  return data, status_code, headers
1596
1843
  end
1597
1844
 
1845
+ # Initiate Native SAML Sign-In
1846
+ # This endpoint starts a native SP-initiated SAML sign-in for the given connection. It checks that the flow named by the `flow` query parameter exists as the kind named by `purpose`, builds a SAML AuthnRequest, and forwards the browser to the identity provider's Single Sign-On endpoint -- either with an HTTP 302 redirect (HTTP-Redirect binding) or by returning a self-submitting HTML form (HTTP-POST binding). A login, registration, or settings flow redirects here as a browser navigation once a SAML connection has been selected. This endpoint is NOT INTENDED to be called directly by API clients: it is a browser navigation target, not a JSON API.
1847
+ # @param provider [String] The SAML connection ID to start a native SP-initiated sign-in for.
1848
+ # @param flow [String] The Login, Registration, or Settings Flow ID this SAML sign-in continues.
1849
+ # @param purpose [String] The kind of flow &#x60;flow&#x60; names: &#x60;login&#x60;, &#x60;registration&#x60;, or &#x60;settings-link&#x60; (a settings flow linking a new SAML credential). The flow must exist in the named kind, or the request is not found.
1850
+ # @param [Hash] opts the optional parameters
1851
+ # @return [String]
1852
+ def init_saml_login(provider, flow, purpose, opts = {})
1853
+ data, _status_code, _headers = init_saml_login_with_http_info(provider, flow, purpose, opts)
1854
+ data
1855
+ end
1856
+
1857
+ # Initiate Native SAML Sign-In
1858
+ # This endpoint starts a native SP-initiated SAML sign-in for the given connection. It checks that the flow named by the &#x60;flow&#x60; query parameter exists as the kind named by &#x60;purpose&#x60;, builds a SAML AuthnRequest, and forwards the browser to the identity provider&#39;s Single Sign-On endpoint -- either with an HTTP 302 redirect (HTTP-Redirect binding) or by returning a self-submitting HTML form (HTTP-POST binding). A login, registration, or settings flow redirects here as a browser navigation once a SAML connection has been selected. This endpoint is NOT INTENDED to be called directly by API clients: it is a browser navigation target, not a JSON API.
1859
+ # @param provider [String] The SAML connection ID to start a native SP-initiated sign-in for.
1860
+ # @param flow [String] The Login, Registration, or Settings Flow ID this SAML sign-in continues.
1861
+ # @param purpose [String] The kind of flow &#x60;flow&#x60; names: &#x60;login&#x60;, &#x60;registration&#x60;, or &#x60;settings-link&#x60; (a settings flow linking a new SAML credential). The flow must exist in the named kind, or the request is not found.
1862
+ # @param [Hash] opts the optional parameters
1863
+ # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
1864
+ def init_saml_login_with_http_info(provider, flow, purpose, opts = {})
1865
+ if @api_client.config.debugging
1866
+ @api_client.config.logger.debug 'Calling API: FrontendApi.init_saml_login ...'
1867
+ end
1868
+ # verify the required parameter 'provider' is set
1869
+ if @api_client.config.client_side_validation && provider.nil?
1870
+ fail ArgumentError, "Missing the required parameter 'provider' when calling FrontendApi.init_saml_login"
1871
+ end
1872
+ # verify the required parameter 'flow' is set
1873
+ if @api_client.config.client_side_validation && flow.nil?
1874
+ fail ArgumentError, "Missing the required parameter 'flow' when calling FrontendApi.init_saml_login"
1875
+ end
1876
+ # verify the required parameter 'purpose' is set
1877
+ if @api_client.config.client_side_validation && purpose.nil?
1878
+ fail ArgumentError, "Missing the required parameter 'purpose' when calling FrontendApi.init_saml_login"
1879
+ end
1880
+ # verify enum value
1881
+ allowable_values = ["login", "registration", "settings-link"]
1882
+ if @api_client.config.client_side_validation && !allowable_values.include?(purpose)
1883
+ fail ArgumentError, "invalid value for \"purpose\", must be one of #{allowable_values}"
1884
+ end
1885
+ # resource path
1886
+ local_var_path = '/self-service/methods/saml/init/{provider}'.sub('{' + 'provider' + '}', CGI.escape(provider.to_s))
1887
+
1888
+ # query parameters
1889
+ query_params = opts[:query_params] || {}
1890
+ query_params[:'flow'] = flow
1891
+ query_params[:'purpose'] = purpose
1892
+
1893
+ # header parameters
1894
+ header_params = opts[:header_params] || {}
1895
+ # HTTP header 'Accept' (if needed)
1896
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1897
+
1898
+ # form parameters
1899
+ form_params = opts[:form_params] || {}
1900
+
1901
+ # http body (model)
1902
+ post_body = opts[:debug_body]
1903
+
1904
+ # return_type
1905
+ return_type = opts[:debug_return_type] || 'String'
1906
+
1907
+ # auth_names
1908
+ auth_names = opts[:debug_auth_names] || []
1909
+
1910
+ new_options = opts.merge(
1911
+ :operation => :"FrontendApi.init_saml_login",
1912
+ :header_params => header_params,
1913
+ :query_params => query_params,
1914
+ :form_params => form_params,
1915
+ :body => post_body,
1916
+ :auth_names => auth_names,
1917
+ :return_type => return_type
1918
+ )
1919
+
1920
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1921
+ if @api_client.config.debugging
1922
+ @api_client.config.logger.debug "API called: FrontendApi#init_saml_login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1923
+ end
1924
+ return data, status_code, headers
1925
+ end
1926
+
1927
+ # Initiate Native SAML Sign-In (Direct POST)
1928
+ # Identical to `GET /self-service/methods/saml/init/{provider}`, except the caller POSTs directly to this endpoint -- validated by the anti-CSRF middleware -- instead of being redirected here as a GET.
1929
+ # @param provider [String] The SAML connection ID to start a native SP-initiated sign-in for.
1930
+ # @param flow [String] The Login, Registration, or Settings Flow ID this SAML sign-in continues.
1931
+ # @param purpose [String] The kind of flow &#x60;flow&#x60; names: &#x60;login&#x60;, &#x60;registration&#x60;, or &#x60;settings-link&#x60; (a settings flow linking a new SAML credential). The flow must exist in the named kind, or the request is not found.
1932
+ # @param [Hash] opts the optional parameters
1933
+ # @return [String]
1934
+ def init_saml_login_request(provider, flow, purpose, opts = {})
1935
+ data, _status_code, _headers = init_saml_login_request_with_http_info(provider, flow, purpose, opts)
1936
+ data
1937
+ end
1938
+
1939
+ # Initiate Native SAML Sign-In (Direct POST)
1940
+ # Identical to &#x60;GET /self-service/methods/saml/init/{provider}&#x60;, except the caller POSTs directly to this endpoint -- validated by the anti-CSRF middleware -- instead of being redirected here as a GET.
1941
+ # @param provider [String] The SAML connection ID to start a native SP-initiated sign-in for.
1942
+ # @param flow [String] The Login, Registration, or Settings Flow ID this SAML sign-in continues.
1943
+ # @param purpose [String] The kind of flow &#x60;flow&#x60; names: &#x60;login&#x60;, &#x60;registration&#x60;, or &#x60;settings-link&#x60; (a settings flow linking a new SAML credential). The flow must exist in the named kind, or the request is not found.
1944
+ # @param [Hash] opts the optional parameters
1945
+ # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
1946
+ def init_saml_login_request_with_http_info(provider, flow, purpose, opts = {})
1947
+ if @api_client.config.debugging
1948
+ @api_client.config.logger.debug 'Calling API: FrontendApi.init_saml_login_request ...'
1949
+ end
1950
+ # verify the required parameter 'provider' is set
1951
+ if @api_client.config.client_side_validation && provider.nil?
1952
+ fail ArgumentError, "Missing the required parameter 'provider' when calling FrontendApi.init_saml_login_request"
1953
+ end
1954
+ # verify the required parameter 'flow' is set
1955
+ if @api_client.config.client_side_validation && flow.nil?
1956
+ fail ArgumentError, "Missing the required parameter 'flow' when calling FrontendApi.init_saml_login_request"
1957
+ end
1958
+ # verify the required parameter 'purpose' is set
1959
+ if @api_client.config.client_side_validation && purpose.nil?
1960
+ fail ArgumentError, "Missing the required parameter 'purpose' when calling FrontendApi.init_saml_login_request"
1961
+ end
1962
+ # verify enum value
1963
+ allowable_values = ["login", "registration", "settings-link"]
1964
+ if @api_client.config.client_side_validation && !allowable_values.include?(purpose)
1965
+ fail ArgumentError, "invalid value for \"purpose\", must be one of #{allowable_values}"
1966
+ end
1967
+ # resource path
1968
+ local_var_path = '/self-service/methods/saml/init/{provider}'.sub('{' + 'provider' + '}', CGI.escape(provider.to_s))
1969
+
1970
+ # query parameters
1971
+ query_params = opts[:query_params] || {}
1972
+ query_params[:'flow'] = flow
1973
+ query_params[:'purpose'] = purpose
1974
+
1975
+ # header parameters
1976
+ header_params = opts[:header_params] || {}
1977
+ # HTTP header 'Accept' (if needed)
1978
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1979
+
1980
+ # form parameters
1981
+ form_params = opts[:form_params] || {}
1982
+
1983
+ # http body (model)
1984
+ post_body = opts[:debug_body]
1985
+
1986
+ # return_type
1987
+ return_type = opts[:debug_return_type] || 'String'
1988
+
1989
+ # auth_names
1990
+ auth_names = opts[:debug_auth_names] || []
1991
+
1992
+ new_options = opts.merge(
1993
+ :operation => :"FrontendApi.init_saml_login_request",
1994
+ :header_params => header_params,
1995
+ :query_params => query_params,
1996
+ :form_params => form_params,
1997
+ :body => post_body,
1998
+ :auth_names => auth_names,
1999
+ :return_type => return_type
2000
+ )
2001
+
2002
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2003
+ if @api_client.config.debugging
2004
+ @api_client.config.logger.debug "API called: FrontendApi#init_saml_login_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2005
+ end
2006
+ return data, status_code, headers
2007
+ end
2008
+
1598
2009
  # Get My Active Sessions
1599
2010
  # This endpoints returns all other active sessions that belong to the logged-in user. The current session can be retrieved by calling the `/sessions/whoami` endpoint.
1600
2011
  # @param [Hash] opts the optional parameters
@@ -1754,8 +2165,90 @@ module OryClient
1754
2165
  return data, status_code, headers
1755
2166
  end
1756
2167
 
2168
+ # Native SAML Assertion Consumer Service (ACS)
2169
+ # This is the Assertion Consumer Service (ACS) for the native SAML engine. The identity provider delivers its SAML Response here via the HTTP-POST binding, carrying the RelayState token that correlates it with the AuthnRequest issued by the init endpoint. On success the browser is redirected to complete the login, registration, or settings-link flow that started the sign-in. This endpoint is posted to directly by the identity provider's browser and is NOT INTENDED to be called by API clients. Every failure -- a replayed or unknown token, a malformed request, a provider mismatch, a response delivered to a browser other than the one that started the flow, or a signature/assertion validation failure -- is reported with the identical generic error, so the response body cannot be used to probe which check failed.
2170
+ # @param provider [String] The SAML connection ID this assertion is delivered for.
2171
+ # @param relay_state [String] The opaque token that correlates this response with the AuthnRequest issued by &#x60;POST /self-service/methods/saml/init/{provider}&#x60;. The PascalCase property name deliberately violates this API&#39;s snake_case convention: &#x60;RelayState&#x60; is the literal form-field name mandated by the SAML 2.0 HTTP-POST binding (OASIS SAML bindings spec), and every identity provider posts exactly this name. Do not rename it.
2172
+ # @param saml_response [String] The base64-encoded, XML-serialized samlp:Response the identity provider produced for the AuthnRequest issued by &#x60;POST /self-service/methods/saml/init/{provider}&#x60;. The PascalCase property name deliberately violates this API&#39;s snake_case convention: &#x60;SAMLResponse&#x60; is the literal form-field name mandated by the SAML 2.0 HTTP-POST binding (OASIS SAML bindings spec), and every identity provider posts exactly this name. Do not rename it.
2173
+ # @param [Hash] opts the optional parameters
2174
+ # @return [ErrorGeneric]
2175
+ def submit_saml_assertion(provider, relay_state, saml_response, opts = {})
2176
+ data, _status_code, _headers = submit_saml_assertion_with_http_info(provider, relay_state, saml_response, opts)
2177
+ data
2178
+ end
2179
+
2180
+ # Native SAML Assertion Consumer Service (ACS)
2181
+ # This is the Assertion Consumer Service (ACS) for the native SAML engine. The identity provider delivers its SAML Response here via the HTTP-POST binding, carrying the RelayState token that correlates it with the AuthnRequest issued by the init endpoint. On success the browser is redirected to complete the login, registration, or settings-link flow that started the sign-in. This endpoint is posted to directly by the identity provider&#39;s browser and is NOT INTENDED to be called by API clients. Every failure -- a replayed or unknown token, a malformed request, a provider mismatch, a response delivered to a browser other than the one that started the flow, or a signature/assertion validation failure -- is reported with the identical generic error, so the response body cannot be used to probe which check failed.
2182
+ # @param provider [String] The SAML connection ID this assertion is delivered for.
2183
+ # @param relay_state [String] The opaque token that correlates this response with the AuthnRequest issued by &#x60;POST /self-service/methods/saml/init/{provider}&#x60;. The PascalCase property name deliberately violates this API&#39;s snake_case convention: &#x60;RelayState&#x60; is the literal form-field name mandated by the SAML 2.0 HTTP-POST binding (OASIS SAML bindings spec), and every identity provider posts exactly this name. Do not rename it.
2184
+ # @param saml_response [String] The base64-encoded, XML-serialized samlp:Response the identity provider produced for the AuthnRequest issued by &#x60;POST /self-service/methods/saml/init/{provider}&#x60;. The PascalCase property name deliberately violates this API&#39;s snake_case convention: &#x60;SAMLResponse&#x60; is the literal form-field name mandated by the SAML 2.0 HTTP-POST binding (OASIS SAML bindings spec), and every identity provider posts exactly this name. Do not rename it.
2185
+ # @param [Hash] opts the optional parameters
2186
+ # @return [Array<(ErrorGeneric, Integer, Hash)>] ErrorGeneric data, response status code and response headers
2187
+ def submit_saml_assertion_with_http_info(provider, relay_state, saml_response, opts = {})
2188
+ if @api_client.config.debugging
2189
+ @api_client.config.logger.debug 'Calling API: FrontendApi.submit_saml_assertion ...'
2190
+ end
2191
+ # verify the required parameter 'provider' is set
2192
+ if @api_client.config.client_side_validation && provider.nil?
2193
+ fail ArgumentError, "Missing the required parameter 'provider' when calling FrontendApi.submit_saml_assertion"
2194
+ end
2195
+ # verify the required parameter 'relay_state' is set
2196
+ if @api_client.config.client_side_validation && relay_state.nil?
2197
+ fail ArgumentError, "Missing the required parameter 'relay_state' when calling FrontendApi.submit_saml_assertion"
2198
+ end
2199
+ # verify the required parameter 'saml_response' is set
2200
+ if @api_client.config.client_side_validation && saml_response.nil?
2201
+ fail ArgumentError, "Missing the required parameter 'saml_response' when calling FrontendApi.submit_saml_assertion"
2202
+ end
2203
+ # resource path
2204
+ local_var_path = '/self-service/methods/saml/acs/{provider}'.sub('{' + 'provider' + '}', CGI.escape(provider.to_s))
2205
+
2206
+ # query parameters
2207
+ query_params = opts[:query_params] || {}
2208
+
2209
+ # header parameters
2210
+ header_params = opts[:header_params] || {}
2211
+ # HTTP header 'Accept' (if needed)
2212
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
2213
+ # HTTP header 'Content-Type'
2214
+ content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
2215
+ if !content_type.nil?
2216
+ header_params['Content-Type'] = content_type
2217
+ end
2218
+
2219
+ # form parameters
2220
+ form_params = opts[:form_params] || {}
2221
+ form_params['RelayState'] = relay_state
2222
+ form_params['SAMLResponse'] = saml_response
2223
+
2224
+ # http body (model)
2225
+ post_body = opts[:debug_body]
2226
+
2227
+ # return_type
2228
+ return_type = opts[:debug_return_type] || 'ErrorGeneric'
2229
+
2230
+ # auth_names
2231
+ auth_names = opts[:debug_auth_names] || []
2232
+
2233
+ new_options = opts.merge(
2234
+ :operation => :"FrontendApi.submit_saml_assertion",
2235
+ :header_params => header_params,
2236
+ :query_params => query_params,
2237
+ :form_params => form_params,
2238
+ :body => post_body,
2239
+ :auth_names => auth_names,
2240
+ :return_type => return_type
2241
+ )
2242
+
2243
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2244
+ if @api_client.config.debugging
2245
+ @api_client.config.logger.debug "API called: FrontendApi#submit_saml_assertion\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2246
+ end
2247
+ return data, status_code, headers
2248
+ end
2249
+
1757
2250
  # Check Who the Current HTTP Session Belongs To
1758
- # Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object in the body or 401 if the credentials are invalid or no credentials were sent. When the request it successful it adds the user ID to the 'X-Kratos-Authenticated-Identity-Id' header in the response. If you call this endpoint from a server-side application, you must forward the HTTP Cookie Header to this endpoint: ```js pseudo-code example router.get('/protected-endpoint', async function (req, res) { const session = await client.toSession(undefined, req.header('cookie')) console.log(session) }) ``` When calling this endpoint from a non-browser application (e.g. mobile app) you must include the session token: ```js pseudo-code example ... const session = await client.toSession(\"the-session-token\") console.log(session) ``` When using a token template, the token is included in the `tokenized` field of the session. ```js pseudo-code example ... const session = await client.toSession(\"the-session-token\", { tokenize_as: \"example-jwt-template\" }) console.log(session.tokenized) // The JWT ``` Depending on your configuration this endpoint might return a 403 status code if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration. This endpoint is useful for: AJAX calls. Remember to send credentials and set up CORS correctly! Reverse proxies and API Gateways Server-side calls - use the `X-Session-Token` header! This endpoint authenticates users by checking: if the `Cookie` HTTP header was set containing an Ory Kratos Session Cookie; if the `Authorization: bearer <ory-session-token>` HTTP header was set with a valid Ory Kratos Session Token; if the `X-Session-Token` HTTP header was set with a valid Ory Kratos Session Token. If none of these headers are set or the cookie or token are invalid, the endpoint returns a HTTP 401 status code. As explained above, this request may fail due to several reasons. The `error.id` can be one of: `session_inactive`: No active session was found in the request (e.g. no Ory Session Cookie / Ory Session Token). `session_aal2_required`: An active session was found but it does not fulfil the Authenticator Assurance Level, implying that the session must (e.g.) authenticate the second factor.
2251
+ # Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object in the body or 401 if the credentials are invalid or no credentials were sent. When the request it successful it adds the user ID to the 'X-Kratos-Authenticated-Identity-Id' header in the response. If you call this endpoint from a server-side application, you must forward the HTTP Cookie Header to this endpoint: ```js pseudo-code example router.get('/protected-endpoint', async function (req, res) { const session = await client.toSession(undefined, req.header('cookie')) console.log(session) }) ``` When calling this endpoint from a non-browser application (e.g. mobile app) you must include the session token: ```js pseudo-code example ... const session = await client.toSession(\"the-session-token\") console.log(session) ``` When using a token template, the token is included in the `tokenized` field of the session. ```js pseudo-code example ... const session = await client.toSession(\"the-session-token\", { tokenize_as: \"example-jwt-template\" }) console.log(session.tokenized) // The JWT ``` Depending on your configuration this endpoint might return a 403 status code if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration. This endpoint is useful for: - AJAX calls. Remember to send credentials and set up CORS correctly! - Reverse proxies and API Gateways - Server-side calls - use the `X-Session-Token` header! This endpoint authenticates users by checking: - if the `Cookie` HTTP header was set containing an Ory Kratos Session Cookie; - if the `Authorization: bearer <ory-session-token>` HTTP header was set with a valid Ory Kratos Session Token; - if the `X-Session-Token` HTTP header was set with a valid Ory Kratos Session Token. If none of these headers are set or the cookie or token are invalid, the endpoint returns a HTTP 401 status code. As explained above, this request may fail due to several reasons. The `error.id` can be one of: - `session_inactive`: No active session was found in the request (e.g. no Ory Session Cookie / Ory Session Token). - `session_aal2_required`: An active session was found but it does not fulfil the Authenticator Assurance Level, implying that the session must (e.g.) authenticate the second factor. - `session_aal2_enrollment_required`: An active session was found but the required Authenticator Assurance Level can not be reached because the identity has no second factor enrolled. Follow `redirect_browser_to` to the settings flow to enroll one.
1759
2252
  # @param [Hash] opts the optional parameters
1760
2253
  # @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;.
1761
2254
  # @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.
@@ -1767,7 +2260,7 @@ module OryClient
1767
2260
  end
1768
2261
 
1769
2262
  # Check Who the Current HTTP Session Belongs To
1770
- # Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object in the body or 401 if the credentials are invalid or no credentials were sent. When the request it successful it adds the user ID to the &#39;X-Kratos-Authenticated-Identity-Id&#39; header in the response. If you call this endpoint from a server-side application, you must forward the HTTP Cookie Header to this endpoint: &#x60;&#x60;&#x60;js pseudo-code example router.get(&#39;/protected-endpoint&#39;, async function (req, res) { const session &#x3D; await client.toSession(undefined, req.header(&#39;cookie&#39;)) console.log(session) }) &#x60;&#x60;&#x60; When calling this endpoint from a non-browser application (e.g. mobile app) you must include the session token: &#x60;&#x60;&#x60;js pseudo-code example ... const session &#x3D; await client.toSession(\&quot;the-session-token\&quot;) console.log(session) &#x60;&#x60;&#x60; When using a token template, the token is included in the &#x60;tokenized&#x60; field of the session. &#x60;&#x60;&#x60;js pseudo-code example ... const session &#x3D; await client.toSession(\&quot;the-session-token\&quot;, { tokenize_as: \&quot;example-jwt-template\&quot; }) console.log(session.tokenized) // The JWT &#x60;&#x60;&#x60; Depending on your configuration this endpoint might return a 403 status code if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration. This endpoint is useful for: AJAX calls. Remember to send credentials and set up CORS correctly! Reverse proxies and API Gateways Server-side calls - use the &#x60;X-Session-Token&#x60; header! This endpoint authenticates users by checking: if the &#x60;Cookie&#x60; HTTP header was set containing an Ory Kratos Session Cookie; if the &#x60;Authorization: bearer &lt;ory-session-token&gt;&#x60; HTTP header was set with a valid Ory Kratos Session Token; if the &#x60;X-Session-Token&#x60; HTTP header was set with a valid Ory Kratos Session Token. If none of these headers are set or the cookie or token are invalid, the endpoint returns a HTTP 401 status code. As explained above, this request may fail due to several reasons. The &#x60;error.id&#x60; can be one of: &#x60;session_inactive&#x60;: No active session was found in the request (e.g. no Ory Session Cookie / Ory Session Token). &#x60;session_aal2_required&#x60;: An active session was found but it does not fulfil the Authenticator Assurance Level, implying that the session must (e.g.) authenticate the second factor.
2263
+ # Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object in the body or 401 if the credentials are invalid or no credentials were sent. When the request it successful it adds the user ID to the &#39;X-Kratos-Authenticated-Identity-Id&#39; header in the response. If you call this endpoint from a server-side application, you must forward the HTTP Cookie Header to this endpoint: &#x60;&#x60;&#x60;js pseudo-code example router.get(&#39;/protected-endpoint&#39;, async function (req, res) { const session &#x3D; await client.toSession(undefined, req.header(&#39;cookie&#39;)) console.log(session) }) &#x60;&#x60;&#x60; When calling this endpoint from a non-browser application (e.g. mobile app) you must include the session token: &#x60;&#x60;&#x60;js pseudo-code example ... const session &#x3D; await client.toSession(\&quot;the-session-token\&quot;) console.log(session) &#x60;&#x60;&#x60; When using a token template, the token is included in the &#x60;tokenized&#x60; field of the session. &#x60;&#x60;&#x60;js pseudo-code example ... const session &#x3D; await client.toSession(\&quot;the-session-token\&quot;, { tokenize_as: \&quot;example-jwt-template\&quot; }) console.log(session.tokenized) // The JWT &#x60;&#x60;&#x60; Depending on your configuration this endpoint might return a 403 status code if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration. This endpoint is useful for: - AJAX calls. Remember to send credentials and set up CORS correctly! - Reverse proxies and API Gateways - Server-side calls - use the &#x60;X-Session-Token&#x60; header! This endpoint authenticates users by checking: - if the &#x60;Cookie&#x60; HTTP header was set containing an Ory Kratos Session Cookie; - if the &#x60;Authorization: bearer &lt;ory-session-token&gt;&#x60; HTTP header was set with a valid Ory Kratos Session Token; - if the &#x60;X-Session-Token&#x60; HTTP header was set with a valid Ory Kratos Session Token. If none of these headers are set or the cookie or token are invalid, the endpoint returns a HTTP 401 status code. As explained above, this request may fail due to several reasons. The &#x60;error.id&#x60; can be one of: - &#x60;session_inactive&#x60;: No active session was found in the request (e.g. no Ory Session Cookie / Ory Session Token). - &#x60;session_aal2_required&#x60;: An active session was found but it does not fulfil the Authenticator Assurance Level, implying that the session must (e.g.) authenticate the second factor. - &#x60;session_aal2_enrollment_required&#x60;: An active session was found but the required Authenticator Assurance Level can not be reached because the identity has no second factor enrolled. Follow &#x60;redirect_browser_to&#x60; to the settings flow to enroll one.
1771
2264
  # @param [Hash] opts the optional parameters
1772
2265
  # @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;.
1773
2266
  # @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.
@@ -1889,7 +2382,7 @@ module OryClient
1889
2382
  end
1890
2383
 
1891
2384
  # Submit a Login Flow
1892
- # 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).
2385
+ # 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).
1893
2386
  # @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;).
1894
2387
  # @param update_login_flow_body [UpdateLoginFlowBody]
1895
2388
  # @param [Hash] opts the optional parameters
@@ -1902,7 +2395,7 @@ module OryClient
1902
2395
  end
1903
2396
 
1904
2397
  # Submit a Login Flow
1905
- # 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).
2398
+ # 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).
1906
2399
  # @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;).
1907
2400
  # @param update_login_flow_body [UpdateLoginFlowBody]
1908
2401
  # @param [Hash] opts the optional parameters
@@ -2036,7 +2529,7 @@ module OryClient
2036
2529
  end
2037
2530
 
2038
2531
  # Update Recovery Flow
2039
- # Use this endpoint to update a recovery flow. This endpoint behaves differently for API and browser flows and has several states: `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. For API clients and Browser clients with HTTP Header `Accept: application/json` it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid. and a HTTP 303 See Other redirect with a fresh recovery flow if the flow was otherwise invalid (e.g. expired). For Browser clients without HTTP Header `Accept` or with `Accept: text/*` it returns a HTTP 303 See Other redirect to the Recovery UI URL with the Recovery Flow ID appended. `sent_email` is the success state after `choose_method` for the `link` method and allows the user to request another recovery email. It works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state. `passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a recovery link\") does not have any API capabilities. The server responds with a HTTP 303 See Other redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Recover UI URL with a new Recovery Flow ID which contains an error message that the recovery link was invalid. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).
2532
+ # Use this endpoint to update a recovery flow. This endpoint behaves differently for API and browser flows and has several states: - `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. - For API clients and Browser clients with HTTP Header `Accept: application/json` it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid. and a HTTP 303 See Other redirect with a fresh recovery flow if the flow was otherwise invalid (e.g. expired). - For Browser clients without HTTP Header `Accept` or with `Accept: text/*` it returns a HTTP 303 See Other redirect to the Recovery UI URL with the Recovery Flow ID appended. - `sent_email` is the success state after `choose_method` for the `link` method and allows the user to request another recovery email. It works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state. - `passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a recovery link\") does not have any API capabilities. The server responds with a HTTP 303 See Other redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Recover UI URL with a new Recovery Flow ID which contains an error message that the recovery link was invalid. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).
2040
2533
  # @param flow [String] The Recovery Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/recovery?flow&#x3D;abcde&#x60;).
2041
2534
  # @param update_recovery_flow_body [UpdateRecoveryFlowBody]
2042
2535
  # @param [Hash] opts the optional parameters
@@ -2049,7 +2542,7 @@ module OryClient
2049
2542
  end
2050
2543
 
2051
2544
  # Update Recovery Flow
2052
- # Use this endpoint to update a recovery flow. This endpoint behaves differently for API and browser flows and has several states: &#x60;choose_method&#x60; expects &#x60;flow&#x60; (in the URL query) and &#x60;email&#x60; (in the body) to be sent and works with API- and Browser-initiated flows. For API clients and Browser clients with HTTP Header &#x60;Accept: application/json&#x60; it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid. and a HTTP 303 See Other redirect with a fresh recovery flow if the flow was otherwise invalid (e.g. expired). For Browser clients without HTTP Header &#x60;Accept&#x60; or with &#x60;Accept: text/*&#x60; it returns a HTTP 303 See Other redirect to the Recovery UI URL with the Recovery Flow ID appended. &#x60;sent_email&#x60; is the success state after &#x60;choose_method&#x60; for the &#x60;link&#x60; method and allows the user to request another recovery email. It works for both API and Browser-initiated flows and returns the same responses as the flow in &#x60;choose_method&#x60; state. &#x60;passed_challenge&#x60; expects a &#x60;token&#x60; to be sent in the URL query and given the nature of the flow (\&quot;sending a recovery link\&quot;) does not have any API capabilities. The server responds with a HTTP 303 See Other redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Recover UI URL with a new Recovery Flow ID which contains an error message that the recovery link was invalid. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).
2545
+ # Use this endpoint to update a recovery flow. This endpoint behaves differently for API and browser flows and has several states: - &#x60;choose_method&#x60; expects &#x60;flow&#x60; (in the URL query) and &#x60;email&#x60; (in the body) to be sent and works with API- and Browser-initiated flows. - For API clients and Browser clients with HTTP Header &#x60;Accept: application/json&#x60; it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid. and a HTTP 303 See Other redirect with a fresh recovery flow if the flow was otherwise invalid (e.g. expired). - For Browser clients without HTTP Header &#x60;Accept&#x60; or with &#x60;Accept: text/*&#x60; it returns a HTTP 303 See Other redirect to the Recovery UI URL with the Recovery Flow ID appended. - &#x60;sent_email&#x60; is the success state after &#x60;choose_method&#x60; for the &#x60;link&#x60; method and allows the user to request another recovery email. It works for both API and Browser-initiated flows and returns the same responses as the flow in &#x60;choose_method&#x60; state. - &#x60;passed_challenge&#x60; expects a &#x60;token&#x60; to be sent in the URL query and given the nature of the flow (\&quot;sending a recovery link\&quot;) does not have any API capabilities. The server responds with a HTTP 303 See Other redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Recover UI URL with a new Recovery Flow ID which contains an error message that the recovery link was invalid. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).
2053
2546
  # @param flow [String] The Recovery Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/recovery?flow&#x3D;abcde&#x60;).
2054
2547
  # @param update_recovery_flow_body [UpdateRecoveryFlowBody]
2055
2548
  # @param [Hash] opts the optional parameters
@@ -2117,7 +2610,7 @@ module OryClient
2117
2610
  end
2118
2611
 
2119
2612
  # Update Registration Flow
2120
- # 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).
2613
+ # 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).
2121
2614
  # @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;).
2122
2615
  # @param update_registration_flow_body [UpdateRegistrationFlowBody]
2123
2616
  # @param [Hash] opts the optional parameters
@@ -2129,7 +2622,7 @@ module OryClient
2129
2622
  end
2130
2623
 
2131
2624
  # Update Registration Flow
2132
- # 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).
2625
+ # 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).
2133
2626
  # @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;).
2134
2627
  # @param update_registration_flow_body [UpdateRegistrationFlowBody]
2135
2628
  # @param [Hash] opts the optional parameters
@@ -2195,7 +2688,7 @@ module OryClient
2195
2688
  end
2196
2689
 
2197
2690
  # Complete Settings Flow
2198
- # Use this endpoint to complete a settings flow by sending an identity's updated password. This endpoint behaves differently for API and browser flows. API-initiated flows expect `application/json` to be sent in the body and respond with HTTP 200 and an application/json body with the session token on success; HTTP 303 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. HTTP 401 when the endpoint is called without a valid session token. HTTP 403 when `selfservice.flows.settings.privileged_session_max_age` was reached or the session's AAL is too low. Implies that the user needs to re-authenticate. Browser flows without HTTP Header `Accept` or with `Accept: text/*` respond with a HTTP 303 redirect to the post/after settings URL or the `return_to` value if it was set and if the flow succeeded; a HTTP 303 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise. a HTTP 303 redirect to the login endpoint when `selfservice.flows.settings.privileged_session_max_age` was reached or the session's AAL is too low. Browser flows with HTTP Header `Accept: application/json` respond with HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success; HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 401 when the endpoint is called without a valid session cookie. HTTP 403 when the page is accessed without a session cookie or the session's AAL is too low. HTTP 400 on form validation errors. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor (happens automatically for server-side browser flows) or change the configuration. If this endpoint is called with a `Accept: application/json` HTTP header, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `session_refresh_required`: The identity requested to change something that needs a privileged session. Redirect the identity to the login init endpoint with query parameters `?refresh=true&return_to=<the-current-browser-url>`, or initiate a refresh login flow otherwise. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `session_inactive`: No Ory Session was found - sign in a user first. `security_identity_mismatch`: The flow was interrupted with `session_refresh_required` but apparently some other identity logged in instead. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! `browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL. Most likely used in Social Sign In flows. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
2691
+ # Use this endpoint to complete a settings flow by sending an identity's updated password. This endpoint behaves differently for API and browser flows. API-initiated flows expect `application/json` to be sent in the body and respond with - HTTP 200 and an application/json body with the session token on success; - HTTP 303 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set; - HTTP 400 on form validation errors. - HTTP 401 when the endpoint is called without a valid session token. - HTTP 403 when `selfservice.flows.settings.privileged_session_max_age` was reached or the session's AAL is too low. Implies that the user needs to re-authenticate. Browser flows without HTTP Header `Accept` or with `Accept: text/*` respond with - a HTTP 303 redirect to the post/after settings URL or the `return_to` value if it was set and if the flow succeeded; - a HTTP 303 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise. - a HTTP 303 redirect to the login endpoint when `selfservice.flows.settings.privileged_session_max_age` was reached or the session's AAL is too low. Browser flows with HTTP Header `Accept: application/json` respond with - HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success; - HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; - HTTP 401 when the endpoint is called without a valid session cookie. - HTTP 403 when the page is accessed without a session cookie or the session's AAL is too low. - HTTP 400 on form validation errors. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor (happens automatically for server-side browser flows) or change the configuration. If this endpoint is called with a `Accept: application/json` HTTP header, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: - `session_refresh_required`: The identity requested to change something that needs a privileged session. Redirect the identity to the login init endpoint with query parameters `?refresh=true&return_to=<the-current-browser-url>`, or initiate a refresh login flow otherwise. - `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. - `session_inactive`: No Ory Session was found - sign in a user first. - `security_identity_mismatch`: The flow was interrupted with `session_refresh_required` but apparently some other identity logged in instead. - `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! - `browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL. Most likely used in Social Sign In flows. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
2199
2692
  # @param flow [String] The Settings Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/settings?flow&#x3D;abcde&#x60;).
2200
2693
  # @param update_settings_flow_body [UpdateSettingsFlowBody]
2201
2694
  # @param [Hash] opts the optional parameters
@@ -2208,7 +2701,7 @@ module OryClient
2208
2701
  end
2209
2702
 
2210
2703
  # Complete Settings Flow
2211
- # Use this endpoint to complete a settings flow by sending an identity&#39;s updated password. This endpoint behaves differently for API and browser flows. API-initiated flows expect &#x60;application/json&#x60; to be sent in the body and respond with HTTP 200 and an application/json body with the session token on success; HTTP 303 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. HTTP 401 when the endpoint is called without a valid session token. HTTP 403 when &#x60;selfservice.flows.settings.privileged_session_max_age&#x60; was reached or the session&#39;s AAL is too low. Implies that the user needs to re-authenticate. Browser flows without HTTP Header &#x60;Accept&#x60; or with &#x60;Accept: text/*&#x60; respond with a HTTP 303 redirect to the post/after settings URL or the &#x60;return_to&#x60; value if it was set and if the flow succeeded; a HTTP 303 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise. a HTTP 303 redirect to the login endpoint when &#x60;selfservice.flows.settings.privileged_session_max_age&#x60; was reached or the session&#39;s AAL is too low. Browser flows with HTTP Header &#x60;Accept: application/json&#x60; respond with HTTP 200 and a application/json body with the signed in identity and a &#x60;Set-Cookie&#x60; header on success; HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 401 when the endpoint is called without a valid session cookie. HTTP 403 when the page is accessed without a session cookie or the session&#39;s AAL is too low. HTTP 400 on form validation errors. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor (happens automatically for server-side browser flows) or change the configuration. If this endpoint is called with a &#x60;Accept: application/json&#x60; HTTP header, the response contains the flow without a redirect. In the case of an error, the &#x60;error.id&#x60; of the JSON response body can be one of: &#x60;session_refresh_required&#x60;: The identity requested to change something that needs a privileged session. Redirect the identity to the login init endpoint with query parameters &#x60;?refresh&#x3D;true&amp;return_to&#x3D;&lt;the-current-browser-url&gt;&#x60;, or initiate a refresh login flow otherwise. &#x60;security_csrf_violation&#x60;: Unable to fetch the flow because a CSRF violation occurred. &#x60;session_inactive&#x60;: No Ory Session was found - sign in a user first. &#x60;security_identity_mismatch&#x60;: The flow was interrupted with &#x60;session_refresh_required&#x60; but apparently some other identity logged in instead. &#x60;security_identity_mismatch&#x60;: The requested &#x60;?return_to&#x60; address is not allowed to be used. Adjust this in the configuration! &#x60;browser_location_change_required&#x60;: Usually sent when an AJAX request indicates that the browser needs to open a specific URL. Most likely used in Social Sign In flows. More information can be found at [Ory Kratos User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
2704
+ # Use this endpoint to complete a settings flow by sending an identity&#39;s updated password. This endpoint behaves differently for API and browser flows. API-initiated flows expect &#x60;application/json&#x60; to be sent in the body and respond with - HTTP 200 and an application/json body with the session token on success; - HTTP 303 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set; - HTTP 400 on form validation errors. - HTTP 401 when the endpoint is called without a valid session token. - HTTP 403 when &#x60;selfservice.flows.settings.privileged_session_max_age&#x60; was reached or the session&#39;s AAL is too low. Implies that the user needs to re-authenticate. Browser flows without HTTP Header &#x60;Accept&#x60; or with &#x60;Accept: text/*&#x60; respond with - a HTTP 303 redirect to the post/after settings URL or the &#x60;return_to&#x60; value if it was set and if the flow succeeded; - a HTTP 303 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise. - a HTTP 303 redirect to the login endpoint when &#x60;selfservice.flows.settings.privileged_session_max_age&#x60; was reached or the session&#39;s AAL is too low. Browser flows with HTTP Header &#x60;Accept: application/json&#x60; respond with - HTTP 200 and a application/json body with the signed in identity and a &#x60;Set-Cookie&#x60; header on success; - HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; - HTTP 401 when the endpoint is called without a valid session cookie. - HTTP 403 when the page is accessed without a session cookie or the session&#39;s AAL is too low. - HTTP 400 on form validation errors. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor (happens automatically for server-side browser flows) or change the configuration. If this endpoint is called with a &#x60;Accept: application/json&#x60; HTTP header, the response contains the flow without a redirect. In the case of an error, the &#x60;error.id&#x60; of the JSON response body can be one of: - &#x60;session_refresh_required&#x60;: The identity requested to change something that needs a privileged session. Redirect the identity to the login init endpoint with query parameters &#x60;?refresh&#x3D;true&amp;return_to&#x3D;&lt;the-current-browser-url&gt;&#x60;, or initiate a refresh login flow otherwise. - &#x60;security_csrf_violation&#x60;: Unable to fetch the flow because a CSRF violation occurred. - &#x60;session_inactive&#x60;: No Ory Session was found - sign in a user first. - &#x60;security_identity_mismatch&#x60;: The flow was interrupted with &#x60;session_refresh_required&#x60; but apparently some other identity logged in instead. - &#x60;security_identity_mismatch&#x60;: The requested &#x60;?return_to&#x60; address is not allowed to be used. Adjust this in the configuration! - &#x60;browser_location_change_required&#x60;: Usually sent when an AJAX request indicates that the browser needs to open a specific URL. Most likely used in Social Sign In flows. More information can be found at [Ory Kratos User Settings &amp; Profile Management Documentation](../self-service/flows/user-settings).
2212
2705
  # @param flow [String] The Settings Flow ID The value for this parameter comes from &#x60;flow&#x60; URL Query parameter sent to your application (e.g. &#x60;/settings?flow&#x3D;abcde&#x60;).
2213
2706
  # @param update_settings_flow_body [UpdateSettingsFlowBody]
2214
2707
  # @param [Hash] opts the optional parameters
@@ -2276,7 +2769,7 @@ module OryClient
2276
2769
  end
2277
2770
 
2278
2771
  # Complete Verification Flow
2279
- # 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).
2772
+ # 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).
2280
2773
  # @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;).
2281
2774
  # @param update_verification_flow_body [UpdateVerificationFlowBody]
2282
2775
  # @param [Hash] opts the optional parameters
@@ -2289,7 +2782,7 @@ module OryClient
2289
2782
  end
2290
2783
 
2291
2784
  # Complete Verification Flow
2292
- # 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).
2785
+ # 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).
2293
2786
  # @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;).
2294
2787
  # @param update_verification_flow_body [UpdateVerificationFlowBody]
2295
2788
  # @param [Hash] opts the optional parameters