ory-kratos-client 0.7.6.alpha7 → 0.8.0.alpha2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +3 -3
- data/README.md +57 -40
- data/docs/AdminCreateIdentityBody.md +2 -0
- data/docs/AuthenticatorAssuranceLevel.md +15 -0
- data/docs/ErrorAuthenticatorAssuranceLevelNotSatisfied.md +34 -0
- data/docs/GenericError.md +2 -0
- data/docs/IdentityCredentials.md +1 -1
- data/docs/IdentityCredentialsType.md +15 -0
- data/docs/IdentitySchema.md +20 -0
- data/docs/MetadataApi.md +0 -61
- data/docs/NeedsPrivilegedSessionError.md +34 -0
- data/docs/SelfServiceBrowserLocationChangeRequiredError.md +34 -0
- data/docs/SelfServiceFlowExpiredError.md +36 -0
- data/docs/SelfServiceLoginFlow.md +7 -3
- data/docs/SelfServiceLogoutUrl.md +3 -1
- data/docs/SelfServiceRecoveryFlow.md +2 -0
- data/docs/SelfServiceRegistrationFlow.md +3 -1
- data/docs/SelfServiceSettingsFlow.md +2 -0
- data/docs/SelfServiceVerificationFlow.md +2 -0
- data/docs/Session.md +7 -3
- data/docs/SessionAuthenticationMethod.md +20 -0
- data/docs/SessionDevice.md +18 -0
- data/docs/SubmitSelfServiceLoginFlowBody.md +5 -2
- data/docs/SubmitSelfServiceLoginFlowWithLookupSecretMethodBody.md +22 -0
- data/docs/SubmitSelfServiceLoginFlowWithOidcMethodBody.md +3 -1
- data/docs/SubmitSelfServiceLoginFlowWithTotpMethodBody.md +22 -0
- data/docs/SubmitSelfServiceLoginFlowWithWebAuthnMethodBody.md +22 -0
- data/docs/SubmitSelfServiceRegistrationFlowWithOidcMethodBody.md +3 -1
- data/docs/SubmitSelfServiceSettingsFlowBody.md +5 -2
- data/docs/SubmitSelfServiceSettingsFlowWithLookupMethodBody.md +28 -0
- data/docs/SubmitSelfServiceSettingsFlowWithOidcMethodBody.md +2 -0
- data/docs/SubmitSelfServiceSettingsFlowWithTotpMethodBody.md +24 -0
- data/docs/SubmitSelfServiceSettingsFlowWithWebAuthnMethodBody.md +26 -0
- data/docs/UiNode.md +1 -1
- data/docs/UiNodeAnchorAttributes.md +4 -0
- data/docs/UiNodeAttributes.md +34 -0
- data/docs/UiNodeImageAttributes.md +9 -1
- data/docs/UiNodeInputAttributes.md +4 -0
- data/docs/{Meta.md → UiNodeMeta.md} +2 -2
- data/docs/UiNodeScriptAttributes.md +32 -0
- data/docs/UiNodeTextAttributes.md +4 -0
- data/docs/{V0alpha1Api.md → V0alpha2Api.md} +405 -172
- data/lib/ory-kratos-client/api/metadata_api.rb +1 -56
- data/lib/ory-kratos-client/api/{v0alpha1_api.rb → v0alpha2_api.rb} +372 -149
- data/lib/ory-kratos-client/api_client.rb +1 -1
- data/lib/ory-kratos-client/api_error.rb +1 -1
- data/lib/ory-kratos-client/configuration.rb +1 -1
- data/lib/ory-kratos-client/models/admin_create_identity_body.rb +11 -2
- data/lib/ory-kratos-client/models/admin_create_self_service_recovery_link_body.rb +1 -1
- data/lib/ory-kratos-client/models/admin_update_identity_body.rb +1 -1
- data/lib/ory-kratos-client/models/authenticator_assurance_level.rb +39 -0
- data/lib/ory-kratos-client/models/error_authenticator_assurance_level_not_satisfied.rb +305 -0
- data/lib/ory-kratos-client/models/generic_error.rb +12 -2
- data/lib/ory-kratos-client/models/health_not_ready_status.rb +1 -1
- data/lib/ory-kratos-client/models/health_status.rb +1 -1
- data/lib/ory-kratos-client/models/identity.rb +1 -1
- data/lib/ory-kratos-client/models/identity_credentials.rb +2 -3
- data/lib/ory-kratos-client/models/identity_credentials_type.rb +38 -0
- data/lib/ory-kratos-client/models/{successful_self_service_settings_without_browser.rb → identity_schema.rb} +19 -28
- data/lib/ory-kratos-client/models/identity_state.rb +1 -1
- data/lib/ory-kratos-client/models/inline_response200.rb +1 -1
- data/lib/ory-kratos-client/models/inline_response2001.rb +1 -1
- data/lib/ory-kratos-client/models/inline_response503.rb +1 -1
- data/lib/ory-kratos-client/models/json_error.rb +1 -1
- data/lib/ory-kratos-client/models/needs_privileged_session_error.rb +311 -0
- data/lib/ory-kratos-client/models/recovery_address.rb +1 -1
- data/lib/ory-kratos-client/models/self_service_browser_location_change_required_error.rb +306 -0
- data/lib/ory-kratos-client/models/self_service_error.rb +1 -1
- data/lib/ory-kratos-client/models/self_service_flow_expired_error.rb +316 -0
- data/lib/ory-kratos-client/models/self_service_login_flow.rb +32 -14
- data/lib/ory-kratos-client/models/self_service_logout_url.rb +18 -3
- data/lib/ory-kratos-client/models/self_service_recovery_flow.rb +12 -2
- data/lib/ory-kratos-client/models/self_service_recovery_flow_state.rb +1 -1
- data/lib/ory-kratos-client/models/self_service_recovery_link.rb +1 -1
- data/lib/ory-kratos-client/models/self_service_registration_flow.rb +13 -4
- data/lib/ory-kratos-client/models/self_service_settings_flow.rb +12 -2
- data/lib/ory-kratos-client/models/self_service_settings_flow_state.rb +1 -1
- data/lib/ory-kratos-client/models/self_service_verification_flow.rb +12 -2
- data/lib/ory-kratos-client/models/self_service_verification_flow_state.rb +1 -1
- data/lib/ory-kratos-client/models/session.rb +26 -5
- data/lib/ory-kratos-client/models/session_authentication_method.rb +263 -0
- data/lib/ory-kratos-client/models/session_device.rb +219 -0
- data/lib/ory-kratos-client/models/settings_profile_form_config.rb +1 -1
- data/lib/ory-kratos-client/models/submit_self_service_login_flow_body.rb +5 -3
- data/lib/ory-kratos-client/models/submit_self_service_login_flow_with_lookup_secret_method_body.rb +249 -0
- data/lib/ory-kratos-client/models/submit_self_service_login_flow_with_oidc_method_body.rb +16 -6
- data/lib/ory-kratos-client/models/submit_self_service_login_flow_with_password_method_body.rb +1 -1
- data/lib/ory-kratos-client/models/submit_self_service_login_flow_with_totp_method_body.rb +249 -0
- data/lib/ory-kratos-client/models/submit_self_service_login_flow_with_web_authn_method_body.rb +244 -0
- data/lib/ory-kratos-client/models/submit_self_service_logout_flow_without_browser_body.rb +1 -1
- data/lib/ory-kratos-client/models/submit_self_service_recovery_flow_body.rb +1 -1
- data/lib/ory-kratos-client/models/submit_self_service_recovery_flow_with_link_method_body.rb +1 -1
- data/lib/ory-kratos-client/models/submit_self_service_registration_flow_body.rb +1 -1
- data/lib/ory-kratos-client/models/submit_self_service_registration_flow_with_oidc_method_body.rb +16 -6
- data/lib/ory-kratos-client/models/submit_self_service_registration_flow_with_password_method_body.rb +1 -1
- data/lib/ory-kratos-client/models/submit_self_service_settings_flow_body.rb +5 -3
- data/lib/ory-kratos-client/models/submit_self_service_settings_flow_with_lookup_method_body.rb +274 -0
- data/lib/ory-kratos-client/models/submit_self_service_settings_flow_with_oidc_method_body.rb +12 -2
- data/lib/ory-kratos-client/models/submit_self_service_settings_flow_with_password_method_body.rb +1 -1
- data/lib/ory-kratos-client/models/submit_self_service_settings_flow_with_profile_method_body.rb +1 -1
- data/lib/ory-kratos-client/models/submit_self_service_settings_flow_with_totp_method_body.rb +254 -0
- data/lib/ory-kratos-client/models/submit_self_service_settings_flow_with_web_authn_method_body.rb +264 -0
- data/lib/ory-kratos-client/models/submit_self_service_verification_flow_body.rb +1 -1
- data/lib/ory-kratos-client/models/submit_self_service_verification_flow_with_link_method_body.rb +1 -1
- data/lib/ory-kratos-client/models/successful_self_service_login_without_browser.rb +1 -1
- data/lib/ory-kratos-client/models/successful_self_service_registration_without_browser.rb +1 -1
- data/lib/ory-kratos-client/models/ui_container.rb +1 -1
- data/lib/ory-kratos-client/models/ui_node.rb +2 -2
- data/lib/ory-kratos-client/models/ui_node_anchor_attributes.rb +31 -2
- data/lib/ory-kratos-client/models/ui_node_attributes.rb +23 -69
- data/lib/ory-kratos-client/models/ui_node_image_attributes.rb +54 -5
- data/lib/ory-kratos-client/models/ui_node_input_attributes.rb +26 -2
- data/lib/ory-kratos-client/models/{meta.rb → ui_node_meta.rb} +4 -4
- data/lib/ory-kratos-client/models/ui_node_script_attributes.rb +328 -0
- data/lib/ory-kratos-client/models/ui_node_text_attributes.rb +31 -2
- data/lib/ory-kratos-client/models/ui_text.rb +1 -1
- data/lib/ory-kratos-client/models/verifiable_identity_address.rb +1 -1
- data/lib/ory-kratos-client/models/version.rb +1 -1
- data/lib/ory-kratos-client/version.rb +2 -2
- data/lib/ory-kratos-client.rb +19 -4
- data/ory-kratos-client.gemspec +1 -1
- data/spec/api/metadata_api_spec.rb +1 -12
- data/spec/api/{v0alpha1_api_spec.rb → v0alpha2_api_spec.rb} +67 -22
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/admin_create_identity_body_spec.rb +7 -1
- data/spec/models/admin_create_self_service_recovery_link_body_spec.rb +1 -1
- data/spec/models/admin_update_identity_body_spec.rb +1 -1
- data/spec/models/authenticator_assurance_level_spec.rb +28 -0
- data/spec/models/error_authenticator_assurance_level_not_satisfied_spec.rb +82 -0
- data/spec/models/generic_error_spec.rb +7 -1
- data/spec/models/health_not_ready_status_spec.rb +1 -1
- data/spec/models/health_status_spec.rb +1 -1
- data/spec/models/identity_credentials_spec.rb +1 -1
- data/spec/models/identity_credentials_type_spec.rb +28 -0
- data/spec/models/{successful_self_service_settings_without_browser_spec.rb → identity_schema_spec.rb} +9 -9
- data/spec/models/identity_spec.rb +1 -1
- data/spec/models/identity_state_spec.rb +1 -1
- data/spec/models/inline_response2001_spec.rb +1 -1
- data/spec/models/inline_response200_spec.rb +1 -1
- data/spec/models/inline_response503_spec.rb +1 -1
- data/spec/models/json_error_spec.rb +1 -1
- data/spec/models/needs_privileged_session_error_spec.rb +82 -0
- data/spec/models/recovery_address_spec.rb +1 -1
- data/spec/models/self_service_browser_location_change_required_error_spec.rb +82 -0
- data/spec/models/self_service_error_spec.rb +1 -1
- data/spec/models/self_service_flow_expired_error_spec.rb +88 -0
- data/spec/models/self_service_login_flow_spec.rb +16 -4
- data/spec/models/self_service_logout_url_spec.rb +7 -1
- data/spec/models/self_service_recovery_flow_spec.rb +7 -1
- data/spec/models/self_service_recovery_flow_state_spec.rb +1 -1
- data/spec/models/self_service_recovery_link_spec.rb +1 -1
- data/spec/models/self_service_registration_flow_spec.rb +7 -1
- data/spec/models/self_service_settings_flow_spec.rb +7 -1
- data/spec/models/self_service_settings_flow_state_spec.rb +1 -1
- data/spec/models/self_service_verification_flow_spec.rb +7 -1
- data/spec/models/self_service_verification_flow_state_spec.rb +1 -1
- data/spec/models/session_authentication_method_spec.rb +44 -0
- data/spec/models/session_device_spec.rb +34 -0
- data/spec/models/session_spec.rb +13 -1
- data/spec/models/settings_profile_form_config_spec.rb +1 -1
- data/spec/models/submit_self_service_login_flow_body_spec.rb +1 -1
- data/spec/models/submit_self_service_login_flow_with_lookup_secret_method_body_spec.rb +46 -0
- data/spec/models/submit_self_service_login_flow_with_oidc_method_body_spec.rb +7 -1
- data/spec/models/submit_self_service_login_flow_with_password_method_body_spec.rb +1 -1
- data/spec/models/submit_self_service_login_flow_with_totp_method_body_spec.rb +46 -0
- data/spec/models/submit_self_service_login_flow_with_web_authn_method_body_spec.rb +46 -0
- data/spec/models/submit_self_service_logout_flow_without_browser_body_spec.rb +1 -1
- data/spec/models/submit_self_service_recovery_flow_body_spec.rb +1 -1
- data/spec/models/submit_self_service_recovery_flow_with_link_method_body_spec.rb +1 -1
- data/spec/models/submit_self_service_registration_flow_body_spec.rb +1 -1
- data/spec/models/submit_self_service_registration_flow_with_oidc_method_body_spec.rb +7 -1
- data/spec/models/submit_self_service_registration_flow_with_password_method_body_spec.rb +1 -1
- data/spec/models/submit_self_service_settings_flow_body_spec.rb +1 -1
- data/spec/models/submit_self_service_settings_flow_with_lookup_method_body_spec.rb +64 -0
- data/spec/models/submit_self_service_settings_flow_with_oidc_method_body_spec.rb +7 -1
- data/spec/models/submit_self_service_settings_flow_with_password_method_body_spec.rb +1 -1
- data/spec/models/submit_self_service_settings_flow_with_profile_method_body_spec.rb +1 -1
- data/spec/models/submit_self_service_settings_flow_with_totp_method_body_spec.rb +52 -0
- data/spec/models/submit_self_service_settings_flow_with_web_authn_method_body_spec.rb +58 -0
- data/spec/models/submit_self_service_verification_flow_body_spec.rb +1 -1
- data/spec/models/submit_self_service_verification_flow_with_link_method_body_spec.rb +1 -1
- data/spec/models/successful_self_service_login_without_browser_spec.rb +1 -1
- data/spec/models/successful_self_service_registration_without_browser_spec.rb +1 -1
- data/spec/models/ui_container_spec.rb +1 -1
- data/spec/models/ui_node_anchor_attributes_spec.rb +13 -1
- data/spec/models/ui_node_attributes_spec.rb +13 -1
- data/spec/models/ui_node_image_attributes_spec.rb +25 -1
- data/spec/models/ui_node_input_attributes_spec.rb +13 -1
- data/spec/models/{meta_spec.rb → ui_node_meta_spec.rb} +7 -7
- data/spec/models/ui_node_script_attributes_spec.rb +76 -0
- data/spec/models/ui_node_spec.rb +1 -1
- data/spec/models/ui_node_text_attributes_spec.rb +13 -1
- data/spec/models/ui_text_spec.rb +1 -1
- data/spec/models/verifiable_identity_address_spec.rb +1 -1
- data/spec/models/version_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- data/vendor/bundle/ruby/2.5.0/cache/ethon-0.15.0.gem +0 -0
- data/vendor/bundle/ruby/2.5.0/cache/psych-4.0.2.gem +0 -0
- data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/byebug-11.1.3/gem_make.out +2 -2
- data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/ffi-1.15.4/gem_make.out +2 -2
- data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/jaro_winkler-1.5.4/gem_make.out +2 -2
- data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/{psych-4.0.1 → psych-4.0.2}/gem.build_complete +0 -0
- data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/{psych-4.0.1 → psych-4.0.2}/gem_make.out +6 -6
- data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/{psych-4.0.1 → psych-4.0.2}/mkmf.log +0 -0
- data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/{psych-4.0.1 → psych-4.0.2}/psych.so +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/byebug-11.1.3/ext/byebug/Makefile +2 -2
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/.github/workflows/ruby.yml +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/.gitignore +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/.rspec +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/CHANGELOG.md +5 -1
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/Gemfile +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/Guardfile +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/LICENSE +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/README.md +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/Rakefile +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/ethon.gemspec +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/curl.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/curls/classes.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/curls/codes.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/curls/constants.rb +17 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/curls/form_options.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/curls/functions.rb +1 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/curls/infos.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/curls/messages.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/curls/options.rb +33 -2
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/curls/settings.rb +2 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/callbacks.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/debug_info.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/features.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/form.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/header.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/http/actionable.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/http/custom.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/http/delete.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/http/get.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/http/head.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/http/options.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/http/patch.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/http/post.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/http/postable.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/http/put.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/http/putable.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/http.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/informations.rb +19 -1
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/mirror.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/operations.rb +1 -15
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/options.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/params.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/queryable.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/response_callbacks.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy/util.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/easy.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/errors/ethon_error.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/errors/global_init.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/errors/invalid_option.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/errors/invalid_value.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/errors/multi_add.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/errors/multi_fdset.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/errors/multi_remove.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/errors/multi_timeout.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/errors/select.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/errors.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/libc.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/loggable.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/multi/operations.rb +45 -8
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/multi/options.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/multi/stack.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/multi.rb +22 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon/version.rb +1 -1
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/lib/ethon.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/profile/benchmarks.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/profile/memory_leaks.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/profile/perf_spec_helper.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/profile/support/memory_test_helpers.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/profile/support/os_memory_leak_tracker.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/profile/support/ruby_object_leak_tracker.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/curl_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/easy/callbacks_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/easy/debug_info_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/easy/features_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/easy/form_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/easy/header_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/easy/http/custom_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/easy/http/delete_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/easy/http/get_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/easy/http/head_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/easy/http/options_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/easy/http/patch_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/easy/http/post_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/easy/http/put_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/easy/http_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/easy/informations_spec.rb +22 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/easy/mirror_spec.rb +1 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/easy/operations_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/easy/options_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/easy/queryable_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/easy/response_callbacks_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/easy/util_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/easy_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/libc_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/loggable_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/multi/operations_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/ethon-0.15.0/spec/ethon/multi/options_spec.rb +182 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/ethon/multi/stack_spec.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/ethon-0.15.0/spec/ethon/multi_spec.rb +152 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/spec_helper.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/support/localhost_server.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{ethon-0.14.0 → ethon-0.15.0}/spec/support/server.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/ffi-1.15.4/ext/ffi_c/Makefile +2 -2
- data/vendor/bundle/ruby/2.5.0/gems/jaro_winkler-1.5.4/ext/jaro_winkler/Makefile +2 -2
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/.gitignore +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/Gemfile +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/LICENSE +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/Mavenfile +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/README.md +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/Rakefile +1 -1
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/bin/console +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/bin/setup +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/.sitearchdir.time +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/Makefile +2 -2
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/api.o +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/depend +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/dumper.o +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/emitter.o +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/extconf.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/loader.o +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/parser.o +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/psych.c +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/psych.h +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/psych.o +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1/lib → psych-4.0.2/ext/psych}/psych.so +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/psych_emitter.c +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/psych_emitter.h +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/psych_emitter.o +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/psych_parser.c +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/psych_parser.h +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/psych_parser.o +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/psych_to_ruby.c +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/psych_to_ruby.h +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/psych_to_ruby.o +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/psych_yaml_tree.c +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/psych_yaml_tree.h +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/psych_yaml_tree.o +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/reader.o +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/scanner.o +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/writer.o +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/yaml/LICENSE +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/yaml/api.c +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/yaml/config.h +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/yaml/dumper.c +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/yaml/emitter.c +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/yaml/loader.c +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/yaml/parser.c +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/yaml/reader.c +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/yaml/scanner.c +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/yaml/writer.c +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/yaml/yaml.h +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/ext/psych/yaml/yaml_private.h +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/class_loader.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/coder.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/core_ext.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/exception.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/handler.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/handlers/document_stream.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/handlers/recorder.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/json/ruby_events.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/json/stream.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/json/tree_builder.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/json/yaml_events.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/nodes/alias.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/nodes/document.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/nodes/mapping.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/nodes/node.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/nodes/scalar.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/nodes/sequence.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/nodes/stream.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/nodes.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/omap.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/parser.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/scalar_scanner.rb +8 -9
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/set.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/stream.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/streaming.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/syntax_error.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/tree_builder.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/versions.rb +1 -1
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/visitors/depth_first.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/visitors/emitter.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/visitors/json_tree.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/visitors/to_ruby.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/visitors/visitor.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/visitors/yaml_tree.rb +2 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/visitors.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych/y.rb +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/lib/psych.rb +1 -1
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1/ext/psych → psych-4.0.2/lib}/psych.so +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/{psych-4.0.1 → psych-4.0.2}/psych.gemspec +0 -0
- data/vendor/bundle/ruby/2.5.0/specifications/{ethon-0.14.0.gemspec → ethon-0.15.0.gemspec} +3 -3
- data/vendor/bundle/ruby/2.5.0/specifications/{psych-4.0.1.gemspec → psych-4.0.2.gemspec} +3 -3
- metadata +271 -211
- data/docs/SuccessfulSelfServiceSettingsWithoutBrowser.md +0 -20
- data/vendor/bundle/ruby/2.5.0/cache/ethon-0.14.0.gem +0 -0
- data/vendor/bundle/ruby/2.5.0/cache/psych-4.0.1.gem +0 -0
- data/vendor/bundle/ruby/2.5.0/gems/ethon-0.14.0/spec/ethon/multi/options_spec.rb +0 -69
- data/vendor/bundle/ruby/2.5.0/gems/ethon-0.14.0/spec/ethon/multi_spec.rb +0 -22
@@ -1,41 +1,44 @@
|
|
1
|
-
# OryKratosClient::
|
1
|
+
# OryKratosClient::V0alpha2Api
|
2
2
|
|
3
3
|
All URIs are relative to *http://localhost*
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**admin_create_identity**](
|
8
|
-
| [**admin_create_self_service_recovery_link**](
|
9
|
-
| [**admin_delete_identity**](
|
10
|
-
| [**
|
11
|
-
| [**
|
12
|
-
| [**
|
13
|
-
| [**
|
14
|
-
| [**
|
15
|
-
| [**
|
16
|
-
| [**
|
17
|
-
| [**
|
18
|
-
| [**
|
19
|
-
| [**
|
20
|
-
| [**
|
21
|
-
| [**
|
22
|
-
| [**
|
23
|
-
| [**
|
24
|
-
| [**
|
25
|
-
| [**
|
26
|
-
| [**
|
27
|
-
| [**
|
28
|
-
| [**
|
29
|
-
| [**
|
30
|
-
| [**
|
31
|
-
| [**
|
32
|
-
| [**
|
33
|
-
| [**
|
34
|
-
| [**
|
35
|
-
| [**
|
36
|
-
| [**
|
37
|
-
| [**
|
38
|
-
| [**
|
7
|
+
| [**admin_create_identity**](V0alpha2Api.md#admin_create_identity) | **POST** /identities | Create an Identity |
|
8
|
+
| [**admin_create_self_service_recovery_link**](V0alpha2Api.md#admin_create_self_service_recovery_link) | **POST** /recovery/link | Create a Recovery Link |
|
9
|
+
| [**admin_delete_identity**](V0alpha2Api.md#admin_delete_identity) | **DELETE** /identities/{id} | Delete an Identity |
|
10
|
+
| [**admin_delete_identity_sessions**](V0alpha2Api.md#admin_delete_identity_sessions) | **DELETE** /identities/{id}/sessions | Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity. |
|
11
|
+
| [**admin_get_identity**](V0alpha2Api.md#admin_get_identity) | **GET** /identities/{id} | Get an Identity |
|
12
|
+
| [**admin_list_identities**](V0alpha2Api.md#admin_list_identities) | **GET** /identities | List Identities |
|
13
|
+
| [**admin_update_identity**](V0alpha2Api.md#admin_update_identity) | **PUT** /identities/{id} | Update an Identity |
|
14
|
+
| [**create_self_service_logout_flow_url_for_browsers**](V0alpha2Api.md#create_self_service_logout_flow_url_for_browsers) | **GET** /self-service/logout/browser | Create a Logout URL for Browsers |
|
15
|
+
| [**get_json_schema**](V0alpha2Api.md#get_json_schema) | **GET** /schemas/{id} | |
|
16
|
+
| [**get_self_service_error**](V0alpha2Api.md#get_self_service_error) | **GET** /self-service/errors | Get Self-Service Errors |
|
17
|
+
| [**get_self_service_login_flow**](V0alpha2Api.md#get_self_service_login_flow) | **GET** /self-service/login/flows | Get Login Flow |
|
18
|
+
| [**get_self_service_recovery_flow**](V0alpha2Api.md#get_self_service_recovery_flow) | **GET** /self-service/recovery/flows | Get Recovery Flow |
|
19
|
+
| [**get_self_service_registration_flow**](V0alpha2Api.md#get_self_service_registration_flow) | **GET** /self-service/registration/flows | Get Registration Flow |
|
20
|
+
| [**get_self_service_settings_flow**](V0alpha2Api.md#get_self_service_settings_flow) | **GET** /self-service/settings/flows | Get Settings Flow |
|
21
|
+
| [**get_self_service_verification_flow**](V0alpha2Api.md#get_self_service_verification_flow) | **GET** /self-service/verification/flows | Get Verification Flow |
|
22
|
+
| [**get_web_authn_java_script**](V0alpha2Api.md#get_web_authn_java_script) | **GET** /.well-known/ory/webauthn.js | Get WebAuthn JavaScript |
|
23
|
+
| [**initialize_self_service_login_flow_for_browsers**](V0alpha2Api.md#initialize_self_service_login_flow_for_browsers) | **GET** /self-service/login/browser | Initialize Login Flow for Browsers |
|
24
|
+
| [**initialize_self_service_login_flow_without_browser**](V0alpha2Api.md#initialize_self_service_login_flow_without_browser) | **GET** /self-service/login/api | Initialize Login Flow for APIs, Services, Apps, ... |
|
25
|
+
| [**initialize_self_service_recovery_flow_for_browsers**](V0alpha2Api.md#initialize_self_service_recovery_flow_for_browsers) | **GET** /self-service/recovery/browser | Initialize Recovery Flow for Browsers |
|
26
|
+
| [**initialize_self_service_recovery_flow_without_browser**](V0alpha2Api.md#initialize_self_service_recovery_flow_without_browser) | **GET** /self-service/recovery/api | Initialize Recovery Flow for APIs, Services, Apps, ... |
|
27
|
+
| [**initialize_self_service_registration_flow_for_browsers**](V0alpha2Api.md#initialize_self_service_registration_flow_for_browsers) | **GET** /self-service/registration/browser | Initialize Registration Flow for Browsers |
|
28
|
+
| [**initialize_self_service_registration_flow_without_browser**](V0alpha2Api.md#initialize_self_service_registration_flow_without_browser) | **GET** /self-service/registration/api | Initialize Registration Flow for APIs, Services, Apps, ... |
|
29
|
+
| [**initialize_self_service_settings_flow_for_browsers**](V0alpha2Api.md#initialize_self_service_settings_flow_for_browsers) | **GET** /self-service/settings/browser | Initialize Settings Flow for Browsers |
|
30
|
+
| [**initialize_self_service_settings_flow_without_browser**](V0alpha2Api.md#initialize_self_service_settings_flow_without_browser) | **GET** /self-service/settings/api | Initialize Settings Flow for APIs, Services, Apps, ... |
|
31
|
+
| [**initialize_self_service_verification_flow_for_browsers**](V0alpha2Api.md#initialize_self_service_verification_flow_for_browsers) | **GET** /self-service/verification/browser | Initialize Verification Flow for Browser Clients |
|
32
|
+
| [**initialize_self_service_verification_flow_without_browser**](V0alpha2Api.md#initialize_self_service_verification_flow_without_browser) | **GET** /self-service/verification/api | Initialize Verification Flow for APIs, Services, Apps, ... |
|
33
|
+
| [**list_identity_schemas**](V0alpha2Api.md#list_identity_schemas) | **GET** /schemas | |
|
34
|
+
| [**submit_self_service_login_flow**](V0alpha2Api.md#submit_self_service_login_flow) | **POST** /self-service/login | Submit a Login Flow |
|
35
|
+
| [**submit_self_service_logout_flow**](V0alpha2Api.md#submit_self_service_logout_flow) | **GET** /self-service/logout | Complete Self-Service Logout |
|
36
|
+
| [**submit_self_service_logout_flow_without_browser**](V0alpha2Api.md#submit_self_service_logout_flow_without_browser) | **DELETE** /self-service/logout/api | Perform Logout for APIs, Services, Apps, ... |
|
37
|
+
| [**submit_self_service_recovery_flow**](V0alpha2Api.md#submit_self_service_recovery_flow) | **POST** /self-service/recovery | Complete Recovery Flow |
|
38
|
+
| [**submit_self_service_registration_flow**](V0alpha2Api.md#submit_self_service_registration_flow) | **POST** /self-service/registration | Submit a Registration Flow |
|
39
|
+
| [**submit_self_service_settings_flow**](V0alpha2Api.md#submit_self_service_settings_flow) | **POST** /self-service/settings | Complete Settings Flow |
|
40
|
+
| [**submit_self_service_verification_flow**](V0alpha2Api.md#submit_self_service_verification_flow) | **POST** /self-service/verification | Complete Verification Flow |
|
41
|
+
| [**to_session**](V0alpha2Api.md#to_session) | **GET** /sessions/whoami | Check Who the Current HTTP Session Belongs To |
|
39
42
|
|
40
43
|
|
41
44
|
## admin_create_identity
|
@@ -59,7 +62,7 @@ OryKratosClient.configure do |config|
|
|
59
62
|
# config.api_key_prefix['oryAccessToken'] = 'Bearer'
|
60
63
|
end
|
61
64
|
|
62
|
-
api_instance = OryKratosClient::
|
65
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
63
66
|
opts = {
|
64
67
|
admin_create_identity_body: OryKratosClient::AdminCreateIdentityBody.new({schema_id: 'schema_id_example', traits: 3.56}) # AdminCreateIdentityBody |
|
65
68
|
}
|
@@ -69,7 +72,7 @@ begin
|
|
69
72
|
result = api_instance.admin_create_identity(opts)
|
70
73
|
p result
|
71
74
|
rescue OryKratosClient::ApiError => e
|
72
|
-
puts "Error when calling
|
75
|
+
puts "Error when calling V0alpha2Api->admin_create_identity: #{e}"
|
73
76
|
end
|
74
77
|
```
|
75
78
|
|
@@ -87,7 +90,7 @@ begin
|
|
87
90
|
p headers # => { ... }
|
88
91
|
p data # => <Identity>
|
89
92
|
rescue OryKratosClient::ApiError => e
|
90
|
-
puts "Error when calling
|
93
|
+
puts "Error when calling V0alpha2Api->admin_create_identity_with_http_info: #{e}"
|
91
94
|
end
|
92
95
|
```
|
93
96
|
|
@@ -125,7 +128,7 @@ This endpoint creates a recovery link which should be given to the user in order
|
|
125
128
|
require 'time'
|
126
129
|
require 'ory-kratos-client'
|
127
130
|
|
128
|
-
api_instance = OryKratosClient::
|
131
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
129
132
|
opts = {
|
130
133
|
admin_create_self_service_recovery_link_body: OryKratosClient::AdminCreateSelfServiceRecoveryLinkBody.new({identity_id: 'identity_id_example'}) # AdminCreateSelfServiceRecoveryLinkBody |
|
131
134
|
}
|
@@ -135,7 +138,7 @@ begin
|
|
135
138
|
result = api_instance.admin_create_self_service_recovery_link(opts)
|
136
139
|
p result
|
137
140
|
rescue OryKratosClient::ApiError => e
|
138
|
-
puts "Error when calling
|
141
|
+
puts "Error when calling V0alpha2Api->admin_create_self_service_recovery_link: #{e}"
|
139
142
|
end
|
140
143
|
```
|
141
144
|
|
@@ -153,7 +156,7 @@ begin
|
|
153
156
|
p headers # => { ... }
|
154
157
|
p data # => <SelfServiceRecoveryLink>
|
155
158
|
rescue OryKratosClient::ApiError => e
|
156
|
-
puts "Error when calling
|
159
|
+
puts "Error when calling V0alpha2Api->admin_create_self_service_recovery_link_with_http_info: #{e}"
|
157
160
|
end
|
158
161
|
```
|
159
162
|
|
@@ -198,14 +201,14 @@ OryKratosClient.configure do |config|
|
|
198
201
|
# config.api_key_prefix['oryAccessToken'] = 'Bearer'
|
199
202
|
end
|
200
203
|
|
201
|
-
api_instance = OryKratosClient::
|
204
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
202
205
|
id = 'id_example' # String | ID is the identity's ID.
|
203
206
|
|
204
207
|
begin
|
205
208
|
# Delete an Identity
|
206
209
|
api_instance.admin_delete_identity(id)
|
207
210
|
rescue OryKratosClient::ApiError => e
|
208
|
-
puts "Error when calling
|
211
|
+
puts "Error when calling V0alpha2Api->admin_delete_identity: #{e}"
|
209
212
|
end
|
210
213
|
```
|
211
214
|
|
@@ -223,7 +226,77 @@ begin
|
|
223
226
|
p headers # => { ... }
|
224
227
|
p data # => nil
|
225
228
|
rescue OryKratosClient::ApiError => e
|
226
|
-
puts "Error when calling
|
229
|
+
puts "Error when calling V0alpha2Api->admin_delete_identity_with_http_info: #{e}"
|
230
|
+
end
|
231
|
+
```
|
232
|
+
|
233
|
+
### Parameters
|
234
|
+
|
235
|
+
| Name | Type | Description | Notes |
|
236
|
+
| ---- | ---- | ----------- | ----- |
|
237
|
+
| **id** | **String** | ID is the identity's ID. | |
|
238
|
+
|
239
|
+
### Return type
|
240
|
+
|
241
|
+
nil (empty response body)
|
242
|
+
|
243
|
+
### Authorization
|
244
|
+
|
245
|
+
[oryAccessToken](../README.md#oryAccessToken)
|
246
|
+
|
247
|
+
### HTTP request headers
|
248
|
+
|
249
|
+
- **Content-Type**: Not defined
|
250
|
+
- **Accept**: application/json
|
251
|
+
|
252
|
+
|
253
|
+
## admin_delete_identity_sessions
|
254
|
+
|
255
|
+
> admin_delete_identity_sessions(id)
|
256
|
+
|
257
|
+
Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity.
|
258
|
+
|
259
|
+
This endpoint is useful for: To forcefully logout Identity from all devices and sessions
|
260
|
+
|
261
|
+
### Examples
|
262
|
+
|
263
|
+
```ruby
|
264
|
+
require 'time'
|
265
|
+
require 'ory-kratos-client'
|
266
|
+
# setup authorization
|
267
|
+
OryKratosClient.configure do |config|
|
268
|
+
# Configure API key authorization: oryAccessToken
|
269
|
+
config.api_key['oryAccessToken'] = 'YOUR API KEY'
|
270
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
271
|
+
# config.api_key_prefix['oryAccessToken'] = 'Bearer'
|
272
|
+
end
|
273
|
+
|
274
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
275
|
+
id = 'id_example' # String | ID is the identity's ID.
|
276
|
+
|
277
|
+
begin
|
278
|
+
# Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity.
|
279
|
+
api_instance.admin_delete_identity_sessions(id)
|
280
|
+
rescue OryKratosClient::ApiError => e
|
281
|
+
puts "Error when calling V0alpha2Api->admin_delete_identity_sessions: #{e}"
|
282
|
+
end
|
283
|
+
```
|
284
|
+
|
285
|
+
#### Using the admin_delete_identity_sessions_with_http_info variant
|
286
|
+
|
287
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
288
|
+
|
289
|
+
> <Array(nil, Integer, Hash)> admin_delete_identity_sessions_with_http_info(id)
|
290
|
+
|
291
|
+
```ruby
|
292
|
+
begin
|
293
|
+
# Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity.
|
294
|
+
data, status_code, headers = api_instance.admin_delete_identity_sessions_with_http_info(id)
|
295
|
+
p status_code # => 2xx
|
296
|
+
p headers # => { ... }
|
297
|
+
p data # => nil
|
298
|
+
rescue OryKratosClient::ApiError => e
|
299
|
+
puts "Error when calling V0alpha2Api->admin_delete_identity_sessions_with_http_info: #{e}"
|
227
300
|
end
|
228
301
|
```
|
229
302
|
|
@@ -249,7 +322,7 @@ nil (empty response body)
|
|
249
322
|
|
250
323
|
## admin_get_identity
|
251
324
|
|
252
|
-
> <Identity> admin_get_identity(id)
|
325
|
+
> <Identity> admin_get_identity(id, opts)
|
253
326
|
|
254
327
|
Get an Identity
|
255
328
|
|
@@ -268,15 +341,18 @@ OryKratosClient.configure do |config|
|
|
268
341
|
# config.api_key_prefix['oryAccessToken'] = 'Bearer'
|
269
342
|
end
|
270
343
|
|
271
|
-
api_instance = OryKratosClient::
|
344
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
272
345
|
id = 'id_example' # String | ID must be set to the ID of identity you want to get
|
346
|
+
opts = {
|
347
|
+
include_credential: ['inner_example'] # Array<String> | DeclassifyCredentials will declassify one or more identity's credentials Currently, only `oidc` is supported. This will return the initial OAuth 2.0 Access, Refresh and (optionally) OpenID Connect ID Token.
|
348
|
+
}
|
273
349
|
|
274
350
|
begin
|
275
351
|
# Get an Identity
|
276
|
-
result = api_instance.admin_get_identity(id)
|
352
|
+
result = api_instance.admin_get_identity(id, opts)
|
277
353
|
p result
|
278
354
|
rescue OryKratosClient::ApiError => e
|
279
|
-
puts "Error when calling
|
355
|
+
puts "Error when calling V0alpha2Api->admin_get_identity: #{e}"
|
280
356
|
end
|
281
357
|
```
|
282
358
|
|
@@ -284,17 +360,17 @@ end
|
|
284
360
|
|
285
361
|
This returns an Array which contains the response data, status code and headers.
|
286
362
|
|
287
|
-
> <Array(<Identity>, Integer, Hash)> admin_get_identity_with_http_info(id)
|
363
|
+
> <Array(<Identity>, Integer, Hash)> admin_get_identity_with_http_info(id, opts)
|
288
364
|
|
289
365
|
```ruby
|
290
366
|
begin
|
291
367
|
# Get an Identity
|
292
|
-
data, status_code, headers = api_instance.admin_get_identity_with_http_info(id)
|
368
|
+
data, status_code, headers = api_instance.admin_get_identity_with_http_info(id, opts)
|
293
369
|
p status_code # => 2xx
|
294
370
|
p headers # => { ... }
|
295
371
|
p data # => <Identity>
|
296
372
|
rescue OryKratosClient::ApiError => e
|
297
|
-
puts "Error when calling
|
373
|
+
puts "Error when calling V0alpha2Api->admin_get_identity_with_http_info: #{e}"
|
298
374
|
end
|
299
375
|
```
|
300
376
|
|
@@ -303,6 +379,7 @@ end
|
|
303
379
|
| Name | Type | Description | Notes |
|
304
380
|
| ---- | ---- | ----------- | ----- |
|
305
381
|
| **id** | **String** | ID must be set to the ID of identity you want to get | |
|
382
|
+
| **include_credential** | [**Array<String>**](String.md) | DeclassifyCredentials will declassify one or more identity's credentials Currently, only `oidc` is supported. This will return the initial OAuth 2.0 Access, Refresh and (optionally) OpenID Connect ID Token. | [optional] |
|
306
383
|
|
307
384
|
### Return type
|
308
385
|
|
@@ -339,7 +416,7 @@ OryKratosClient.configure do |config|
|
|
339
416
|
# config.api_key_prefix['oryAccessToken'] = 'Bearer'
|
340
417
|
end
|
341
418
|
|
342
|
-
api_instance = OryKratosClient::
|
419
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
343
420
|
opts = {
|
344
421
|
per_page: 789, # Integer | Items per Page This is the number of items per page.
|
345
422
|
page: 789 # Integer | Pagination Page
|
@@ -350,7 +427,7 @@ begin
|
|
350
427
|
result = api_instance.admin_list_identities(opts)
|
351
428
|
p result
|
352
429
|
rescue OryKratosClient::ApiError => e
|
353
|
-
puts "Error when calling
|
430
|
+
puts "Error when calling V0alpha2Api->admin_list_identities: #{e}"
|
354
431
|
end
|
355
432
|
```
|
356
433
|
|
@@ -368,7 +445,7 @@ begin
|
|
368
445
|
p headers # => { ... }
|
369
446
|
p data # => <Array<Identity>>
|
370
447
|
rescue OryKratosClient::ApiError => e
|
371
|
-
puts "Error when calling
|
448
|
+
puts "Error when calling V0alpha2Api->admin_list_identities_with_http_info: #{e}"
|
372
449
|
end
|
373
450
|
```
|
374
451
|
|
@@ -414,7 +491,7 @@ OryKratosClient.configure do |config|
|
|
414
491
|
# config.api_key_prefix['oryAccessToken'] = 'Bearer'
|
415
492
|
end
|
416
493
|
|
417
|
-
api_instance = OryKratosClient::
|
494
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
418
495
|
id = 'id_example' # String | ID must be set to the ID of identity you want to update
|
419
496
|
opts = {
|
420
497
|
admin_update_identity_body: OryKratosClient::AdminUpdateIdentityBody.new({state: OryKratosClient::IdentityState::ACTIVE, traits: 3.56}) # AdminUpdateIdentityBody |
|
@@ -425,7 +502,7 @@ begin
|
|
425
502
|
result = api_instance.admin_update_identity(id, opts)
|
426
503
|
p result
|
427
504
|
rescue OryKratosClient::ApiError => e
|
428
|
-
puts "Error when calling
|
505
|
+
puts "Error when calling V0alpha2Api->admin_update_identity: #{e}"
|
429
506
|
end
|
430
507
|
```
|
431
508
|
|
@@ -443,7 +520,7 @@ begin
|
|
443
520
|
p headers # => { ... }
|
444
521
|
p data # => <Identity>
|
445
522
|
rescue OryKratosClient::ApiError => e
|
446
|
-
puts "Error when calling
|
523
|
+
puts "Error when calling V0alpha2Api->admin_update_identity_with_http_info: #{e}"
|
447
524
|
end
|
448
525
|
```
|
449
526
|
|
@@ -482,7 +559,7 @@ This endpoint initializes a browser-based user logout flow and a URL which can b
|
|
482
559
|
require 'time'
|
483
560
|
require 'ory-kratos-client'
|
484
561
|
|
485
|
-
api_instance = OryKratosClient::
|
562
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
486
563
|
opts = {
|
487
564
|
cookie: 'cookie_example' # String | HTTP Cookies If you call this endpoint from a backend, please include the original Cookie header in the request.
|
488
565
|
}
|
@@ -492,7 +569,7 @@ begin
|
|
492
569
|
result = api_instance.create_self_service_logout_flow_url_for_browsers(opts)
|
493
570
|
p result
|
494
571
|
rescue OryKratosClient::ApiError => e
|
495
|
-
puts "Error when calling
|
572
|
+
puts "Error when calling V0alpha2Api->create_self_service_logout_flow_url_for_browsers: #{e}"
|
496
573
|
end
|
497
574
|
```
|
498
575
|
|
@@ -510,7 +587,7 @@ begin
|
|
510
587
|
p headers # => { ... }
|
511
588
|
p data # => <SelfServiceLogoutUrl>
|
512
589
|
rescue OryKratosClient::ApiError => e
|
513
|
-
puts "Error when calling
|
590
|
+
puts "Error when calling V0alpha2Api->create_self_service_logout_flow_url_for_browsers_with_http_info: #{e}"
|
514
591
|
end
|
515
592
|
```
|
516
593
|
|
@@ -548,7 +625,7 @@ Get a JSON Schema
|
|
548
625
|
require 'time'
|
549
626
|
require 'ory-kratos-client'
|
550
627
|
|
551
|
-
api_instance = OryKratosClient::
|
628
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
552
629
|
id = 'id_example' # String | ID must be set to the ID of schema you want to get
|
553
630
|
|
554
631
|
begin
|
@@ -556,7 +633,7 @@ begin
|
|
556
633
|
result = api_instance.get_json_schema(id)
|
557
634
|
p result
|
558
635
|
rescue OryKratosClient::ApiError => e
|
559
|
-
puts "Error when calling
|
636
|
+
puts "Error when calling V0alpha2Api->get_json_schema: #{e}"
|
560
637
|
end
|
561
638
|
```
|
562
639
|
|
@@ -574,7 +651,7 @@ begin
|
|
574
651
|
p headers # => { ... }
|
575
652
|
p data # => Object
|
576
653
|
rescue OryKratosClient::ApiError => e
|
577
|
-
puts "Error when calling
|
654
|
+
puts "Error when calling V0alpha2Api->get_json_schema_with_http_info: #{e}"
|
578
655
|
end
|
579
656
|
```
|
580
657
|
|
@@ -612,7 +689,7 @@ This endpoint returns the error associated with a user-facing self service error
|
|
612
689
|
require 'time'
|
613
690
|
require 'ory-kratos-client'
|
614
691
|
|
615
|
-
api_instance = OryKratosClient::
|
692
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
616
693
|
id = 'id_example' # String | Error is the error's ID
|
617
694
|
|
618
695
|
begin
|
@@ -620,7 +697,7 @@ begin
|
|
620
697
|
result = api_instance.get_self_service_error(id)
|
621
698
|
p result
|
622
699
|
rescue OryKratosClient::ApiError => e
|
623
|
-
puts "Error when calling
|
700
|
+
puts "Error when calling V0alpha2Api->get_self_service_error: #{e}"
|
624
701
|
end
|
625
702
|
```
|
626
703
|
|
@@ -638,7 +715,7 @@ begin
|
|
638
715
|
p headers # => { ... }
|
639
716
|
p data # => <SelfServiceError>
|
640
717
|
rescue OryKratosClient::ApiError => e
|
641
|
-
puts "Error when calling
|
718
|
+
puts "Error when calling V0alpha2Api->get_self_service_error_with_http_info: #{e}"
|
642
719
|
end
|
643
720
|
```
|
644
721
|
|
@@ -668,7 +745,7 @@ No authorization required
|
|
668
745
|
|
669
746
|
Get Login Flow
|
670
747
|
|
671
|
-
This endpoint returns a login flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/login', async function (req, res) { const flow = await client.getSelfServiceLoginFlow(req.header('cookie'), req.query['flow']) res.render('login', flow) }) ``` More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
748
|
+
This endpoint returns a login flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/login', async function (req, res) { const flow = await client.getSelfServiceLoginFlow(req.header('cookie'), req.query['flow']) res.render('login', flow) }) ``` This request may fail due to several reasons. The `error.id` can be one of: `session_already_available`: The user is already signed in. `self_service_flow_expired`: The flow is expired and you should request a new one. More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
672
749
|
|
673
750
|
### Examples
|
674
751
|
|
@@ -676,7 +753,7 @@ This endpoint returns a login flow's context with, for example, error details an
|
|
676
753
|
require 'time'
|
677
754
|
require 'ory-kratos-client'
|
678
755
|
|
679
|
-
api_instance = OryKratosClient::
|
756
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
680
757
|
id = 'id_example' # String | The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`).
|
681
758
|
opts = {
|
682
759
|
cookie: 'cookie_example' # String | HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.
|
@@ -687,7 +764,7 @@ begin
|
|
687
764
|
result = api_instance.get_self_service_login_flow(id, opts)
|
688
765
|
p result
|
689
766
|
rescue OryKratosClient::ApiError => e
|
690
|
-
puts "Error when calling
|
767
|
+
puts "Error when calling V0alpha2Api->get_self_service_login_flow: #{e}"
|
691
768
|
end
|
692
769
|
```
|
693
770
|
|
@@ -705,7 +782,7 @@ begin
|
|
705
782
|
p headers # => { ... }
|
706
783
|
p data # => <SelfServiceLoginFlow>
|
707
784
|
rescue OryKratosClient::ApiError => e
|
708
|
-
puts "Error when calling
|
785
|
+
puts "Error when calling V0alpha2Api->get_self_service_login_flow_with_http_info: #{e}"
|
709
786
|
end
|
710
787
|
```
|
711
788
|
|
@@ -744,7 +821,7 @@ This endpoint returns a recovery flow's context with, for example, error details
|
|
744
821
|
require 'time'
|
745
822
|
require 'ory-kratos-client'
|
746
823
|
|
747
|
-
api_instance = OryKratosClient::
|
824
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
748
825
|
id = 'id_example' # String | The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`).
|
749
826
|
opts = {
|
750
827
|
cookie: 'cookie_example' # String | HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.
|
@@ -755,7 +832,7 @@ begin
|
|
755
832
|
result = api_instance.get_self_service_recovery_flow(id, opts)
|
756
833
|
p result
|
757
834
|
rescue OryKratosClient::ApiError => e
|
758
|
-
puts "Error when calling
|
835
|
+
puts "Error when calling V0alpha2Api->get_self_service_recovery_flow: #{e}"
|
759
836
|
end
|
760
837
|
```
|
761
838
|
|
@@ -773,7 +850,7 @@ begin
|
|
773
850
|
p headers # => { ... }
|
774
851
|
p data # => <SelfServiceRecoveryFlow>
|
775
852
|
rescue OryKratosClient::ApiError => e
|
776
|
-
puts "Error when calling
|
853
|
+
puts "Error when calling V0alpha2Api->get_self_service_recovery_flow_with_http_info: #{e}"
|
777
854
|
end
|
778
855
|
```
|
779
856
|
|
@@ -804,7 +881,7 @@ No authorization required
|
|
804
881
|
|
805
882
|
Get Registration Flow
|
806
883
|
|
807
|
-
This endpoint returns a registration flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/registration', async function (req, res) { const flow = await client.getSelfServiceRegistrationFlow(req.header('cookie'), req.query['flow']) res.render('registration', flow) }) ``` More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
884
|
+
This endpoint returns a registration flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/registration', async function (req, res) { const flow = await client.getSelfServiceRegistrationFlow(req.header('cookie'), req.query['flow']) res.render('registration', flow) }) ``` This request may fail due to several reasons. The `error.id` can be one of: `session_already_available`: The user is already signed in. `self_service_flow_expired`: The flow is expired and you should request a new one. More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
808
885
|
|
809
886
|
### Examples
|
810
887
|
|
@@ -812,7 +889,7 @@ This endpoint returns a registration flow's context with, for example, error det
|
|
812
889
|
require 'time'
|
813
890
|
require 'ory-kratos-client'
|
814
891
|
|
815
|
-
api_instance = OryKratosClient::
|
892
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
816
893
|
id = 'id_example' # String | The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
|
817
894
|
opts = {
|
818
895
|
cookie: 'cookie_example' # String | HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.
|
@@ -823,7 +900,7 @@ begin
|
|
823
900
|
result = api_instance.get_self_service_registration_flow(id, opts)
|
824
901
|
p result
|
825
902
|
rescue OryKratosClient::ApiError => e
|
826
|
-
puts "Error when calling
|
903
|
+
puts "Error when calling V0alpha2Api->get_self_service_registration_flow: #{e}"
|
827
904
|
end
|
828
905
|
```
|
829
906
|
|
@@ -841,7 +918,7 @@ begin
|
|
841
918
|
p headers # => { ... }
|
842
919
|
p data # => <SelfServiceRegistrationFlow>
|
843
920
|
rescue OryKratosClient::ApiError => e
|
844
|
-
puts "Error when calling
|
921
|
+
puts "Error when calling V0alpha2Api->get_self_service_registration_flow_with_http_info: #{e}"
|
845
922
|
end
|
846
923
|
```
|
847
924
|
|
@@ -872,7 +949,7 @@ No authorization required
|
|
872
949
|
|
873
950
|
Get Settings Flow
|
874
951
|
|
875
|
-
When accessing this endpoint through Ory Kratos' Public API you must ensure that either the Ory Kratos Session Cookie or the Ory Kratos Session Token are set.
|
952
|
+
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).
|
876
953
|
|
877
954
|
### Examples
|
878
955
|
|
@@ -880,7 +957,7 @@ When accessing this endpoint through Ory Kratos' Public API you must ensure that
|
|
880
957
|
require 'time'
|
881
958
|
require 'ory-kratos-client'
|
882
959
|
|
883
|
-
api_instance = OryKratosClient::
|
960
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
884
961
|
id = 'id_example' # String | ID is the Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`).
|
885
962
|
opts = {
|
886
963
|
x_session_token: 'x_session_token_example', # String | The Session Token When using the SDK in an app without a browser, please include the session token here.
|
@@ -892,7 +969,7 @@ begin
|
|
892
969
|
result = api_instance.get_self_service_settings_flow(id, opts)
|
893
970
|
p result
|
894
971
|
rescue OryKratosClient::ApiError => e
|
895
|
-
puts "Error when calling
|
972
|
+
puts "Error when calling V0alpha2Api->get_self_service_settings_flow: #{e}"
|
896
973
|
end
|
897
974
|
```
|
898
975
|
|
@@ -910,7 +987,7 @@ begin
|
|
910
987
|
p headers # => { ... }
|
911
988
|
p data # => <SelfServiceSettingsFlow>
|
912
989
|
rescue OryKratosClient::ApiError => e
|
913
|
-
puts "Error when calling
|
990
|
+
puts "Error when calling V0alpha2Api->get_self_service_settings_flow_with_http_info: #{e}"
|
914
991
|
end
|
915
992
|
```
|
916
993
|
|
@@ -950,7 +1027,7 @@ This endpoint returns a verification flow's context with, for example, error det
|
|
950
1027
|
require 'time'
|
951
1028
|
require 'ory-kratos-client'
|
952
1029
|
|
953
|
-
api_instance = OryKratosClient::
|
1030
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
954
1031
|
id = 'id_example' # String | The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`).
|
955
1032
|
opts = {
|
956
1033
|
cookie: 'cookie_example' # String | HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.
|
@@ -961,7 +1038,7 @@ begin
|
|
961
1038
|
result = api_instance.get_self_service_verification_flow(id, opts)
|
962
1039
|
p result
|
963
1040
|
rescue OryKratosClient::ApiError => e
|
964
|
-
puts "Error when calling
|
1041
|
+
puts "Error when calling V0alpha2Api->get_self_service_verification_flow: #{e}"
|
965
1042
|
end
|
966
1043
|
```
|
967
1044
|
|
@@ -979,7 +1056,7 @@ begin
|
|
979
1056
|
p headers # => { ... }
|
980
1057
|
p data # => <SelfServiceVerificationFlow>
|
981
1058
|
rescue OryKratosClient::ApiError => e
|
982
|
-
puts "Error when calling
|
1059
|
+
puts "Error when calling V0alpha2Api->get_self_service_verification_flow_with_http_info: #{e}"
|
983
1060
|
end
|
984
1061
|
```
|
985
1062
|
|
@@ -1004,13 +1081,74 @@ No authorization required
|
|
1004
1081
|
- **Accept**: application/json
|
1005
1082
|
|
1006
1083
|
|
1084
|
+
## get_web_authn_java_script
|
1085
|
+
|
1086
|
+
> String get_web_authn_java_script
|
1087
|
+
|
1088
|
+
Get WebAuthn JavaScript
|
1089
|
+
|
1090
|
+
This endpoint provides JavaScript which is needed in order to perform WebAuthn login and registration. If you are building a JavaScript Browser App (e.g. in ReactJS or AngularJS) you will need to load this file: ```html <script src=\"https://public-kratos.example.org/.well-known/ory/webauthn.js\" type=\"script\" async /> ``` More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
1091
|
+
|
1092
|
+
### Examples
|
1093
|
+
|
1094
|
+
```ruby
|
1095
|
+
require 'time'
|
1096
|
+
require 'ory-kratos-client'
|
1097
|
+
|
1098
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
1099
|
+
|
1100
|
+
begin
|
1101
|
+
# Get WebAuthn JavaScript
|
1102
|
+
result = api_instance.get_web_authn_java_script
|
1103
|
+
p result
|
1104
|
+
rescue OryKratosClient::ApiError => e
|
1105
|
+
puts "Error when calling V0alpha2Api->get_web_authn_java_script: #{e}"
|
1106
|
+
end
|
1107
|
+
```
|
1108
|
+
|
1109
|
+
#### Using the get_web_authn_java_script_with_http_info variant
|
1110
|
+
|
1111
|
+
This returns an Array which contains the response data, status code and headers.
|
1112
|
+
|
1113
|
+
> <Array(String, Integer, Hash)> get_web_authn_java_script_with_http_info
|
1114
|
+
|
1115
|
+
```ruby
|
1116
|
+
begin
|
1117
|
+
# Get WebAuthn JavaScript
|
1118
|
+
data, status_code, headers = api_instance.get_web_authn_java_script_with_http_info
|
1119
|
+
p status_code # => 2xx
|
1120
|
+
p headers # => { ... }
|
1121
|
+
p data # => String
|
1122
|
+
rescue OryKratosClient::ApiError => e
|
1123
|
+
puts "Error when calling V0alpha2Api->get_web_authn_java_script_with_http_info: #{e}"
|
1124
|
+
end
|
1125
|
+
```
|
1126
|
+
|
1127
|
+
### Parameters
|
1128
|
+
|
1129
|
+
This endpoint does not need any parameter.
|
1130
|
+
|
1131
|
+
### Return type
|
1132
|
+
|
1133
|
+
**String**
|
1134
|
+
|
1135
|
+
### Authorization
|
1136
|
+
|
1137
|
+
No authorization required
|
1138
|
+
|
1139
|
+
### HTTP request headers
|
1140
|
+
|
1141
|
+
- **Content-Type**: Not defined
|
1142
|
+
- **Accept**: application/json
|
1143
|
+
|
1144
|
+
|
1007
1145
|
## initialize_self_service_login_flow_for_browsers
|
1008
1146
|
|
1009
1147
|
> <SelfServiceLoginFlow> initialize_self_service_login_flow_for_browsers(opts)
|
1010
1148
|
|
1011
1149
|
Initialize Login Flow for Browsers
|
1012
1150
|
|
1013
|
-
This endpoint initializes a browser-based user login flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for browser-based flows. If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.login.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url` unless the query parameter `?refresh=true` was set. If this endpoint is called via an AJAX request, the response contains the
|
1151
|
+
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! This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
1014
1152
|
|
1015
1153
|
### Examples
|
1016
1154
|
|
@@ -1018,9 +1156,11 @@ This endpoint initializes a browser-based user login flow. This endpoint will se
|
|
1018
1156
|
require 'time'
|
1019
1157
|
require 'ory-kratos-client'
|
1020
1158
|
|
1021
|
-
api_instance = OryKratosClient::
|
1159
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
1022
1160
|
opts = {
|
1023
|
-
refresh: true # Boolean | Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session.
|
1161
|
+
refresh: true, # Boolean | Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session.
|
1162
|
+
aal: 'aal_example', # String | 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\".
|
1163
|
+
return_to: 'return_to_example' # String | The URL to return the browser to after the flow was completed.
|
1024
1164
|
}
|
1025
1165
|
|
1026
1166
|
begin
|
@@ -1028,7 +1168,7 @@ begin
|
|
1028
1168
|
result = api_instance.initialize_self_service_login_flow_for_browsers(opts)
|
1029
1169
|
p result
|
1030
1170
|
rescue OryKratosClient::ApiError => e
|
1031
|
-
puts "Error when calling
|
1171
|
+
puts "Error when calling V0alpha2Api->initialize_self_service_login_flow_for_browsers: #{e}"
|
1032
1172
|
end
|
1033
1173
|
```
|
1034
1174
|
|
@@ -1046,7 +1186,7 @@ begin
|
|
1046
1186
|
p headers # => { ... }
|
1047
1187
|
p data # => <SelfServiceLoginFlow>
|
1048
1188
|
rescue OryKratosClient::ApiError => e
|
1049
|
-
puts "Error when calling
|
1189
|
+
puts "Error when calling V0alpha2Api->initialize_self_service_login_flow_for_browsers_with_http_info: #{e}"
|
1050
1190
|
end
|
1051
1191
|
```
|
1052
1192
|
|
@@ -1055,6 +1195,8 @@ end
|
|
1055
1195
|
| Name | Type | Description | Notes |
|
1056
1196
|
| ---- | ---- | ----------- | ----- |
|
1057
1197
|
| **refresh** | **Boolean** | Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session. | [optional] |
|
1198
|
+
| **aal** | **String** | 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\". | [optional] |
|
1199
|
+
| **return_to** | **String** | The URL to return the browser to after the flow was completed. | [optional] |
|
1058
1200
|
|
1059
1201
|
### Return type
|
1060
1202
|
|
@@ -1076,7 +1218,7 @@ No authorization required
|
|
1076
1218
|
|
1077
1219
|
Initialize Login Flow for APIs, Services, Apps, ...
|
1078
1220
|
|
1079
|
-
This endpoint initiates a login flow for API clients that do not use a browser, such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing login flow call `/self-service/login/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks, including CSRF login attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
1221
|
+
This endpoint initiates a login flow for API clients that do not use a browser, such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing login flow call `/self-service/login/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks, including CSRF login attacks. 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 and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
1080
1222
|
|
1081
1223
|
### Examples
|
1082
1224
|
|
@@ -1084,9 +1226,11 @@ This endpoint initiates a login flow for API clients that do not use a browser,
|
|
1084
1226
|
require 'time'
|
1085
1227
|
require 'ory-kratos-client'
|
1086
1228
|
|
1087
|
-
api_instance = OryKratosClient::
|
1229
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
1088
1230
|
opts = {
|
1089
|
-
refresh: true # Boolean | Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session.
|
1231
|
+
refresh: true, # Boolean | Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session.
|
1232
|
+
aal: 'aal_example', # String | 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\".
|
1233
|
+
x_session_token: 'x_session_token_example' # String | The Session Token of the Identity performing the settings flow.
|
1090
1234
|
}
|
1091
1235
|
|
1092
1236
|
begin
|
@@ -1094,7 +1238,7 @@ begin
|
|
1094
1238
|
result = api_instance.initialize_self_service_login_flow_without_browser(opts)
|
1095
1239
|
p result
|
1096
1240
|
rescue OryKratosClient::ApiError => e
|
1097
|
-
puts "Error when calling
|
1241
|
+
puts "Error when calling V0alpha2Api->initialize_self_service_login_flow_without_browser: #{e}"
|
1098
1242
|
end
|
1099
1243
|
```
|
1100
1244
|
|
@@ -1112,7 +1256,7 @@ begin
|
|
1112
1256
|
p headers # => { ... }
|
1113
1257
|
p data # => <SelfServiceLoginFlow>
|
1114
1258
|
rescue OryKratosClient::ApiError => e
|
1115
|
-
puts "Error when calling
|
1259
|
+
puts "Error when calling V0alpha2Api->initialize_self_service_login_flow_without_browser_with_http_info: #{e}"
|
1116
1260
|
end
|
1117
1261
|
```
|
1118
1262
|
|
@@ -1121,6 +1265,8 @@ end
|
|
1121
1265
|
| Name | Type | Description | Notes |
|
1122
1266
|
| ---- | ---- | ----------- | ----- |
|
1123
1267
|
| **refresh** | **Boolean** | Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session. | [optional] |
|
1268
|
+
| **aal** | **String** | 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\". | [optional] |
|
1269
|
+
| **x_session_token** | **String** | The Session Token of the Identity performing the settings flow. | [optional] |
|
1124
1270
|
|
1125
1271
|
### Return type
|
1126
1272
|
|
@@ -1138,7 +1284,7 @@ No authorization required
|
|
1138
1284
|
|
1139
1285
|
## initialize_self_service_recovery_flow_for_browsers
|
1140
1286
|
|
1141
|
-
> <SelfServiceRecoveryFlow> initialize_self_service_recovery_flow_for_browsers
|
1287
|
+
> <SelfServiceRecoveryFlow> initialize_self_service_recovery_flow_for_browsers(opts)
|
1142
1288
|
|
1143
1289
|
Initialize Recovery Flow for Browsers
|
1144
1290
|
|
@@ -1150,14 +1296,17 @@ This endpoint initializes a browser-based account recovery flow. Once initialize
|
|
1150
1296
|
require 'time'
|
1151
1297
|
require 'ory-kratos-client'
|
1152
1298
|
|
1153
|
-
api_instance = OryKratosClient::
|
1299
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
1300
|
+
opts = {
|
1301
|
+
return_to: 'return_to_example' # String | The URL to return the browser to after the flow was completed.
|
1302
|
+
}
|
1154
1303
|
|
1155
1304
|
begin
|
1156
1305
|
# Initialize Recovery Flow for Browsers
|
1157
|
-
result = api_instance.initialize_self_service_recovery_flow_for_browsers
|
1306
|
+
result = api_instance.initialize_self_service_recovery_flow_for_browsers(opts)
|
1158
1307
|
p result
|
1159
1308
|
rescue OryKratosClient::ApiError => e
|
1160
|
-
puts "Error when calling
|
1309
|
+
puts "Error when calling V0alpha2Api->initialize_self_service_recovery_flow_for_browsers: #{e}"
|
1161
1310
|
end
|
1162
1311
|
```
|
1163
1312
|
|
@@ -1165,23 +1314,25 @@ end
|
|
1165
1314
|
|
1166
1315
|
This returns an Array which contains the response data, status code and headers.
|
1167
1316
|
|
1168
|
-
> <Array(<SelfServiceRecoveryFlow>, Integer, Hash)> initialize_self_service_recovery_flow_for_browsers_with_http_info
|
1317
|
+
> <Array(<SelfServiceRecoveryFlow>, Integer, Hash)> initialize_self_service_recovery_flow_for_browsers_with_http_info(opts)
|
1169
1318
|
|
1170
1319
|
```ruby
|
1171
1320
|
begin
|
1172
1321
|
# Initialize Recovery Flow for Browsers
|
1173
|
-
data, status_code, headers = api_instance.initialize_self_service_recovery_flow_for_browsers_with_http_info
|
1322
|
+
data, status_code, headers = api_instance.initialize_self_service_recovery_flow_for_browsers_with_http_info(opts)
|
1174
1323
|
p status_code # => 2xx
|
1175
1324
|
p headers # => { ... }
|
1176
1325
|
p data # => <SelfServiceRecoveryFlow>
|
1177
1326
|
rescue OryKratosClient::ApiError => e
|
1178
|
-
puts "Error when calling
|
1327
|
+
puts "Error when calling V0alpha2Api->initialize_self_service_recovery_flow_for_browsers_with_http_info: #{e}"
|
1179
1328
|
end
|
1180
1329
|
```
|
1181
1330
|
|
1182
1331
|
### Parameters
|
1183
1332
|
|
1184
|
-
|
1333
|
+
| Name | Type | Description | Notes |
|
1334
|
+
| ---- | ---- | ----------- | ----- |
|
1335
|
+
| **return_to** | **String** | The URL to return the browser to after the flow was completed. | [optional] |
|
1185
1336
|
|
1186
1337
|
### Return type
|
1187
1338
|
|
@@ -1211,14 +1362,14 @@ This endpoint initiates a recovery flow for API clients such as mobile devices,
|
|
1211
1362
|
require 'time'
|
1212
1363
|
require 'ory-kratos-client'
|
1213
1364
|
|
1214
|
-
api_instance = OryKratosClient::
|
1365
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
1215
1366
|
|
1216
1367
|
begin
|
1217
1368
|
# Initialize Recovery Flow for APIs, Services, Apps, ...
|
1218
1369
|
result = api_instance.initialize_self_service_recovery_flow_without_browser
|
1219
1370
|
p result
|
1220
1371
|
rescue OryKratosClient::ApiError => e
|
1221
|
-
puts "Error when calling
|
1372
|
+
puts "Error when calling V0alpha2Api->initialize_self_service_recovery_flow_without_browser: #{e}"
|
1222
1373
|
end
|
1223
1374
|
```
|
1224
1375
|
|
@@ -1236,7 +1387,7 @@ begin
|
|
1236
1387
|
p headers # => { ... }
|
1237
1388
|
p data # => <SelfServiceRecoveryFlow>
|
1238
1389
|
rescue OryKratosClient::ApiError => e
|
1239
|
-
puts "Error when calling
|
1390
|
+
puts "Error when calling V0alpha2Api->initialize_self_service_recovery_flow_without_browser_with_http_info: #{e}"
|
1240
1391
|
end
|
1241
1392
|
```
|
1242
1393
|
|
@@ -1260,11 +1411,11 @@ No authorization required
|
|
1260
1411
|
|
1261
1412
|
## initialize_self_service_registration_flow_for_browsers
|
1262
1413
|
|
1263
|
-
> <SelfServiceRegistrationFlow> initialize_self_service_registration_flow_for_browsers
|
1414
|
+
> <SelfServiceRegistrationFlow> initialize_self_service_registration_flow_for_browsers(opts)
|
1264
1415
|
|
1265
1416
|
Initialize Registration Flow for Browsers
|
1266
1417
|
|
1267
|
-
This endpoint initializes a browser-based user registration flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for browser-based flows. :::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.registration.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url`. If this endpoint is called via an AJAX request, the response contains the registration flow without a redirect. This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
1418
|
+
This endpoint initializes a browser-based user registration flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for browser-based flows. :::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.registration.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url`. If this endpoint is called via an AJAX request, the response contains the 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 and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
1268
1419
|
|
1269
1420
|
### Examples
|
1270
1421
|
|
@@ -1272,14 +1423,17 @@ This endpoint initializes a browser-based user registration flow. This endpoint
|
|
1272
1423
|
require 'time'
|
1273
1424
|
require 'ory-kratos-client'
|
1274
1425
|
|
1275
|
-
api_instance = OryKratosClient::
|
1426
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
1427
|
+
opts = {
|
1428
|
+
return_to: 'return_to_example' # String | The URL to return the browser to after the flow was completed.
|
1429
|
+
}
|
1276
1430
|
|
1277
1431
|
begin
|
1278
1432
|
# Initialize Registration Flow for Browsers
|
1279
|
-
result = api_instance.initialize_self_service_registration_flow_for_browsers
|
1433
|
+
result = api_instance.initialize_self_service_registration_flow_for_browsers(opts)
|
1280
1434
|
p result
|
1281
1435
|
rescue OryKratosClient::ApiError => e
|
1282
|
-
puts "Error when calling
|
1436
|
+
puts "Error when calling V0alpha2Api->initialize_self_service_registration_flow_for_browsers: #{e}"
|
1283
1437
|
end
|
1284
1438
|
```
|
1285
1439
|
|
@@ -1287,23 +1441,25 @@ end
|
|
1287
1441
|
|
1288
1442
|
This returns an Array which contains the response data, status code and headers.
|
1289
1443
|
|
1290
|
-
> <Array(<SelfServiceRegistrationFlow>, Integer, Hash)> initialize_self_service_registration_flow_for_browsers_with_http_info
|
1444
|
+
> <Array(<SelfServiceRegistrationFlow>, Integer, Hash)> initialize_self_service_registration_flow_for_browsers_with_http_info(opts)
|
1291
1445
|
|
1292
1446
|
```ruby
|
1293
1447
|
begin
|
1294
1448
|
# Initialize Registration Flow for Browsers
|
1295
|
-
data, status_code, headers = api_instance.initialize_self_service_registration_flow_for_browsers_with_http_info
|
1449
|
+
data, status_code, headers = api_instance.initialize_self_service_registration_flow_for_browsers_with_http_info(opts)
|
1296
1450
|
p status_code # => 2xx
|
1297
1451
|
p headers # => { ... }
|
1298
1452
|
p data # => <SelfServiceRegistrationFlow>
|
1299
1453
|
rescue OryKratosClient::ApiError => e
|
1300
|
-
puts "Error when calling
|
1454
|
+
puts "Error when calling V0alpha2Api->initialize_self_service_registration_flow_for_browsers_with_http_info: #{e}"
|
1301
1455
|
end
|
1302
1456
|
```
|
1303
1457
|
|
1304
1458
|
### Parameters
|
1305
1459
|
|
1306
|
-
|
1460
|
+
| Name | Type | Description | Notes |
|
1461
|
+
| ---- | ---- | ----------- | ----- |
|
1462
|
+
| **return_to** | **String** | The URL to return the browser to after the flow was completed. | [optional] |
|
1307
1463
|
|
1308
1464
|
### Return type
|
1309
1465
|
|
@@ -1325,7 +1481,7 @@ No authorization required
|
|
1325
1481
|
|
1326
1482
|
Initialize Registration Flow for APIs, Services, Apps, ...
|
1327
1483
|
|
1328
|
-
This endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing registration flow call `/self-service/registration/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
1484
|
+
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 and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
1329
1485
|
|
1330
1486
|
### Examples
|
1331
1487
|
|
@@ -1333,14 +1489,14 @@ This endpoint initiates a registration flow for API clients such as mobile devic
|
|
1333
1489
|
require 'time'
|
1334
1490
|
require 'ory-kratos-client'
|
1335
1491
|
|
1336
|
-
api_instance = OryKratosClient::
|
1492
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
1337
1493
|
|
1338
1494
|
begin
|
1339
1495
|
# Initialize Registration Flow for APIs, Services, Apps, ...
|
1340
1496
|
result = api_instance.initialize_self_service_registration_flow_without_browser
|
1341
1497
|
p result
|
1342
1498
|
rescue OryKratosClient::ApiError => e
|
1343
|
-
puts "Error when calling
|
1499
|
+
puts "Error when calling V0alpha2Api->initialize_self_service_registration_flow_without_browser: #{e}"
|
1344
1500
|
end
|
1345
1501
|
```
|
1346
1502
|
|
@@ -1358,7 +1514,7 @@ begin
|
|
1358
1514
|
p headers # => { ... }
|
1359
1515
|
p data # => <SelfServiceRegistrationFlow>
|
1360
1516
|
rescue OryKratosClient::ApiError => e
|
1361
|
-
puts "Error when calling
|
1517
|
+
puts "Error when calling V0alpha2Api->initialize_self_service_registration_flow_without_browser_with_http_info: #{e}"
|
1362
1518
|
end
|
1363
1519
|
```
|
1364
1520
|
|
@@ -1386,7 +1542,7 @@ No authorization required
|
|
1386
1542
|
|
1387
1543
|
Initialize Settings Flow for Browsers
|
1388
1544
|
|
1389
|
-
This endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid Ory Kratos Session Cookie is included in the request, a login flow will be initialized. If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid user session was set, the browser will be redirected to the login endpoint. If this endpoint is called via an AJAX request, the response contains the settings flow without any redirects or a
|
1545
|
+
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).
|
1390
1546
|
|
1391
1547
|
### Examples
|
1392
1548
|
|
@@ -1394,9 +1550,9 @@ This endpoint initializes a browser-based user settings flow. Once initialized,
|
|
1394
1550
|
require 'time'
|
1395
1551
|
require 'ory-kratos-client'
|
1396
1552
|
|
1397
|
-
api_instance = OryKratosClient::
|
1553
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
1398
1554
|
opts = {
|
1399
|
-
|
1555
|
+
return_to: 'return_to_example' # String | The URL to return the browser to after the flow was completed.
|
1400
1556
|
}
|
1401
1557
|
|
1402
1558
|
begin
|
@@ -1404,7 +1560,7 @@ begin
|
|
1404
1560
|
result = api_instance.initialize_self_service_settings_flow_for_browsers(opts)
|
1405
1561
|
p result
|
1406
1562
|
rescue OryKratosClient::ApiError => e
|
1407
|
-
puts "Error when calling
|
1563
|
+
puts "Error when calling V0alpha2Api->initialize_self_service_settings_flow_for_browsers: #{e}"
|
1408
1564
|
end
|
1409
1565
|
```
|
1410
1566
|
|
@@ -1422,7 +1578,7 @@ begin
|
|
1422
1578
|
p headers # => { ... }
|
1423
1579
|
p data # => <SelfServiceSettingsFlow>
|
1424
1580
|
rescue OryKratosClient::ApiError => e
|
1425
|
-
puts "Error when calling
|
1581
|
+
puts "Error when calling V0alpha2Api->initialize_self_service_settings_flow_for_browsers_with_http_info: #{e}"
|
1426
1582
|
end
|
1427
1583
|
```
|
1428
1584
|
|
@@ -1430,7 +1586,7 @@ end
|
|
1430
1586
|
|
1431
1587
|
| Name | Type | Description | Notes |
|
1432
1588
|
| ---- | ---- | ----------- | ----- |
|
1433
|
-
| **
|
1589
|
+
| **return_to** | **String** | The URL to return the browser to after the flow was completed. | [optional] |
|
1434
1590
|
|
1435
1591
|
### Return type
|
1436
1592
|
|
@@ -1452,7 +1608,7 @@ No authorization required
|
|
1452
1608
|
|
1453
1609
|
Initialize Settings Flow for APIs, Services, Apps, ...
|
1454
1610
|
|
1455
|
-
This endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on. You must provide a valid Ory Kratos Session Token for this endpoint to respond with HTTP 200 OK. To fetch an existing settings flow call `/self-service/settings/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
1611
|
+
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).
|
1456
1612
|
|
1457
1613
|
### Examples
|
1458
1614
|
|
@@ -1460,7 +1616,7 @@ This endpoint initiates a settings flow for API clients such as mobile devices,
|
|
1460
1616
|
require 'time'
|
1461
1617
|
require 'ory-kratos-client'
|
1462
1618
|
|
1463
|
-
api_instance = OryKratosClient::
|
1619
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
1464
1620
|
opts = {
|
1465
1621
|
x_session_token: 'x_session_token_example' # String | The Session Token of the Identity performing the settings flow.
|
1466
1622
|
}
|
@@ -1470,7 +1626,7 @@ begin
|
|
1470
1626
|
result = api_instance.initialize_self_service_settings_flow_without_browser(opts)
|
1471
1627
|
p result
|
1472
1628
|
rescue OryKratosClient::ApiError => e
|
1473
|
-
puts "Error when calling
|
1629
|
+
puts "Error when calling V0alpha2Api->initialize_self_service_settings_flow_without_browser: #{e}"
|
1474
1630
|
end
|
1475
1631
|
```
|
1476
1632
|
|
@@ -1488,7 +1644,7 @@ begin
|
|
1488
1644
|
p headers # => { ... }
|
1489
1645
|
p data # => <SelfServiceSettingsFlow>
|
1490
1646
|
rescue OryKratosClient::ApiError => e
|
1491
|
-
puts "Error when calling
|
1647
|
+
puts "Error when calling V0alpha2Api->initialize_self_service_settings_flow_without_browser_with_http_info: #{e}"
|
1492
1648
|
end
|
1493
1649
|
```
|
1494
1650
|
|
@@ -1514,7 +1670,7 @@ No authorization required
|
|
1514
1670
|
|
1515
1671
|
## initialize_self_service_verification_flow_for_browsers
|
1516
1672
|
|
1517
|
-
> <SelfServiceVerificationFlow> initialize_self_service_verification_flow_for_browsers
|
1673
|
+
> <SelfServiceVerificationFlow> initialize_self_service_verification_flow_for_browsers(opts)
|
1518
1674
|
|
1519
1675
|
Initialize Verification Flow for Browser Clients
|
1520
1676
|
|
@@ -1526,14 +1682,17 @@ This endpoint initializes a browser-based account verification flow. Once initia
|
|
1526
1682
|
require 'time'
|
1527
1683
|
require 'ory-kratos-client'
|
1528
1684
|
|
1529
|
-
api_instance = OryKratosClient::
|
1685
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
1686
|
+
opts = {
|
1687
|
+
return_to: 'return_to_example' # String | The URL to return the browser to after the flow was completed.
|
1688
|
+
}
|
1530
1689
|
|
1531
1690
|
begin
|
1532
1691
|
# Initialize Verification Flow for Browser Clients
|
1533
|
-
result = api_instance.initialize_self_service_verification_flow_for_browsers
|
1692
|
+
result = api_instance.initialize_self_service_verification_flow_for_browsers(opts)
|
1534
1693
|
p result
|
1535
1694
|
rescue OryKratosClient::ApiError => e
|
1536
|
-
puts "Error when calling
|
1695
|
+
puts "Error when calling V0alpha2Api->initialize_self_service_verification_flow_for_browsers: #{e}"
|
1537
1696
|
end
|
1538
1697
|
```
|
1539
1698
|
|
@@ -1541,23 +1700,25 @@ end
|
|
1541
1700
|
|
1542
1701
|
This returns an Array which contains the response data, status code and headers.
|
1543
1702
|
|
1544
|
-
> <Array(<SelfServiceVerificationFlow>, Integer, Hash)> initialize_self_service_verification_flow_for_browsers_with_http_info
|
1703
|
+
> <Array(<SelfServiceVerificationFlow>, Integer, Hash)> initialize_self_service_verification_flow_for_browsers_with_http_info(opts)
|
1545
1704
|
|
1546
1705
|
```ruby
|
1547
1706
|
begin
|
1548
1707
|
# Initialize Verification Flow for Browser Clients
|
1549
|
-
data, status_code, headers = api_instance.initialize_self_service_verification_flow_for_browsers_with_http_info
|
1708
|
+
data, status_code, headers = api_instance.initialize_self_service_verification_flow_for_browsers_with_http_info(opts)
|
1550
1709
|
p status_code # => 2xx
|
1551
1710
|
p headers # => { ... }
|
1552
1711
|
p data # => <SelfServiceVerificationFlow>
|
1553
1712
|
rescue OryKratosClient::ApiError => e
|
1554
|
-
puts "Error when calling
|
1713
|
+
puts "Error when calling V0alpha2Api->initialize_self_service_verification_flow_for_browsers_with_http_info: #{e}"
|
1555
1714
|
end
|
1556
1715
|
```
|
1557
1716
|
|
1558
1717
|
### Parameters
|
1559
1718
|
|
1560
|
-
|
1719
|
+
| Name | Type | Description | Notes |
|
1720
|
+
| ---- | ---- | ----------- | ----- |
|
1721
|
+
| **return_to** | **String** | The URL to return the browser to after the flow was completed. | [optional] |
|
1561
1722
|
|
1562
1723
|
### Return type
|
1563
1724
|
|
@@ -1587,14 +1748,14 @@ This endpoint initiates a verification flow for API clients such as mobile devic
|
|
1587
1748
|
require 'time'
|
1588
1749
|
require 'ory-kratos-client'
|
1589
1750
|
|
1590
|
-
api_instance = OryKratosClient::
|
1751
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
1591
1752
|
|
1592
1753
|
begin
|
1593
1754
|
# Initialize Verification Flow for APIs, Services, Apps, ...
|
1594
1755
|
result = api_instance.initialize_self_service_verification_flow_without_browser
|
1595
1756
|
p result
|
1596
1757
|
rescue OryKratosClient::ApiError => e
|
1597
|
-
puts "Error when calling
|
1758
|
+
puts "Error when calling V0alpha2Api->initialize_self_service_verification_flow_without_browser: #{e}"
|
1598
1759
|
end
|
1599
1760
|
```
|
1600
1761
|
|
@@ -1612,7 +1773,7 @@ begin
|
|
1612
1773
|
p headers # => { ... }
|
1613
1774
|
p data # => <SelfServiceVerificationFlow>
|
1614
1775
|
rescue OryKratosClient::ApiError => e
|
1615
|
-
puts "Error when calling
|
1776
|
+
puts "Error when calling V0alpha2Api->initialize_self_service_verification_flow_without_browser_with_http_info: #{e}"
|
1616
1777
|
end
|
1617
1778
|
```
|
1618
1779
|
|
@@ -1634,13 +1795,81 @@ No authorization required
|
|
1634
1795
|
- **Accept**: application/json
|
1635
1796
|
|
1636
1797
|
|
1798
|
+
## list_identity_schemas
|
1799
|
+
|
1800
|
+
> <Array<IdentitySchema>> list_identity_schemas(opts)
|
1801
|
+
|
1802
|
+
|
1803
|
+
|
1804
|
+
Get all Identity Schemas
|
1805
|
+
|
1806
|
+
### Examples
|
1807
|
+
|
1808
|
+
```ruby
|
1809
|
+
require 'time'
|
1810
|
+
require 'ory-kratos-client'
|
1811
|
+
|
1812
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
1813
|
+
opts = {
|
1814
|
+
per_page: 789, # Integer | Items per Page This is the number of items per page.
|
1815
|
+
page: 789 # Integer | Pagination Page
|
1816
|
+
}
|
1817
|
+
|
1818
|
+
begin
|
1819
|
+
|
1820
|
+
result = api_instance.list_identity_schemas(opts)
|
1821
|
+
p result
|
1822
|
+
rescue OryKratosClient::ApiError => e
|
1823
|
+
puts "Error when calling V0alpha2Api->list_identity_schemas: #{e}"
|
1824
|
+
end
|
1825
|
+
```
|
1826
|
+
|
1827
|
+
#### Using the list_identity_schemas_with_http_info variant
|
1828
|
+
|
1829
|
+
This returns an Array which contains the response data, status code and headers.
|
1830
|
+
|
1831
|
+
> <Array(<Array<IdentitySchema>>, Integer, Hash)> list_identity_schemas_with_http_info(opts)
|
1832
|
+
|
1833
|
+
```ruby
|
1834
|
+
begin
|
1835
|
+
|
1836
|
+
data, status_code, headers = api_instance.list_identity_schemas_with_http_info(opts)
|
1837
|
+
p status_code # => 2xx
|
1838
|
+
p headers # => { ... }
|
1839
|
+
p data # => <Array<IdentitySchema>>
|
1840
|
+
rescue OryKratosClient::ApiError => e
|
1841
|
+
puts "Error when calling V0alpha2Api->list_identity_schemas_with_http_info: #{e}"
|
1842
|
+
end
|
1843
|
+
```
|
1844
|
+
|
1845
|
+
### Parameters
|
1846
|
+
|
1847
|
+
| Name | Type | Description | Notes |
|
1848
|
+
| ---- | ---- | ----------- | ----- |
|
1849
|
+
| **per_page** | **Integer** | Items per Page This is the number of items per page. | [optional][default to 100] |
|
1850
|
+
| **page** | **Integer** | Pagination Page | [optional][default to 0] |
|
1851
|
+
|
1852
|
+
### Return type
|
1853
|
+
|
1854
|
+
[**Array<IdentitySchema>**](IdentitySchema.md)
|
1855
|
+
|
1856
|
+
### Authorization
|
1857
|
+
|
1858
|
+
No authorization required
|
1859
|
+
|
1860
|
+
### HTTP request headers
|
1861
|
+
|
1862
|
+
- **Content-Type**: Not defined
|
1863
|
+
- **Accept**: application/json
|
1864
|
+
|
1865
|
+
|
1637
1866
|
## submit_self_service_login_flow
|
1638
1867
|
|
1639
1868
|
> <SuccessfulSelfServiceLoginWithoutBrowser> submit_self_service_login_flow(flow, opts)
|
1640
1869
|
|
1641
1870
|
Submit a Login Flow
|
1642
1871
|
|
1643
|
-
:::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: Use this endpoint to complete a login flow. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and responds with HTTP 200 and a application/json body with the session token on success; HTTP 302 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. Browser flows expect a Content-Type of `application/x-www-form-urlencoded` or `application/json` to be sent in the body and respond with a HTTP 302 redirect to the post/after login URL or the `return_to` value if it was set and if the login succeeded; a HTTP 302 redirect to the login UI URL with the flow ID containing the validation errors otherwise. Browser flows with an accept header of `application/json` will not redirect but instead respond with HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success; HTTP 302 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
1872
|
+
:::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: Use this endpoint to complete a login flow. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and responds with HTTP 200 and a application/json body with the session token on success; HTTP 302 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. Browser flows expect a Content-Type of `application/x-www-form-urlencoded` or `application/json` to be sent in the body and respond with a HTTP 302 redirect to the post/after login URL or the `return_to` value if it was set and if the login succeeded; a HTTP 302 redirect to the login UI URL with the flow ID containing the validation errors otherwise. Browser flows with an accept header of `application/json` will not redirect but instead respond with HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success; HTTP 302 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. 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 and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
1644
1873
|
|
1645
1874
|
### Examples
|
1646
1875
|
|
@@ -1648,10 +1877,11 @@ Submit a Login Flow
|
|
1648
1877
|
require 'time'
|
1649
1878
|
require 'ory-kratos-client'
|
1650
1879
|
|
1651
|
-
api_instance = OryKratosClient::
|
1880
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
1652
1881
|
flow = 'flow_example' # String | The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`).
|
1653
1882
|
opts = {
|
1654
|
-
|
1883
|
+
x_session_token: 'x_session_token_example', # String | The Session Token of the Identity performing the settings flow.
|
1884
|
+
submit_self_service_login_flow_body: OryKratosClient::SubmitSelfServiceLoginFlowWithOidcMethodBody.new({method: 'method_example', provider: 'provider_example'}) # SubmitSelfServiceLoginFlowBody |
|
1655
1885
|
}
|
1656
1886
|
|
1657
1887
|
begin
|
@@ -1659,7 +1889,7 @@ begin
|
|
1659
1889
|
result = api_instance.submit_self_service_login_flow(flow, opts)
|
1660
1890
|
p result
|
1661
1891
|
rescue OryKratosClient::ApiError => e
|
1662
|
-
puts "Error when calling
|
1892
|
+
puts "Error when calling V0alpha2Api->submit_self_service_login_flow: #{e}"
|
1663
1893
|
end
|
1664
1894
|
```
|
1665
1895
|
|
@@ -1677,7 +1907,7 @@ begin
|
|
1677
1907
|
p headers # => { ... }
|
1678
1908
|
p data # => <SuccessfulSelfServiceLoginWithoutBrowser>
|
1679
1909
|
rescue OryKratosClient::ApiError => e
|
1680
|
-
puts "Error when calling
|
1910
|
+
puts "Error when calling V0alpha2Api->submit_self_service_login_flow_with_http_info: #{e}"
|
1681
1911
|
end
|
1682
1912
|
```
|
1683
1913
|
|
@@ -1686,6 +1916,7 @@ end
|
|
1686
1916
|
| Name | Type | Description | Notes |
|
1687
1917
|
| ---- | ---- | ----------- | ----- |
|
1688
1918
|
| **flow** | **String** | The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`). | |
|
1919
|
+
| **x_session_token** | **String** | The Session Token of the Identity performing the settings flow. | [optional] |
|
1689
1920
|
| **submit_self_service_login_flow_body** | [**SubmitSelfServiceLoginFlowBody**](SubmitSelfServiceLoginFlowBody.md) | | [optional] |
|
1690
1921
|
|
1691
1922
|
### Return type
|
@@ -1716,16 +1947,17 @@ This endpoint logs out an identity in a self-service manner. If the `Accept` HT
|
|
1716
1947
|
require 'time'
|
1717
1948
|
require 'ory-kratos-client'
|
1718
1949
|
|
1719
|
-
api_instance = OryKratosClient::
|
1950
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
1720
1951
|
opts = {
|
1721
|
-
token: 'token_example' # String | A Valid Logout Token If you do not have a logout token because you only have a session cookie, call `/self-service/logout/urls` to generate a URL for this endpoint.
|
1952
|
+
token: 'token_example', # String | A Valid Logout Token If you do not have a logout token because you only have a session cookie, call `/self-service/logout/urls` to generate a URL for this endpoint.
|
1953
|
+
return_to: 'return_to_example' # String | The URL to return to after the logout was completed.
|
1722
1954
|
}
|
1723
1955
|
|
1724
1956
|
begin
|
1725
1957
|
# Complete Self-Service Logout
|
1726
1958
|
api_instance.submit_self_service_logout_flow(opts)
|
1727
1959
|
rescue OryKratosClient::ApiError => e
|
1728
|
-
puts "Error when calling
|
1960
|
+
puts "Error when calling V0alpha2Api->submit_self_service_logout_flow: #{e}"
|
1729
1961
|
end
|
1730
1962
|
```
|
1731
1963
|
|
@@ -1743,7 +1975,7 @@ begin
|
|
1743
1975
|
p headers # => { ... }
|
1744
1976
|
p data # => nil
|
1745
1977
|
rescue OryKratosClient::ApiError => e
|
1746
|
-
puts "Error when calling
|
1978
|
+
puts "Error when calling V0alpha2Api->submit_self_service_logout_flow_with_http_info: #{e}"
|
1747
1979
|
end
|
1748
1980
|
```
|
1749
1981
|
|
@@ -1752,6 +1984,7 @@ end
|
|
1752
1984
|
| Name | Type | Description | Notes |
|
1753
1985
|
| ---- | ---- | ----------- | ----- |
|
1754
1986
|
| **token** | **String** | A Valid Logout Token If you do not have a logout token because you only have a session cookie, call `/self-service/logout/urls` to generate a URL for this endpoint. | [optional] |
|
1987
|
+
| **return_to** | **String** | The URL to return to after the logout was completed. | [optional] |
|
1755
1988
|
|
1756
1989
|
### Return type
|
1757
1990
|
|
@@ -1781,14 +2014,14 @@ Use this endpoint to log out an identity using an Ory Session Token. If the Ory
|
|
1781
2014
|
require 'time'
|
1782
2015
|
require 'ory-kratos-client'
|
1783
2016
|
|
1784
|
-
api_instance = OryKratosClient::
|
2017
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
1785
2018
|
submit_self_service_logout_flow_without_browser_body = OryKratosClient::SubmitSelfServiceLogoutFlowWithoutBrowserBody.new({session_token: 'session_token_example'}) # SubmitSelfServiceLogoutFlowWithoutBrowserBody |
|
1786
2019
|
|
1787
2020
|
begin
|
1788
2021
|
# Perform Logout for APIs, Services, Apps, ...
|
1789
2022
|
api_instance.submit_self_service_logout_flow_without_browser(submit_self_service_logout_flow_without_browser_body)
|
1790
2023
|
rescue OryKratosClient::ApiError => e
|
1791
|
-
puts "Error when calling
|
2024
|
+
puts "Error when calling V0alpha2Api->submit_self_service_logout_flow_without_browser: #{e}"
|
1792
2025
|
end
|
1793
2026
|
```
|
1794
2027
|
|
@@ -1806,7 +2039,7 @@ begin
|
|
1806
2039
|
p headers # => { ... }
|
1807
2040
|
p data # => nil
|
1808
2041
|
rescue OryKratosClient::ApiError => e
|
1809
|
-
puts "Error when calling
|
2042
|
+
puts "Error when calling V0alpha2Api->submit_self_service_logout_flow_without_browser_with_http_info: #{e}"
|
1810
2043
|
end
|
1811
2044
|
```
|
1812
2045
|
|
@@ -1844,7 +2077,7 @@ Use this endpoint to complete a recovery flow. This endpoint behaves differently
|
|
1844
2077
|
require 'time'
|
1845
2078
|
require 'ory-kratos-client'
|
1846
2079
|
|
1847
|
-
api_instance = OryKratosClient::
|
2080
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
1848
2081
|
flow = 'flow_example' # String | The Recovery Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`).
|
1849
2082
|
opts = {
|
1850
2083
|
token: 'token_example', # String | Recovery Token The recovery token which completes the recovery request. If the token is invalid (e.g. expired) an error will be shown to the end-user. This parameter is usually set in a link and not used by any direct API call.
|
@@ -1856,7 +2089,7 @@ begin
|
|
1856
2089
|
result = api_instance.submit_self_service_recovery_flow(flow, opts)
|
1857
2090
|
p result
|
1858
2091
|
rescue OryKratosClient::ApiError => e
|
1859
|
-
puts "Error when calling
|
2092
|
+
puts "Error when calling V0alpha2Api->submit_self_service_recovery_flow: #{e}"
|
1860
2093
|
end
|
1861
2094
|
```
|
1862
2095
|
|
@@ -1874,7 +2107,7 @@ begin
|
|
1874
2107
|
p headers # => { ... }
|
1875
2108
|
p data # => <SelfServiceRecoveryFlow>
|
1876
2109
|
rescue OryKratosClient::ApiError => e
|
1877
|
-
puts "Error when calling
|
2110
|
+
puts "Error when calling V0alpha2Api->submit_self_service_recovery_flow_with_http_info: #{e}"
|
1878
2111
|
end
|
1879
2112
|
```
|
1880
2113
|
|
@@ -1906,7 +2139,7 @@ No authorization required
|
|
1906
2139
|
|
1907
2140
|
Submit a Registration Flow
|
1908
2141
|
|
1909
|
-
Use this endpoint to complete a registration flow by sending an identity's traits and password. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and respond with HTTP 200 and a application/json body with the created identity success - if the session hook is configured the `session` and `session_token` will also be included; HTTP 302 redirect to a fresh registration flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. Browser flows expect a Content-Type of `application/x-www-form-urlencoded` or `application/json` to be sent in the body and respond with a HTTP 302 redirect to the post/after registration URL or the `return_to` value if it was set and if the registration succeeded; a HTTP 302 redirect to the registration UI URL with the flow ID containing the validation errors otherwise. Browser flows with an accept header of `application/json` will not redirect but instead respond with HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success; HTTP 302 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. More information can be found at [Ory Kratos User Login and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
2142
|
+
Use this endpoint to complete a registration flow by sending an identity's traits and password. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and respond with HTTP 200 and a application/json body with the created identity success - if the session hook is configured the `session` and `session_token` will also be included; HTTP 302 redirect to a fresh registration flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. Browser flows expect a Content-Type of `application/x-www-form-urlencoded` or `application/json` to be sent in the body and respond with a HTTP 302 redirect to the post/after registration URL or the `return_to` value if it was set and if the registration succeeded; a HTTP 302 redirect to the registration UI URL with the flow ID containing the validation errors otherwise. Browser flows with an accept header of `application/json` will not redirect but instead respond with HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success; HTTP 302 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. 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 and User Registration Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-login-user-registration).
|
1910
2143
|
|
1911
2144
|
### Examples
|
1912
2145
|
|
@@ -1914,10 +2147,10 @@ Use this endpoint to complete a registration flow by sending an identity's trait
|
|
1914
2147
|
require 'time'
|
1915
2148
|
require 'ory-kratos-client'
|
1916
2149
|
|
1917
|
-
api_instance = OryKratosClient::
|
2150
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
1918
2151
|
flow = 'flow_example' # String | The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
|
1919
2152
|
opts = {
|
1920
|
-
submit_self_service_registration_flow_body: OryKratosClient::SubmitSelfServiceRegistrationFlowWithOidcMethodBody.new({method: 'method_example',
|
2153
|
+
submit_self_service_registration_flow_body: OryKratosClient::SubmitSelfServiceRegistrationFlowWithOidcMethodBody.new({method: 'method_example', provider: 'provider_example'}) # SubmitSelfServiceRegistrationFlowBody |
|
1921
2154
|
}
|
1922
2155
|
|
1923
2156
|
begin
|
@@ -1925,7 +2158,7 @@ begin
|
|
1925
2158
|
result = api_instance.submit_self_service_registration_flow(flow, opts)
|
1926
2159
|
p result
|
1927
2160
|
rescue OryKratosClient::ApiError => e
|
1928
|
-
puts "Error when calling
|
2161
|
+
puts "Error when calling V0alpha2Api->submit_self_service_registration_flow: #{e}"
|
1929
2162
|
end
|
1930
2163
|
```
|
1931
2164
|
|
@@ -1943,7 +2176,7 @@ begin
|
|
1943
2176
|
p headers # => { ... }
|
1944
2177
|
p data # => <SuccessfulSelfServiceRegistrationWithoutBrowser>
|
1945
2178
|
rescue OryKratosClient::ApiError => e
|
1946
|
-
puts "Error when calling
|
2179
|
+
puts "Error when calling V0alpha2Api->submit_self_service_registration_flow_with_http_info: #{e}"
|
1947
2180
|
end
|
1948
2181
|
```
|
1949
2182
|
|
@@ -1970,11 +2203,11 @@ No authorization required
|
|
1970
2203
|
|
1971
2204
|
## submit_self_service_settings_flow
|
1972
2205
|
|
1973
|
-
> <
|
2206
|
+
> <SelfServiceSettingsFlow> submit_self_service_settings_flow(flow, opts)
|
1974
2207
|
|
1975
2208
|
Complete Settings Flow
|
1976
2209
|
|
1977
|
-
Use this endpoint to complete a settings flow by sending an identity's updated password. This endpoint behaves differently for API and browser flows. API-initiated flows expect `application/json` to be sent in the body and respond with HTTP 200 and an application/json body with the session token on success; HTTP 302 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. HTTP 401 when the endpoint is called without a valid session token. HTTP 403 when `selfservice.flows.settings.privileged_session_max_age` was reached. Implies that the user needs to re-authenticate. Browser flows without HTTP Header `Accept` or with `Accept: text/*` respond with a HTTP 302 redirect to the post/after settings URL or the `return_to` value if it was set and if the flow succeeded; a HTTP 302 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise. a HTTP 302 redirect to the login endpoint when `selfservice.flows.settings.privileged_session_max_age` was reached. Browser flows with HTTP Header `Accept: application/json` respond with HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success; HTTP 302 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 403 when the page is accessed without a session cookie. HTTP 400 on form validation errors. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
2210
|
+
Use this endpoint to complete a settings flow by sending an identity's updated password. This endpoint behaves differently for API and browser flows. API-initiated flows expect `application/json` to be sent in the body and respond with HTTP 200 and an application/json body with the session token on success; HTTP 302 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. HTTP 401 when the endpoint is called without a valid session token. HTTP 403 when `selfservice.flows.settings.privileged_session_max_age` was reached 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 302 redirect to the post/after settings URL or the `return_to` value if it was set and if the flow succeeded; a HTTP 302 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise. a HTTP 302 redirect to the login endpoint when `selfservice.flows.settings.privileged_session_max_age` was reached 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 302 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).
|
1978
2211
|
|
1979
2212
|
### Examples
|
1980
2213
|
|
@@ -1982,7 +2215,7 @@ Use this endpoint to complete a settings flow by sending an identity's updated p
|
|
1982
2215
|
require 'time'
|
1983
2216
|
require 'ory-kratos-client'
|
1984
2217
|
|
1985
|
-
api_instance = OryKratosClient::
|
2218
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
1986
2219
|
flow = 'flow_example' # String | The Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`).
|
1987
2220
|
opts = {
|
1988
2221
|
x_session_token: 'x_session_token_example', # String | The Session Token of the Identity performing the settings flow.
|
@@ -1994,7 +2227,7 @@ begin
|
|
1994
2227
|
result = api_instance.submit_self_service_settings_flow(flow, opts)
|
1995
2228
|
p result
|
1996
2229
|
rescue OryKratosClient::ApiError => e
|
1997
|
-
puts "Error when calling
|
2230
|
+
puts "Error when calling V0alpha2Api->submit_self_service_settings_flow: #{e}"
|
1998
2231
|
end
|
1999
2232
|
```
|
2000
2233
|
|
@@ -2002,7 +2235,7 @@ end
|
|
2002
2235
|
|
2003
2236
|
This returns an Array which contains the response data, status code and headers.
|
2004
2237
|
|
2005
|
-
> <Array(<
|
2238
|
+
> <Array(<SelfServiceSettingsFlow>, Integer, Hash)> submit_self_service_settings_flow_with_http_info(flow, opts)
|
2006
2239
|
|
2007
2240
|
```ruby
|
2008
2241
|
begin
|
@@ -2010,9 +2243,9 @@ begin
|
|
2010
2243
|
data, status_code, headers = api_instance.submit_self_service_settings_flow_with_http_info(flow, opts)
|
2011
2244
|
p status_code # => 2xx
|
2012
2245
|
p headers # => { ... }
|
2013
|
-
p data # => <
|
2246
|
+
p data # => <SelfServiceSettingsFlow>
|
2014
2247
|
rescue OryKratosClient::ApiError => e
|
2015
|
-
puts "Error when calling
|
2248
|
+
puts "Error when calling V0alpha2Api->submit_self_service_settings_flow_with_http_info: #{e}"
|
2016
2249
|
end
|
2017
2250
|
```
|
2018
2251
|
|
@@ -2026,7 +2259,7 @@ end
|
|
2026
2259
|
|
2027
2260
|
### Return type
|
2028
2261
|
|
2029
|
-
[**
|
2262
|
+
[**SelfServiceSettingsFlow**](SelfServiceSettingsFlow.md)
|
2030
2263
|
|
2031
2264
|
### Authorization
|
2032
2265
|
|
@@ -2052,7 +2285,7 @@ Use this endpoint to complete a verification flow. This endpoint behaves differe
|
|
2052
2285
|
require 'time'
|
2053
2286
|
require 'ory-kratos-client'
|
2054
2287
|
|
2055
|
-
api_instance = OryKratosClient::
|
2288
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
2056
2289
|
flow = 'flow_example' # String | The Verification Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`).
|
2057
2290
|
opts = {
|
2058
2291
|
token: 'token_example', # String | Verification Token The verification token which completes the verification request. If the token is invalid (e.g. expired) an error will be shown to the end-user. This parameter is usually set in a link and not used by any direct API call.
|
@@ -2064,7 +2297,7 @@ begin
|
|
2064
2297
|
result = api_instance.submit_self_service_verification_flow(flow, opts)
|
2065
2298
|
p result
|
2066
2299
|
rescue OryKratosClient::ApiError => e
|
2067
|
-
puts "Error when calling
|
2300
|
+
puts "Error when calling V0alpha2Api->submit_self_service_verification_flow: #{e}"
|
2068
2301
|
end
|
2069
2302
|
```
|
2070
2303
|
|
@@ -2082,7 +2315,7 @@ begin
|
|
2082
2315
|
p headers # => { ... }
|
2083
2316
|
p data # => <SelfServiceVerificationFlow>
|
2084
2317
|
rescue OryKratosClient::ApiError => e
|
2085
|
-
puts "Error when calling
|
2318
|
+
puts "Error when calling V0alpha2Api->submit_self_service_verification_flow_with_http_info: #{e}"
|
2086
2319
|
end
|
2087
2320
|
```
|
2088
2321
|
|
@@ -2114,7 +2347,7 @@ No authorization required
|
|
2114
2347
|
|
2115
2348
|
Check Who the Current HTTP Session Belongs To
|
2116
2349
|
|
2117
|
-
Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object in the body or 401 if the credentials are invalid or no credentials were sent. Additionally when the request it successful it adds the user ID to the 'X-Kratos-Authenticated-Identity-Id' header in the response. If you call this endpoint from a server-side application, you must forward the HTTP Cookie Header to this endpoint: ```js pseudo-code example router.get('/protected-endpoint', async function (req, res) { const session = await client.toSession(undefined, req.header('cookie')) console.log(session) }) ``` When calling this endpoint from a non-browser application (e.g. mobile app) you must include the session token: ```js pseudo-code example ... const session = await client.toSession(\"the-session-token\") console.log(session) ``` This endpoint is useful for: AJAX calls. Remember to send credentials and set up CORS correctly! Reverse proxies and API Gateways Server-side calls - use the `X-Session-Token` header! This endpoint authenticates users by checking if the `Cookie` HTTP header was set containing an Ory Kratos Session Cookie; if the `Authorization: bearer <ory-session-token>` HTTP header was set with a valid Ory Kratos Session Token; if the `X-Session-Token` HTTP header was set with a valid Ory Kratos Session Token. If none of these headers are set or the cooke or token are invalid, the endpoint returns a HTTP 401 status code.
|
2350
|
+
Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object in the body or 401 if the credentials are invalid or no credentials were sent. Additionally when the request it successful it adds the user ID to the 'X-Kratos-Authenticated-Identity-Id' header in the response. If you call this endpoint from a server-side application, you must forward the HTTP Cookie Header to this endpoint: ```js pseudo-code example router.get('/protected-endpoint', async function (req, res) { const session = await client.toSession(undefined, req.header('cookie')) console.log(session) }) ``` When calling this endpoint from a non-browser application (e.g. mobile app) you must include the session token: ```js pseudo-code example ... const session = await client.toSession(\"the-session-token\") console.log(session) ``` 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 cooke 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.
|
2118
2351
|
|
2119
2352
|
### Examples
|
2120
2353
|
|
@@ -2122,7 +2355,7 @@ Uses the HTTP Headers in the GET request to determine (e.g. by using checking th
|
|
2122
2355
|
require 'time'
|
2123
2356
|
require 'ory-kratos-client'
|
2124
2357
|
|
2125
|
-
api_instance = OryKratosClient::
|
2358
|
+
api_instance = OryKratosClient::V0alpha2Api.new
|
2126
2359
|
opts = {
|
2127
2360
|
x_session_token: 'MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj', # String | Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`.
|
2128
2361
|
cookie: 'ory_kratos_session=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f==' # String | Set the Cookie Header. This is especially useful when calling this endpoint from a server-side application. In that scenario you must include the HTTP Cookie Header which originally was included in the request to your server. An example of a session in the HTTP Cookie Header is: `ory_kratos_session=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f==`. It is ok if more than one cookie are included here as all other cookies will be ignored.
|
@@ -2133,7 +2366,7 @@ begin
|
|
2133
2366
|
result = api_instance.to_session(opts)
|
2134
2367
|
p result
|
2135
2368
|
rescue OryKratosClient::ApiError => e
|
2136
|
-
puts "Error when calling
|
2369
|
+
puts "Error when calling V0alpha2Api->to_session: #{e}"
|
2137
2370
|
end
|
2138
2371
|
```
|
2139
2372
|
|
@@ -2151,7 +2384,7 @@ begin
|
|
2151
2384
|
p headers # => { ... }
|
2152
2385
|
p data # => <Session>
|
2153
2386
|
rescue OryKratosClient::ApiError => e
|
2154
|
-
puts "Error when calling
|
2387
|
+
puts "Error when calling V0alpha2Api->to_session_with_http_info: #{e}"
|
2155
2388
|
end
|
2156
2389
|
```
|
2157
2390
|
|