ory-client 0.1.0.alpha12 → 0.2.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 +1 -1
- data/README.md +13 -9
- data/docs/AdminUpdateIdentityBody.md +2 -0
- data/docs/{InlineResponse2001.md → GetVersion200Response.md} +2 -2
- data/docs/IdentitySchema.md +0 -2
- data/docs/IdentitySchemaContainer.md +20 -0
- data/docs/{InlineResponse200.md → IsAlive200Response.md} +2 -2
- data/docs/{InlineResponse503.md → IsReady503Response.md} +2 -2
- data/docs/JsonPatch.md +4 -2
- data/docs/MetadataApi.md +12 -12
- data/docs/Pagination.md +1 -1
- data/docs/SubmitSelfServiceLoginFlowWithWebAuthnMethodBody.md +1 -1
- data/docs/TokenPagination.md +20 -0
- data/docs/TokenPaginationHeaders.md +20 -0
- data/docs/UiNodeInputAttributes.md +3 -1
- data/docs/V0alpha2Api.md +96 -22
- data/docs/VerifiableIdentityAddress.md +1 -1
- data/lib/ory-client/api/metadata_api.rb +11 -11
- data/lib/ory-client/api/read_api.rb +2 -2
- data/lib/ory-client/api/v0alpha2_api.rb +98 -28
- data/lib/ory-client/api/write_api.rb +2 -2
- data/lib/ory-client/api_client.rb +5 -3
- data/lib/ory-client/api_error.rb +2 -2
- data/lib/ory-client/configuration.rb +4 -3
- data/lib/ory-client/models/active_project.rb +3 -2
- data/lib/ory-client/models/admin_create_identity_body.rb +3 -2
- data/lib/ory-client/models/admin_create_identity_import_credentials_oidc.rb +3 -2
- data/lib/ory-client/models/admin_create_identity_import_credentials_oidc_config.rb +3 -2
- data/lib/ory-client/models/admin_create_identity_import_credentials_oidc_provider.rb +3 -2
- data/lib/ory-client/models/admin_create_identity_import_credentials_password.rb +3 -2
- data/lib/ory-client/models/admin_create_identity_import_credentials_password_config.rb +3 -2
- data/lib/ory-client/models/admin_create_self_service_recovery_link_body.rb +3 -2
- data/lib/ory-client/models/admin_identity_import_credentials.rb +3 -2
- data/lib/ory-client/models/admin_update_identity_body.rb +13 -3
- data/lib/ory-client/models/api_token.rb +3 -2
- data/lib/ory-client/models/authenticator_assurance_level.rb +2 -2
- data/lib/ory-client/models/cloud_account.rb +3 -2
- data/lib/ory-client/models/cname_settings.rb +3 -2
- data/lib/ory-client/models/create_custom_hostname_body.rb +3 -2
- data/lib/ory-client/models/create_project_body.rb +3 -2
- data/lib/ory-client/models/create_subscription_payload.rb +3 -2
- data/lib/ory-client/models/error_authenticator_assurance_level_not_satisfied.rb +3 -2
- data/lib/ory-client/models/expand_tree.rb +3 -2
- data/lib/ory-client/models/generic_error.rb +3 -2
- data/lib/ory-client/models/generic_error_content.rb +3 -2
- data/lib/ory-client/models/get_check_response.rb +3 -2
- data/lib/ory-client/models/get_relation_tuples_response.rb +3 -2
- data/lib/ory-client/models/{inline_response2001.rb → get_version200_response.rb} +6 -5
- data/lib/ory-client/models/health_not_ready_status.rb +3 -2
- data/lib/ory-client/models/health_status.rb +3 -2
- data/lib/ory-client/models/identity.rb +3 -2
- data/lib/ory-client/models/identity_credentials.rb +3 -2
- data/lib/ory-client/models/identity_credentials_oidc.rb +3 -2
- data/lib/ory-client/models/identity_credentials_oidc_provider.rb +3 -2
- data/lib/ory-client/models/identity_credentials_password.rb +3 -2
- data/lib/ory-client/models/identity_credentials_type.rb +2 -2
- data/lib/ory-client/models/identity_schema.rb +4 -13
- data/lib/ory-client/models/identity_schema_container.rb +229 -0
- data/lib/ory-client/models/identity_schema_location.rb +3 -2
- data/lib/ory-client/models/identity_schema_preset.rb +3 -2
- data/lib/ory-client/models/identity_schema_validation_result.rb +3 -2
- data/lib/ory-client/models/identity_state.rb +2 -2
- data/lib/ory-client/models/internal_relation_tuple.rb +3 -2
- data/lib/ory-client/models/invite_payload.rb +3 -2
- data/lib/ory-client/models/{inline_response200.rb → is_alive200_response.rb} +6 -5
- data/lib/ory-client/models/is_owner_for_project_by_slug.rb +3 -2
- data/lib/ory-client/models/is_owner_for_project_by_slug_payload.rb +3 -2
- data/lib/ory-client/models/{inline_response503.rb → is_ready503_response.rb} +6 -5
- data/lib/ory-client/models/json_error.rb +3 -2
- data/lib/ory-client/models/json_patch.rb +14 -3
- data/lib/ory-client/models/keto_namespace.rb +3 -2
- data/lib/ory-client/models/needs_privileged_session_error.rb +3 -2
- data/lib/ory-client/models/normalized_project.rb +3 -2
- data/lib/ory-client/models/normalized_project_revision.rb +3 -2
- data/lib/ory-client/models/normalized_project_revision_hook.rb +3 -2
- data/lib/ory-client/models/normalized_project_revision_identity_schema.rb +3 -2
- data/lib/ory-client/models/normalized_project_revision_third_party_provider.rb +3 -2
- data/lib/ory-client/models/null_plan.rb +2 -2
- data/lib/ory-client/models/pagination.rb +4 -3
- data/lib/ory-client/models/patch_delta.rb +3 -2
- data/lib/ory-client/models/project.rb +3 -2
- data/lib/ory-client/models/project_host.rb +3 -2
- data/lib/ory-client/models/project_invite.rb +3 -2
- data/lib/ory-client/models/project_metadata.rb +3 -2
- data/lib/ory-client/models/project_service_identity.rb +3 -2
- data/lib/ory-client/models/project_service_permission.rb +3 -2
- data/lib/ory-client/models/project_services.rb +3 -2
- data/lib/ory-client/models/provision_mock_subscription_payload.rb +3 -2
- data/lib/ory-client/models/quota_custom_domains.rb +3 -2
- data/lib/ory-client/models/quota_project_member_seats.rb +3 -2
- data/lib/ory-client/models/recovery_address.rb +3 -2
- data/lib/ory-client/models/relation_query.rb +3 -2
- data/lib/ory-client/models/revoked_sessions.rb +3 -2
- data/lib/ory-client/models/schema_patch.rb +3 -2
- data/lib/ory-client/models/self_service_browser_location_change_required_error.rb +3 -2
- data/lib/ory-client/models/self_service_error.rb +3 -2
- data/lib/ory-client/models/self_service_flow_expired_error.rb +3 -2
- data/lib/ory-client/models/self_service_login_flow.rb +3 -2
- data/lib/ory-client/models/self_service_logout_url.rb +3 -2
- data/lib/ory-client/models/self_service_recovery_flow.rb +3 -2
- data/lib/ory-client/models/self_service_recovery_flow_state.rb +2 -2
- data/lib/ory-client/models/self_service_recovery_link.rb +3 -2
- data/lib/ory-client/models/self_service_registration_flow.rb +3 -2
- data/lib/ory-client/models/self_service_settings_flow.rb +3 -2
- data/lib/ory-client/models/self_service_settings_flow_state.rb +2 -2
- data/lib/ory-client/models/self_service_verification_flow.rb +3 -2
- data/lib/ory-client/models/self_service_verification_flow_state.rb +2 -2
- data/lib/ory-client/models/session.rb +3 -2
- data/lib/ory-client/models/session_authentication_method.rb +3 -2
- data/lib/ory-client/models/session_device.rb +3 -2
- data/lib/ory-client/models/settings_profile_form_config.rb +3 -2
- data/lib/ory-client/models/stripe_customer_response.rb +3 -2
- data/lib/ory-client/models/subject_set.rb +3 -2
- data/lib/ory-client/models/submit_self_service_flow_with_web_authn_registration_method.rb +3 -2
- data/lib/ory-client/models/submit_self_service_login_flow_body.rb +4 -4
- data/lib/ory-client/models/submit_self_service_login_flow_with_lookup_secret_method_body.rb +3 -2
- data/lib/ory-client/models/submit_self_service_login_flow_with_oidc_method_body.rb +3 -2
- data/lib/ory-client/models/submit_self_service_login_flow_with_password_method_body.rb +3 -2
- data/lib/ory-client/models/submit_self_service_login_flow_with_totp_method_body.rb +3 -2
- data/lib/ory-client/models/submit_self_service_login_flow_with_web_authn_method_body.rb +9 -3
- data/lib/ory-client/models/submit_self_service_logout_flow_without_browser_body.rb +3 -2
- data/lib/ory-client/models/submit_self_service_recovery_flow_body.rb +4 -4
- data/lib/ory-client/models/submit_self_service_recovery_flow_with_link_method_body.rb +3 -2
- data/lib/ory-client/models/submit_self_service_registration_flow_body.rb +4 -4
- data/lib/ory-client/models/submit_self_service_registration_flow_with_oidc_method_body.rb +3 -2
- data/lib/ory-client/models/submit_self_service_registration_flow_with_password_method_body.rb +3 -2
- data/lib/ory-client/models/submit_self_service_registration_flow_with_web_authn_method_body.rb +3 -2
- data/lib/ory-client/models/submit_self_service_settings_flow_body.rb +4 -4
- data/lib/ory-client/models/submit_self_service_settings_flow_with_lookup_method_body.rb +3 -2
- data/lib/ory-client/models/submit_self_service_settings_flow_with_oidc_method_body.rb +3 -2
- data/lib/ory-client/models/submit_self_service_settings_flow_with_password_method_body.rb +3 -2
- data/lib/ory-client/models/submit_self_service_settings_flow_with_profile_method_body.rb +3 -2
- data/lib/ory-client/models/submit_self_service_settings_flow_with_totp_method_body.rb +3 -2
- data/lib/ory-client/models/submit_self_service_settings_flow_with_web_authn_method_body.rb +3 -2
- data/lib/ory-client/models/submit_self_service_verification_flow_body.rb +4 -4
- data/lib/ory-client/models/submit_self_service_verification_flow_with_link_method_body.rb +3 -2
- data/lib/ory-client/models/subscription.rb +3 -2
- data/lib/ory-client/models/successful_project_update.rb +3 -2
- data/lib/ory-client/models/successful_self_service_login_without_browser.rb +3 -2
- data/lib/ory-client/models/successful_self_service_registration_without_browser.rb +3 -2
- data/lib/ory-client/models/token_pagination.rb +264 -0
- data/lib/ory-client/models/token_pagination_headers.rb +230 -0
- data/lib/ory-client/models/ui_container.rb +3 -2
- data/lib/ory-client/models/ui_node.rb +3 -2
- data/lib/ory-client/models/ui_node_anchor_attributes.rb +3 -2
- data/lib/ory-client/models/ui_node_attributes.rb +4 -4
- data/lib/ory-client/models/ui_node_image_attributes.rb +3 -2
- data/lib/ory-client/models/ui_node_input_attributes.rb +49 -3
- data/lib/ory-client/models/ui_node_meta.rb +3 -2
- data/lib/ory-client/models/ui_node_script_attributes.rb +3 -2
- data/lib/ory-client/models/ui_node_text_attributes.rb +3 -2
- data/lib/ory-client/models/ui_text.rb +3 -2
- data/lib/ory-client/models/update_custom_hostname_body.rb +3 -2
- data/lib/ory-client/models/update_project.rb +3 -2
- data/lib/ory-client/models/update_subscription_payload.rb +3 -2
- data/lib/ory-client/models/verifiable_identity_address.rb +3 -7
- data/lib/ory-client/models/version.rb +3 -2
- data/lib/ory-client/models/warning.rb +3 -2
- data/lib/ory-client/version.rb +3 -3
- data/lib/ory-client.rb +8 -5
- data/ory-client.gemspec +2 -2
- data/spec/api/metadata_api_spec.rb +5 -5
- data/spec/api/read_api_spec.rb +2 -2
- data/spec/api/v0alpha2_api_spec.rb +24 -11
- data/spec/api/write_api_spec.rb +2 -2
- data/spec/api_client_spec.rb +2 -2
- data/spec/configuration_spec.rb +2 -2
- data/spec/models/active_project_spec.rb +2 -2
- data/spec/models/admin_create_identity_body_spec.rb +2 -2
- data/spec/models/admin_create_identity_import_credentials_oidc_config_spec.rb +2 -2
- data/spec/models/admin_create_identity_import_credentials_oidc_provider_spec.rb +2 -2
- data/spec/models/admin_create_identity_import_credentials_oidc_spec.rb +2 -2
- data/spec/models/admin_create_identity_import_credentials_password_config_spec.rb +2 -2
- data/spec/models/admin_create_identity_import_credentials_password_spec.rb +2 -2
- data/spec/models/admin_create_self_service_recovery_link_body_spec.rb +2 -2
- data/spec/models/admin_identity_import_credentials_spec.rb +2 -2
- data/spec/models/admin_update_identity_body_spec.rb +8 -2
- data/spec/models/api_token_spec.rb +2 -2
- data/spec/models/authenticator_assurance_level_spec.rb +2 -2
- data/spec/models/cloud_account_spec.rb +2 -2
- data/spec/models/cname_settings_spec.rb +2 -2
- data/spec/models/create_custom_hostname_body_spec.rb +2 -2
- data/spec/models/create_project_body_spec.rb +2 -2
- data/spec/models/create_subscription_payload_spec.rb +2 -2
- data/spec/models/error_authenticator_assurance_level_not_satisfied_spec.rb +2 -2
- data/spec/models/expand_tree_spec.rb +2 -2
- data/spec/models/generic_error_content_spec.rb +2 -2
- data/spec/models/generic_error_spec.rb +2 -2
- data/spec/models/get_check_response_spec.rb +2 -2
- data/spec/models/get_relation_tuples_response_spec.rb +2 -2
- data/spec/models/{inline_response2001_spec.rb → get_version200_response_spec.rb} +8 -8
- data/spec/models/health_not_ready_status_spec.rb +2 -2
- data/spec/models/health_status_spec.rb +2 -2
- data/spec/models/identity_credentials_oidc_provider_spec.rb +2 -2
- data/spec/models/identity_credentials_oidc_spec.rb +2 -2
- data/spec/models/identity_credentials_password_spec.rb +2 -2
- data/spec/models/identity_credentials_spec.rb +2 -2
- data/spec/models/identity_credentials_type_spec.rb +2 -2
- data/spec/models/identity_schema_container_spec.rb +40 -0
- data/spec/models/identity_schema_location_spec.rb +2 -2
- data/spec/models/identity_schema_preset_spec.rb +2 -2
- data/spec/models/identity_schema_spec.rb +2 -8
- data/spec/models/identity_schema_validation_result_spec.rb +2 -2
- data/spec/models/identity_spec.rb +2 -2
- data/spec/models/identity_state_spec.rb +2 -2
- data/spec/models/internal_relation_tuple_spec.rb +2 -2
- data/spec/models/invite_payload_spec.rb +2 -2
- data/spec/models/{inline_response200_spec.rb → is_alive200_response_spec.rb} +8 -8
- data/spec/models/is_owner_for_project_by_slug_payload_spec.rb +2 -2
- data/spec/models/is_owner_for_project_by_slug_spec.rb +2 -2
- data/spec/models/{inline_response503_spec.rb → is_ready503_response_spec.rb} +8 -8
- data/spec/models/json_error_spec.rb +2 -2
- data/spec/models/json_patch_spec.rb +8 -2
- data/spec/models/keto_namespace_spec.rb +2 -2
- data/spec/models/needs_privileged_session_error_spec.rb +2 -2
- data/spec/models/normalized_project_revision_hook_spec.rb +2 -2
- data/spec/models/normalized_project_revision_identity_schema_spec.rb +2 -2
- data/spec/models/normalized_project_revision_spec.rb +2 -2
- data/spec/models/normalized_project_revision_third_party_provider_spec.rb +2 -2
- data/spec/models/normalized_project_spec.rb +2 -2
- data/spec/models/null_plan_spec.rb +2 -2
- data/spec/models/pagination_spec.rb +2 -2
- data/spec/models/patch_delta_spec.rb +2 -2
- data/spec/models/project_host_spec.rb +2 -2
- data/spec/models/project_invite_spec.rb +2 -2
- data/spec/models/project_metadata_spec.rb +2 -2
- data/spec/models/project_service_identity_spec.rb +2 -2
- data/spec/models/project_service_permission_spec.rb +2 -2
- data/spec/models/project_services_spec.rb +2 -2
- data/spec/models/project_spec.rb +2 -2
- data/spec/models/provision_mock_subscription_payload_spec.rb +2 -2
- data/spec/models/quota_custom_domains_spec.rb +2 -2
- data/spec/models/quota_project_member_seats_spec.rb +2 -2
- data/spec/models/recovery_address_spec.rb +2 -2
- data/spec/models/relation_query_spec.rb +2 -2
- data/spec/models/revoked_sessions_spec.rb +2 -2
- data/spec/models/schema_patch_spec.rb +2 -2
- data/spec/models/self_service_browser_location_change_required_error_spec.rb +2 -2
- data/spec/models/self_service_error_spec.rb +2 -2
- data/spec/models/self_service_flow_expired_error_spec.rb +2 -2
- data/spec/models/self_service_login_flow_spec.rb +2 -2
- data/spec/models/self_service_logout_url_spec.rb +2 -2
- data/spec/models/self_service_recovery_flow_spec.rb +2 -2
- data/spec/models/self_service_recovery_flow_state_spec.rb +2 -2
- data/spec/models/self_service_recovery_link_spec.rb +2 -2
- data/spec/models/self_service_registration_flow_spec.rb +2 -2
- data/spec/models/self_service_settings_flow_spec.rb +2 -2
- data/spec/models/self_service_settings_flow_state_spec.rb +2 -2
- data/spec/models/self_service_verification_flow_spec.rb +2 -2
- data/spec/models/self_service_verification_flow_state_spec.rb +2 -2
- data/spec/models/session_authentication_method_spec.rb +2 -2
- data/spec/models/session_device_spec.rb +2 -2
- data/spec/models/session_spec.rb +2 -2
- data/spec/models/settings_profile_form_config_spec.rb +2 -2
- data/spec/models/stripe_customer_response_spec.rb +2 -2
- data/spec/models/subject_set_spec.rb +2 -2
- data/spec/models/submit_self_service_flow_with_web_authn_registration_method_spec.rb +2 -2
- data/spec/models/submit_self_service_login_flow_body_spec.rb +2 -2
- data/spec/models/submit_self_service_login_flow_with_lookup_secret_method_body_spec.rb +2 -2
- data/spec/models/submit_self_service_login_flow_with_oidc_method_body_spec.rb +2 -2
- data/spec/models/submit_self_service_login_flow_with_password_method_body_spec.rb +2 -2
- data/spec/models/submit_self_service_login_flow_with_totp_method_body_spec.rb +2 -2
- data/spec/models/submit_self_service_login_flow_with_web_authn_method_body_spec.rb +2 -2
- data/spec/models/submit_self_service_logout_flow_without_browser_body_spec.rb +2 -2
- data/spec/models/submit_self_service_recovery_flow_body_spec.rb +2 -2
- data/spec/models/submit_self_service_recovery_flow_with_link_method_body_spec.rb +2 -2
- data/spec/models/submit_self_service_registration_flow_body_spec.rb +2 -2
- data/spec/models/submit_self_service_registration_flow_with_oidc_method_body_spec.rb +2 -2
- data/spec/models/submit_self_service_registration_flow_with_password_method_body_spec.rb +2 -2
- data/spec/models/submit_self_service_registration_flow_with_web_authn_method_body_spec.rb +2 -2
- data/spec/models/submit_self_service_settings_flow_body_spec.rb +2 -2
- data/spec/models/submit_self_service_settings_flow_with_lookup_method_body_spec.rb +2 -2
- data/spec/models/submit_self_service_settings_flow_with_oidc_method_body_spec.rb +2 -2
- data/spec/models/submit_self_service_settings_flow_with_password_method_body_spec.rb +2 -2
- data/spec/models/submit_self_service_settings_flow_with_profile_method_body_spec.rb +2 -2
- data/spec/models/submit_self_service_settings_flow_with_totp_method_body_spec.rb +2 -2
- data/spec/models/submit_self_service_settings_flow_with_web_authn_method_body_spec.rb +2 -2
- data/spec/models/submit_self_service_verification_flow_body_spec.rb +2 -2
- data/spec/models/submit_self_service_verification_flow_with_link_method_body_spec.rb +2 -2
- data/spec/models/subscription_spec.rb +2 -2
- data/spec/models/successful_project_update_spec.rb +2 -2
- data/spec/models/successful_self_service_login_without_browser_spec.rb +2 -2
- data/spec/models/successful_self_service_registration_without_browser_spec.rb +2 -2
- data/spec/models/token_pagination_headers_spec.rb +40 -0
- data/spec/models/token_pagination_spec.rb +40 -0
- data/spec/models/ui_container_spec.rb +2 -2
- data/spec/models/ui_node_anchor_attributes_spec.rb +2 -2
- data/spec/models/ui_node_attributes_spec.rb +2 -2
- data/spec/models/ui_node_image_attributes_spec.rb +2 -2
- data/spec/models/ui_node_input_attributes_spec.rb +12 -2
- data/spec/models/ui_node_meta_spec.rb +2 -2
- data/spec/models/ui_node_script_attributes_spec.rb +2 -2
- data/spec/models/ui_node_spec.rb +2 -2
- data/spec/models/ui_node_text_attributes_spec.rb +2 -2
- data/spec/models/ui_text_spec.rb +2 -2
- data/spec/models/update_custom_hostname_body_spec.rb +2 -2
- data/spec/models/update_project_spec.rb +2 -2
- data/spec/models/update_subscription_payload_spec.rb +2 -2
- data/spec/models/verifiable_identity_address_spec.rb +2 -2
- data/spec/models/version_spec.rb +2 -2
- data/spec/models/warning_spec.rb +2 -2
- data/spec/spec_helper.rb +2 -2
- 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.5/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.4/gem_make.out +2 -2
- data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/stringio-3.0.2/gem_make.out +2 -2
- data/vendor/bundle/ruby/2.5.0/extensions/x86_64-linux/2.5.0/stringio-3.0.2/mkmf.log +1 -1
- 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/ffi-1.15.5/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.4/ext/psych/Makefile +2 -2
- data/vendor/bundle/ruby/2.5.0/gems/stringio-3.0.2/ext/stringio/Makefile +2 -2
- metadata +27 -15
data/docs/V0alpha2Api.md
CHANGED
@@ -12,10 +12,11 @@ All URIs are relative to *https://playground.projects.oryapis.com*
|
|
12
12
|
| [**admin_get_identity**](V0alpha2Api.md#admin_get_identity) | **GET** /admin/identities/{id} | Get an Identity |
|
13
13
|
| [**admin_list_identities**](V0alpha2Api.md#admin_list_identities) | **GET** /admin/identities | List Identities |
|
14
14
|
| [**admin_list_identity_sessions**](V0alpha2Api.md#admin_list_identity_sessions) | **GET** /admin/identities/{id}/sessions | This endpoint returns all sessions that belong to the given Identity. |
|
15
|
+
| [**admin_patch_identity**](V0alpha2Api.md#admin_patch_identity) | **PATCH** /admin/identities/{id} | Partially updates an Identity's field using [JSON Patch](https://jsonpatch.com/) |
|
15
16
|
| [**admin_update_identity**](V0alpha2Api.md#admin_update_identity) | **PUT** /admin/identities/{id} | Update an Identity |
|
16
17
|
| [**create_project**](V0alpha2Api.md#create_project) | **POST** /projects | Create a Project |
|
17
18
|
| [**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 |
|
18
|
-
| [**
|
19
|
+
| [**get_identity_schema**](V0alpha2Api.md#get_identity_schema) | **GET** /schemas/{id} | |
|
19
20
|
| [**get_project**](V0alpha2Api.md#get_project) | **GET** /projects/{project_id} | Get a Project |
|
20
21
|
| [**get_project_members**](V0alpha2Api.md#get_project_members) | **GET** /projects/{project_id}/members | Get all members associated with this project. |
|
21
22
|
| [**get_self_service_error**](V0alpha2Api.md#get_self_service_error) | **GET** /self-service/errors | Get Self-Service Errors |
|
@@ -496,7 +497,7 @@ end
|
|
496
497
|
api_instance = OryClient::V0alpha2Api.new
|
497
498
|
opts = {
|
498
499
|
per_page: 789, # Integer | Items per Page This is the number of items per page.
|
499
|
-
page: 789 # Integer | Pagination Page
|
500
|
+
page: 789 # Integer | Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist.
|
500
501
|
}
|
501
502
|
|
502
503
|
begin
|
@@ -531,7 +532,7 @@ end
|
|
531
532
|
| Name | Type | Description | Notes |
|
532
533
|
| ---- | ---- | ----------- | ----- |
|
533
534
|
| **per_page** | **Integer** | Items per Page This is the number of items per page. | [optional][default to 250] |
|
534
|
-
| **page** | **Integer** | Pagination Page | [optional][default to 1] |
|
535
|
+
| **page** | **Integer** | Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. | [optional][default to 1] |
|
535
536
|
|
536
537
|
### Return type
|
537
538
|
|
@@ -570,7 +571,7 @@ api_instance = OryClient::V0alpha2Api.new
|
|
570
571
|
id = 'id_example' # String | ID is the identity's ID.
|
571
572
|
opts = {
|
572
573
|
per_page: 789, # Integer | Items per Page This is the number of items per page.
|
573
|
-
page: 789, # Integer | Pagination Page
|
574
|
+
page: 789, # Integer | Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist.
|
574
575
|
active: true # Boolean | Active is a boolean flag that filters out sessions based on the state. If no value is provided, all sessions are returned.
|
575
576
|
}
|
576
577
|
|
@@ -607,7 +608,7 @@ end
|
|
607
608
|
| ---- | ---- | ----------- | ----- |
|
608
609
|
| **id** | **String** | ID is the identity's ID. | |
|
609
610
|
| **per_page** | **Integer** | Items per Page This is the number of items per page. | [optional][default to 250] |
|
610
|
-
| **page** | **Integer** | Pagination Page | [optional][default to 1] |
|
611
|
+
| **page** | **Integer** | Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. | [optional][default to 1] |
|
611
612
|
| **active** | **Boolean** | Active is a boolean flag that filters out sessions based on the state. If no value is provided, all sessions are returned. | [optional] |
|
612
613
|
|
613
614
|
### Return type
|
@@ -624,6 +625,79 @@ end
|
|
624
625
|
- **Accept**: application/json
|
625
626
|
|
626
627
|
|
628
|
+
## admin_patch_identity
|
629
|
+
|
630
|
+
> <Identity> admin_patch_identity(id, opts)
|
631
|
+
|
632
|
+
Partially updates an Identity's field using [JSON Patch](https://jsonpatch.com/)
|
633
|
+
|
634
|
+
NOTE: The fields `id`, `stateChangedAt` and `credentials` are not updateable. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
635
|
+
|
636
|
+
### Examples
|
637
|
+
|
638
|
+
```ruby
|
639
|
+
require 'time'
|
640
|
+
require 'ory-client'
|
641
|
+
# setup authorization
|
642
|
+
OryClient.configure do |config|
|
643
|
+
# Configure Bearer authorization: oryAccessToken
|
644
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
645
|
+
end
|
646
|
+
|
647
|
+
api_instance = OryClient::V0alpha2Api.new
|
648
|
+
id = 'id_example' # String | ID must be set to the ID of identity you want to update
|
649
|
+
opts = {
|
650
|
+
json_patch: [OryClient::JsonPatch.new({op: 'add', path: '/services/identity/config/smtp/from_name'})] # Array<JsonPatch> |
|
651
|
+
}
|
652
|
+
|
653
|
+
begin
|
654
|
+
# Partially updates an Identity's field using [JSON Patch](https://jsonpatch.com/)
|
655
|
+
result = api_instance.admin_patch_identity(id, opts)
|
656
|
+
p result
|
657
|
+
rescue OryClient::ApiError => e
|
658
|
+
puts "Error when calling V0alpha2Api->admin_patch_identity: #{e}"
|
659
|
+
end
|
660
|
+
```
|
661
|
+
|
662
|
+
#### Using the admin_patch_identity_with_http_info variant
|
663
|
+
|
664
|
+
This returns an Array which contains the response data, status code and headers.
|
665
|
+
|
666
|
+
> <Array(<Identity>, Integer, Hash)> admin_patch_identity_with_http_info(id, opts)
|
667
|
+
|
668
|
+
```ruby
|
669
|
+
begin
|
670
|
+
# Partially updates an Identity's field using [JSON Patch](https://jsonpatch.com/)
|
671
|
+
data, status_code, headers = api_instance.admin_patch_identity_with_http_info(id, opts)
|
672
|
+
p status_code # => 2xx
|
673
|
+
p headers # => { ... }
|
674
|
+
p data # => <Identity>
|
675
|
+
rescue OryClient::ApiError => e
|
676
|
+
puts "Error when calling V0alpha2Api->admin_patch_identity_with_http_info: #{e}"
|
677
|
+
end
|
678
|
+
```
|
679
|
+
|
680
|
+
### Parameters
|
681
|
+
|
682
|
+
| Name | Type | Description | Notes |
|
683
|
+
| ---- | ---- | ----------- | ----- |
|
684
|
+
| **id** | **String** | ID must be set to the ID of identity you want to update | |
|
685
|
+
| **json_patch** | [**Array<JsonPatch>**](JsonPatch.md) | | [optional] |
|
686
|
+
|
687
|
+
### Return type
|
688
|
+
|
689
|
+
[**Identity**](Identity.md)
|
690
|
+
|
691
|
+
### Authorization
|
692
|
+
|
693
|
+
[oryAccessToken](../README.md#oryAccessToken)
|
694
|
+
|
695
|
+
### HTTP request headers
|
696
|
+
|
697
|
+
- **Content-Type**: application/json
|
698
|
+
- **Accept**: application/json
|
699
|
+
|
700
|
+
|
627
701
|
## admin_update_identity
|
628
702
|
|
629
703
|
> <Identity> admin_update_identity(id, opts)
|
@@ -834,9 +908,9 @@ No authorization required
|
|
834
908
|
- **Accept**: application/json
|
835
909
|
|
836
910
|
|
837
|
-
##
|
911
|
+
## get_identity_schema
|
838
912
|
|
839
|
-
>
|
913
|
+
> <IdentitySchema> get_identity_schema(id)
|
840
914
|
|
841
915
|
|
842
916
|
|
@@ -853,28 +927,28 @@ id = 'id_example' # String | ID must be set to the ID of schema you want to get
|
|
853
927
|
|
854
928
|
begin
|
855
929
|
|
856
|
-
result = api_instance.
|
930
|
+
result = api_instance.get_identity_schema(id)
|
857
931
|
p result
|
858
932
|
rescue OryClient::ApiError => e
|
859
|
-
puts "Error when calling V0alpha2Api->
|
933
|
+
puts "Error when calling V0alpha2Api->get_identity_schema: #{e}"
|
860
934
|
end
|
861
935
|
```
|
862
936
|
|
863
|
-
#### Using the
|
937
|
+
#### Using the get_identity_schema_with_http_info variant
|
864
938
|
|
865
939
|
This returns an Array which contains the response data, status code and headers.
|
866
940
|
|
867
|
-
> <Array(
|
941
|
+
> <Array(<IdentitySchema>, Integer, Hash)> get_identity_schema_with_http_info(id)
|
868
942
|
|
869
943
|
```ruby
|
870
944
|
begin
|
871
945
|
|
872
|
-
data, status_code, headers = api_instance.
|
946
|
+
data, status_code, headers = api_instance.get_identity_schema_with_http_info(id)
|
873
947
|
p status_code # => 2xx
|
874
948
|
p headers # => { ... }
|
875
|
-
p data # =>
|
949
|
+
p data # => <IdentitySchema>
|
876
950
|
rescue OryClient::ApiError => e
|
877
|
-
puts "Error when calling V0alpha2Api->
|
951
|
+
puts "Error when calling V0alpha2Api->get_identity_schema_with_http_info: #{e}"
|
878
952
|
end
|
879
953
|
```
|
880
954
|
|
@@ -886,7 +960,7 @@ end
|
|
886
960
|
|
887
961
|
### Return type
|
888
962
|
|
889
|
-
**
|
963
|
+
[**IdentitySchema**](IdentitySchema.md)
|
890
964
|
|
891
965
|
### Authorization
|
892
966
|
|
@@ -2101,7 +2175,7 @@ No authorization required
|
|
2101
2175
|
|
2102
2176
|
Initialize Verification Flow for APIs, Services, Apps, ...
|
2103
2177
|
|
2104
|
-
This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. To fetch an existing verification flow call `/self-service/verification/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/
|
2178
|
+
This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. To fetch an existing verification flow call `/self-service/verification/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/self-service/flows/verify-email-account-activation).
|
2105
2179
|
|
2106
2180
|
### Examples
|
2107
2181
|
|
@@ -2173,7 +2247,7 @@ require 'ory-client'
|
|
2173
2247
|
api_instance = OryClient::V0alpha2Api.new
|
2174
2248
|
opts = {
|
2175
2249
|
per_page: 789, # Integer | Items per Page This is the number of items per page.
|
2176
|
-
page: 789 # Integer | Pagination Page
|
2250
|
+
page: 789 # Integer | Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist.
|
2177
2251
|
}
|
2178
2252
|
|
2179
2253
|
begin
|
@@ -2208,7 +2282,7 @@ end
|
|
2208
2282
|
| Name | Type | Description | Notes |
|
2209
2283
|
| ---- | ---- | ----------- | ----- |
|
2210
2284
|
| **per_page** | **Integer** | Items per Page This is the number of items per page. | [optional][default to 250] |
|
2211
|
-
| **page** | **Integer** | Pagination Page | [optional][default to 1] |
|
2285
|
+
| **page** | **Integer** | Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. | [optional][default to 1] |
|
2212
2286
|
|
2213
2287
|
### Return type
|
2214
2288
|
|
@@ -2309,7 +2383,7 @@ opts = {
|
|
2309
2383
|
x_session_token: 'x_session_token_example', # String | Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`.
|
2310
2384
|
cookie: 'cookie_example', # 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.
|
2311
2385
|
per_page: 789, # Integer | Items per Page This is the number of items per page.
|
2312
|
-
page: 789 # Integer | Pagination Page
|
2386
|
+
page: 789 # Integer | Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist.
|
2313
2387
|
}
|
2314
2388
|
|
2315
2389
|
begin
|
@@ -2346,7 +2420,7 @@ end
|
|
2346
2420
|
| **x_session_token** | **String** | Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`. | [optional] |
|
2347
2421
|
| **cookie** | **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. | [optional] |
|
2348
2422
|
| **per_page** | **Integer** | Items per Page This is the number of items per page. | [optional][default to 250] |
|
2349
|
-
| **page** | **Integer** | Pagination Page | [optional][default to 1] |
|
2423
|
+
| **page** | **Integer** | Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. | [optional][default to 1] |
|
2350
2424
|
|
2351
2425
|
### Return type
|
2352
2426
|
|
@@ -2792,7 +2866,7 @@ require 'ory-client'
|
|
2792
2866
|
|
2793
2867
|
api_instance = OryClient::V0alpha2Api.new
|
2794
2868
|
opts = {
|
2795
|
-
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/
|
2869
|
+
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/browser` to generate a URL for this endpoint.
|
2796
2870
|
return_to: 'return_to_example' # String | The URL to return to after the logout was completed.
|
2797
2871
|
}
|
2798
2872
|
|
@@ -2826,7 +2900,7 @@ end
|
|
2826
2900
|
|
2827
2901
|
| Name | Type | Description | Notes |
|
2828
2902
|
| ---- | ---- | ----------- | ----- |
|
2829
|
-
| **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/
|
2903
|
+
| **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/browser` to generate a URL for this endpoint. | [optional] |
|
2830
2904
|
| **return_to** | **String** | The URL to return to after the logout was completed. | [optional] |
|
2831
2905
|
|
2832
2906
|
### Return type
|
@@ -5,7 +5,7 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **created_at** | **Time** | When this entry was created | [optional] |
|
8
|
-
| **id** | **String** | |
|
8
|
+
| **id** | **String** | | [optional] |
|
9
9
|
| **status** | **String** | VerifiableAddressStatus must not exceed 16 characters as that is the limitation in the SQL Schema | |
|
10
10
|
| **updated_at** | **Time** | When this entry was last updated | [optional] |
|
11
11
|
| **value** | **String** | The address value example foo@user.com | |
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: v0.
|
6
|
+
The version of the OpenAPI document: v0.2.0-alpha.2
|
7
7
|
Contact: support@ory.sh
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 6.0.1
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -22,7 +22,7 @@ module OryClient
|
|
22
22
|
# Return Running Software Version.
|
23
23
|
# This endpoint returns the version of Ory Kratos. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the version will never refer to the cluster state, only to a single instance.
|
24
24
|
# @param [Hash] opts the optional parameters
|
25
|
-
# @return [
|
25
|
+
# @return [GetVersion200Response]
|
26
26
|
def get_version(opts = {})
|
27
27
|
data, _status_code, _headers = get_version_with_http_info(opts)
|
28
28
|
data
|
@@ -31,7 +31,7 @@ module OryClient
|
|
31
31
|
# Return Running Software Version.
|
32
32
|
# This endpoint returns the version of Ory Kratos. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the version will never refer to the cluster state, only to a single instance.
|
33
33
|
# @param [Hash] opts the optional parameters
|
34
|
-
# @return [Array<(
|
34
|
+
# @return [Array<(GetVersion200Response, Integer, Hash)>] GetVersion200Response data, response status code and response headers
|
35
35
|
def get_version_with_http_info(opts = {})
|
36
36
|
if @api_client.config.debugging
|
37
37
|
@api_client.config.logger.debug 'Calling API: MetadataApi.get_version ...'
|
@@ -54,7 +54,7 @@ module OryClient
|
|
54
54
|
post_body = opts[:debug_body]
|
55
55
|
|
56
56
|
# return_type
|
57
|
-
return_type = opts[:debug_return_type] || '
|
57
|
+
return_type = opts[:debug_return_type] || 'GetVersion200Response'
|
58
58
|
|
59
59
|
# auth_names
|
60
60
|
auth_names = opts[:debug_auth_names] || ['oryAccessToken']
|
@@ -79,7 +79,7 @@ module OryClient
|
|
79
79
|
# Check HTTP Server Status
|
80
80
|
# This endpoint returns a HTTP 200 status code when Ory Kratos is accepting incoming HTTP requests. This status does currently not include checks whether the database connection is working. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
|
81
81
|
# @param [Hash] opts the optional parameters
|
82
|
-
# @return [
|
82
|
+
# @return [IsAlive200Response]
|
83
83
|
def is_alive(opts = {})
|
84
84
|
data, _status_code, _headers = is_alive_with_http_info(opts)
|
85
85
|
data
|
@@ -88,7 +88,7 @@ module OryClient
|
|
88
88
|
# Check HTTP Server Status
|
89
89
|
# This endpoint returns a HTTP 200 status code when Ory Kratos is accepting incoming HTTP requests. This status does currently not include checks whether the database connection is working. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.
|
90
90
|
# @param [Hash] opts the optional parameters
|
91
|
-
# @return [Array<(
|
91
|
+
# @return [Array<(IsAlive200Response, Integer, Hash)>] IsAlive200Response data, response status code and response headers
|
92
92
|
def is_alive_with_http_info(opts = {})
|
93
93
|
if @api_client.config.debugging
|
94
94
|
@api_client.config.logger.debug 'Calling API: MetadataApi.is_alive ...'
|
@@ -111,7 +111,7 @@ module OryClient
|
|
111
111
|
post_body = opts[:debug_body]
|
112
112
|
|
113
113
|
# return_type
|
114
|
-
return_type = opts[:debug_return_type] || '
|
114
|
+
return_type = opts[:debug_return_type] || 'IsAlive200Response'
|
115
115
|
|
116
116
|
# auth_names
|
117
117
|
auth_names = opts[:debug_auth_names] || ['oryAccessToken']
|
@@ -136,7 +136,7 @@ module OryClient
|
|
136
136
|
# Check HTTP Server and Database Status
|
137
137
|
# This endpoint returns a HTTP 200 status code when Ory Kratos is up running and the environment dependencies (e.g. the database) are responsive as well. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of Ory Kratos, the health status will never refer to the cluster state, only to a single instance.
|
138
138
|
# @param [Hash] opts the optional parameters
|
139
|
-
# @return [
|
139
|
+
# @return [IsAlive200Response]
|
140
140
|
def is_ready(opts = {})
|
141
141
|
data, _status_code, _headers = is_ready_with_http_info(opts)
|
142
142
|
data
|
@@ -145,7 +145,7 @@ module OryClient
|
|
145
145
|
# Check HTTP Server and Database Status
|
146
146
|
# This endpoint returns a HTTP 200 status code when Ory Kratos is up running and the environment dependencies (e.g. the database) are responsive as well. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of Ory Kratos, the health status will never refer to the cluster state, only to a single instance.
|
147
147
|
# @param [Hash] opts the optional parameters
|
148
|
-
# @return [Array<(
|
148
|
+
# @return [Array<(IsAlive200Response, Integer, Hash)>] IsAlive200Response data, response status code and response headers
|
149
149
|
def is_ready_with_http_info(opts = {})
|
150
150
|
if @api_client.config.debugging
|
151
151
|
@api_client.config.logger.debug 'Calling API: MetadataApi.is_ready ...'
|
@@ -168,7 +168,7 @@ module OryClient
|
|
168
168
|
post_body = opts[:debug_body]
|
169
169
|
|
170
170
|
# return_type
|
171
|
-
return_type = opts[:debug_return_type] || '
|
171
|
+
return_type = opts[:debug_return_type] || 'IsAlive200Response'
|
172
172
|
|
173
173
|
# auth_names
|
174
174
|
auth_names = opts[:debug_auth_names] || ['oryAccessToken']
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: v0.
|
6
|
+
The version of the OpenAPI document: v0.2.0-alpha.2
|
7
7
|
Contact: support@ory.sh
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 6.0.1
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -3,10 +3,10 @@
|
|
3
3
|
|
4
4
|
#Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
|
5
5
|
|
6
|
-
The version of the OpenAPI document: v0.
|
6
|
+
The version of the OpenAPI document: v0.2.0-alpha.2
|
7
7
|
Contact: support@ory.sh
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
|
-
OpenAPI Generator version:
|
9
|
+
OpenAPI Generator version: 6.0.1
|
10
10
|
|
11
11
|
=end
|
12
12
|
|
@@ -406,7 +406,7 @@ module OryClient
|
|
406
406
|
# Lists all identities. Does not support search at the moment. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
407
407
|
# @param [Hash] opts the optional parameters
|
408
408
|
# @option opts [Integer] :per_page Items per Page This is the number of items per page. (default to 250)
|
409
|
-
# @option opts [Integer] :page Pagination Page (default to 1)
|
409
|
+
# @option opts [Integer] :page Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. (default to 1)
|
410
410
|
# @return [Array<Identity>]
|
411
411
|
def admin_list_identities(opts = {})
|
412
412
|
data, _status_code, _headers = admin_list_identities_with_http_info(opts)
|
@@ -416,8 +416,8 @@ module OryClient
|
|
416
416
|
# List Identities
|
417
417
|
# Lists all identities. Does not support search at the moment. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
418
418
|
# @param [Hash] opts the optional parameters
|
419
|
-
# @option opts [Integer] :per_page Items per Page This is the number of items per page.
|
420
|
-
# @option opts [Integer] :page Pagination Page
|
419
|
+
# @option opts [Integer] :per_page Items per Page This is the number of items per page. (default to 250)
|
420
|
+
# @option opts [Integer] :page Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. (default to 1)
|
421
421
|
# @return [Array<(Array<Identity>, Integer, Hash)>] Array<Identity> data, response status code and response headers
|
422
422
|
def admin_list_identities_with_http_info(opts = {})
|
423
423
|
if @api_client.config.debugging
|
@@ -482,7 +482,7 @@ module OryClient
|
|
482
482
|
# @param id [String] ID is the identity's ID.
|
483
483
|
# @param [Hash] opts the optional parameters
|
484
484
|
# @option opts [Integer] :per_page Items per Page This is the number of items per page. (default to 250)
|
485
|
-
# @option opts [Integer] :page Pagination Page (default to 1)
|
485
|
+
# @option opts [Integer] :page Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. (default to 1)
|
486
486
|
# @option opts [Boolean] :active Active is a boolean flag that filters out sessions based on the state. If no value is provided, all sessions are returned.
|
487
487
|
# @return [Array<Session>]
|
488
488
|
def admin_list_identity_sessions(id, opts = {})
|
@@ -494,8 +494,8 @@ module OryClient
|
|
494
494
|
# This endpoint is useful for: Listing all sessions that belong to an Identity in an administrative context.
|
495
495
|
# @param id [String] ID is the identity's ID.
|
496
496
|
# @param [Hash] opts the optional parameters
|
497
|
-
# @option opts [Integer] :per_page Items per Page This is the number of items per page.
|
498
|
-
# @option opts [Integer] :page Pagination Page
|
497
|
+
# @option opts [Integer] :per_page Items per Page This is the number of items per page. (default to 250)
|
498
|
+
# @option opts [Integer] :page Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. (default to 1)
|
499
499
|
# @option opts [Boolean] :active Active is a boolean flag that filters out sessions based on the state. If no value is provided, all sessions are returned.
|
500
500
|
# @return [Array<(Array<Session>, Integer, Hash)>] Array<Session> data, response status code and response headers
|
501
501
|
def admin_list_identity_sessions_with_http_info(id, opts = {})
|
@@ -561,6 +561,76 @@ module OryClient
|
|
561
561
|
return data, status_code, headers
|
562
562
|
end
|
563
563
|
|
564
|
+
# Partially updates an Identity's field using [JSON Patch](https://jsonpatch.com/)
|
565
|
+
# NOTE: The fields `id`, `stateChangedAt` and `credentials` are not updateable. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
566
|
+
# @param id [String] ID must be set to the ID of identity you want to update
|
567
|
+
# @param [Hash] opts the optional parameters
|
568
|
+
# @option opts [Array<JsonPatch>] :json_patch
|
569
|
+
# @return [Identity]
|
570
|
+
def admin_patch_identity(id, opts = {})
|
571
|
+
data, _status_code, _headers = admin_patch_identity_with_http_info(id, opts)
|
572
|
+
data
|
573
|
+
end
|
574
|
+
|
575
|
+
# Partially updates an Identity's field using [JSON Patch](https://jsonpatch.com/)
|
576
|
+
# NOTE: The fields `id`, `stateChangedAt` and `credentials` are not updateable. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
577
|
+
# @param id [String] ID must be set to the ID of identity you want to update
|
578
|
+
# @param [Hash] opts the optional parameters
|
579
|
+
# @option opts [Array<JsonPatch>] :json_patch
|
580
|
+
# @return [Array<(Identity, Integer, Hash)>] Identity data, response status code and response headers
|
581
|
+
def admin_patch_identity_with_http_info(id, opts = {})
|
582
|
+
if @api_client.config.debugging
|
583
|
+
@api_client.config.logger.debug 'Calling API: V0alpha2Api.admin_patch_identity ...'
|
584
|
+
end
|
585
|
+
# verify the required parameter 'id' is set
|
586
|
+
if @api_client.config.client_side_validation && id.nil?
|
587
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling V0alpha2Api.admin_patch_identity"
|
588
|
+
end
|
589
|
+
# resource path
|
590
|
+
local_var_path = '/admin/identities/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
591
|
+
|
592
|
+
# query parameters
|
593
|
+
query_params = opts[:query_params] || {}
|
594
|
+
|
595
|
+
# header parameters
|
596
|
+
header_params = opts[:header_params] || {}
|
597
|
+
# HTTP header 'Accept' (if needed)
|
598
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
599
|
+
# HTTP header 'Content-Type'
|
600
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
601
|
+
if !content_type.nil?
|
602
|
+
header_params['Content-Type'] = content_type
|
603
|
+
end
|
604
|
+
|
605
|
+
# form parameters
|
606
|
+
form_params = opts[:form_params] || {}
|
607
|
+
|
608
|
+
# http body (model)
|
609
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'json_patch'])
|
610
|
+
|
611
|
+
# return_type
|
612
|
+
return_type = opts[:debug_return_type] || 'Identity'
|
613
|
+
|
614
|
+
# auth_names
|
615
|
+
auth_names = opts[:debug_auth_names] || ['oryAccessToken']
|
616
|
+
|
617
|
+
new_options = opts.merge(
|
618
|
+
:operation => :"V0alpha2Api.admin_patch_identity",
|
619
|
+
:header_params => header_params,
|
620
|
+
:query_params => query_params,
|
621
|
+
:form_params => form_params,
|
622
|
+
:body => post_body,
|
623
|
+
:auth_names => auth_names,
|
624
|
+
:return_type => return_type
|
625
|
+
)
|
626
|
+
|
627
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
628
|
+
if @api_client.config.debugging
|
629
|
+
@api_client.config.logger.debug "API called: V0alpha2Api#admin_patch_identity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
630
|
+
end
|
631
|
+
return data, status_code, headers
|
632
|
+
end
|
633
|
+
|
564
634
|
# Update an Identity
|
565
635
|
# This endpoint updates an identity. The full identity payload (except credentials) is expected. This endpoint does not support patching. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
|
566
636
|
# @param id [String] ID must be set to the ID of identity you want to update
|
@@ -758,23 +828,23 @@ module OryClient
|
|
758
828
|
# Get a JSON Schema
|
759
829
|
# @param id [String] ID must be set to the ID of schema you want to get
|
760
830
|
# @param [Hash] opts the optional parameters
|
761
|
-
# @return [
|
762
|
-
def
|
763
|
-
data, _status_code, _headers =
|
831
|
+
# @return [IdentitySchema]
|
832
|
+
def get_identity_schema(id, opts = {})
|
833
|
+
data, _status_code, _headers = get_identity_schema_with_http_info(id, opts)
|
764
834
|
data
|
765
835
|
end
|
766
836
|
|
767
837
|
# Get a JSON Schema
|
768
838
|
# @param id [String] ID must be set to the ID of schema you want to get
|
769
839
|
# @param [Hash] opts the optional parameters
|
770
|
-
# @return [Array<(
|
771
|
-
def
|
840
|
+
# @return [Array<(IdentitySchema, Integer, Hash)>] IdentitySchema data, response status code and response headers
|
841
|
+
def get_identity_schema_with_http_info(id, opts = {})
|
772
842
|
if @api_client.config.debugging
|
773
|
-
@api_client.config.logger.debug 'Calling API: V0alpha2Api.
|
843
|
+
@api_client.config.logger.debug 'Calling API: V0alpha2Api.get_identity_schema ...'
|
774
844
|
end
|
775
845
|
# verify the required parameter 'id' is set
|
776
846
|
if @api_client.config.client_side_validation && id.nil?
|
777
|
-
fail ArgumentError, "Missing the required parameter 'id' when calling V0alpha2Api.
|
847
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling V0alpha2Api.get_identity_schema"
|
778
848
|
end
|
779
849
|
# resource path
|
780
850
|
local_var_path = '/schemas/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
|
@@ -794,13 +864,13 @@ module OryClient
|
|
794
864
|
post_body = opts[:debug_body]
|
795
865
|
|
796
866
|
# return_type
|
797
|
-
return_type = opts[:debug_return_type] || '
|
867
|
+
return_type = opts[:debug_return_type] || 'IdentitySchema'
|
798
868
|
|
799
869
|
# auth_names
|
800
870
|
auth_names = opts[:debug_auth_names] || []
|
801
871
|
|
802
872
|
new_options = opts.merge(
|
803
|
-
:operation => :"V0alpha2Api.
|
873
|
+
:operation => :"V0alpha2Api.get_identity_schema",
|
804
874
|
:header_params => header_params,
|
805
875
|
:query_params => query_params,
|
806
876
|
:form_params => form_params,
|
@@ -811,7 +881,7 @@ module OryClient
|
|
811
881
|
|
812
882
|
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
813
883
|
if @api_client.config.debugging
|
814
|
-
@api_client.config.logger.debug "API called: V0alpha2Api#
|
884
|
+
@api_client.config.logger.debug "API called: V0alpha2Api#get_identity_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
815
885
|
end
|
816
886
|
return data, status_code, headers
|
817
887
|
end
|
@@ -1948,7 +2018,7 @@ module OryClient
|
|
1948
2018
|
end
|
1949
2019
|
|
1950
2020
|
# Initialize Verification Flow for APIs, Services, Apps, ...
|
1951
|
-
# This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. To fetch an existing verification flow call `/self-service/verification/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/
|
2021
|
+
# This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. To fetch an existing verification flow call `/self-service/verification/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/self-service/flows/verify-email-account-activation).
|
1952
2022
|
# @param [Hash] opts the optional parameters
|
1953
2023
|
# @return [SelfServiceVerificationFlow]
|
1954
2024
|
def initialize_self_service_verification_flow_without_browser(opts = {})
|
@@ -1957,7 +2027,7 @@ module OryClient
|
|
1957
2027
|
end
|
1958
2028
|
|
1959
2029
|
# Initialize Verification Flow for APIs, Services, Apps, ...
|
1960
|
-
# This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. To fetch an existing verification flow call `/self-service/verification/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/
|
2030
|
+
# This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. To fetch an existing verification flow call `/self-service/verification/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/self-service/flows/verify-email-account-activation).
|
1961
2031
|
# @param [Hash] opts the optional parameters
|
1962
2032
|
# @return [Array<(SelfServiceVerificationFlow, Integer, Hash)>] SelfServiceVerificationFlow data, response status code and response headers
|
1963
2033
|
def initialize_self_service_verification_flow_without_browser_with_http_info(opts = {})
|
@@ -2007,7 +2077,7 @@ module OryClient
|
|
2007
2077
|
# Get all Identity Schemas
|
2008
2078
|
# @param [Hash] opts the optional parameters
|
2009
2079
|
# @option opts [Integer] :per_page Items per Page This is the number of items per page. (default to 250)
|
2010
|
-
# @option opts [Integer] :page Pagination Page (default to 1)
|
2080
|
+
# @option opts [Integer] :page Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. (default to 1)
|
2011
2081
|
# @return [Array<IdentitySchema>]
|
2012
2082
|
def list_identity_schemas(opts = {})
|
2013
2083
|
data, _status_code, _headers = list_identity_schemas_with_http_info(opts)
|
@@ -2016,8 +2086,8 @@ module OryClient
|
|
2016
2086
|
|
2017
2087
|
# Get all Identity Schemas
|
2018
2088
|
# @param [Hash] opts the optional parameters
|
2019
|
-
# @option opts [Integer] :per_page Items per Page This is the number of items per page.
|
2020
|
-
# @option opts [Integer] :page Pagination Page
|
2089
|
+
# @option opts [Integer] :per_page Items per Page This is the number of items per page. (default to 250)
|
2090
|
+
# @option opts [Integer] :page Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. (default to 1)
|
2021
2091
|
# @return [Array<(Array<IdentitySchema>, Integer, Hash)>] Array<IdentitySchema> data, response status code and response headers
|
2022
2092
|
def list_identity_schemas_with_http_info(opts = {})
|
2023
2093
|
if @api_client.config.debugging
|
@@ -2140,7 +2210,7 @@ module OryClient
|
|
2140
2210
|
# @option opts [String] :x_session_token Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`.
|
2141
2211
|
# @option opts [String] :cookie Set the Cookie Header. This is especially useful when calling this endpoint from a server-side application. In that scenario you must include the HTTP Cookie Header which originally was included in the request to your server. An example of a session in the HTTP Cookie Header is: `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.
|
2142
2212
|
# @option opts [Integer] :per_page Items per Page This is the number of items per page. (default to 250)
|
2143
|
-
# @option opts [Integer] :page Pagination Page (default to 1)
|
2213
|
+
# @option opts [Integer] :page Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. (default to 1)
|
2144
2214
|
# @return [Array<Session>]
|
2145
2215
|
def list_sessions(opts = {})
|
2146
2216
|
data, _status_code, _headers = list_sessions_with_http_info(opts)
|
@@ -2152,8 +2222,8 @@ module OryClient
|
|
2152
2222
|
# @param [Hash] opts the optional parameters
|
2153
2223
|
# @option opts [String] :x_session_token Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`.
|
2154
2224
|
# @option opts [String] :cookie Set the Cookie Header. This is especially useful when calling this endpoint from a server-side application. In that scenario you must include the HTTP Cookie Header which originally was included in the request to your server. An example of a session in the HTTP Cookie Header is: `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.
|
2155
|
-
# @option opts [Integer] :per_page Items per Page This is the number of items per page.
|
2156
|
-
# @option opts [Integer] :page Pagination Page
|
2225
|
+
# @option opts [Integer] :per_page Items per Page This is the number of items per page. (default to 250)
|
2226
|
+
# @option opts [Integer] :page Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. (default to 1)
|
2157
2227
|
# @return [Array<(Array<Session>, Integer, Hash)>] Array<Session> data, response status code and response headers
|
2158
2228
|
def list_sessions_with_http_info(opts = {})
|
2159
2229
|
if @api_client.config.debugging
|
@@ -2627,7 +2697,7 @@ module OryClient
|
|
2627
2697
|
# Complete Self-Service Logout
|
2628
2698
|
# This endpoint logs out an identity in a self-service manner. If the `Accept` HTTP header is not set to `application/json`, the browser will be redirected (HTTP 303 See Other) to the `return_to` parameter of the initial request or fall back to `urls.default_return_to`. If the `Accept` HTTP header is set to `application/json`, a 204 No Content response will be sent on successful logout instead. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). For API clients you can call the `/self-service/logout/api` URL directly with the Ory Session Token. More information can be found at [Ory Kratos User Logout Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-logout).
|
2629
2699
|
# @param [Hash] opts the optional parameters
|
2630
|
-
# @option opts [String] :token A Valid Logout Token If you do not have a logout token because you only have a session cookie, call `/self-service/logout/
|
2700
|
+
# @option opts [String] :token A Valid Logout Token If you do not have a logout token because you only have a session cookie, call `/self-service/logout/browser` to generate a URL for this endpoint.
|
2631
2701
|
# @option opts [String] :return_to The URL to return to after the logout was completed.
|
2632
2702
|
# @return [nil]
|
2633
2703
|
def submit_self_service_logout_flow(opts = {})
|
@@ -2638,7 +2708,7 @@ module OryClient
|
|
2638
2708
|
# Complete Self-Service Logout
|
2639
2709
|
# This endpoint logs out an identity in a self-service manner. If the `Accept` HTTP header is not set to `application/json`, the browser will be redirected (HTTP 303 See Other) to the `return_to` parameter of the initial request or fall back to `urls.default_return_to`. If the `Accept` HTTP header is set to `application/json`, a 204 No Content response will be sent on successful logout instead. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). For API clients you can call the `/self-service/logout/api` URL directly with the Ory Session Token. More information can be found at [Ory Kratos User Logout Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-logout).
|
2640
2710
|
# @param [Hash] opts the optional parameters
|
2641
|
-
# @option opts [String] :token A Valid Logout Token If you do not have a logout token because you only have a session cookie, call `/self-service/logout/
|
2711
|
+
# @option opts [String] :token A Valid Logout Token If you do not have a logout token because you only have a session cookie, call `/self-service/logout/browser` to generate a URL for this endpoint.
|
2642
2712
|
# @option opts [String] :return_to The URL to return to after the logout was completed.
|
2643
2713
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
2644
2714
|
def submit_self_service_logout_flow_with_http_info(opts = {})
|