Module: OryClient

Defined in:: lib/ory-client/version.rb,
lib/ory-client.rb,
lib/ory-client/api_error.rb,
lib/ory-client/api_client.rb,
lib/ory-client/api/jwk_api.rb,
lib/ory-client/models/plan.rb,
lib/ory-client/api/oidc_api.rb,
lib/ory-client/models/money.rb,
lib/ory-client/models/usage.rb,
lib/ory-client/configuration.rb,
lib/ory-client/api/events_api.rb,
lib/ory-client/models/invoice.rb,
lib/ory-client/models/message.rb,
lib/ory-client/models/project.rb,
lib/ory-client/models/session.rb,
lib/ory-client/models/ui_node.rb,
lib/ory-client/models/ui_text.rb,
lib/ory-client/models/version.rb,
lib/ory-client/models/warning.rb,
lib/ory-client/api/courier_api.rb,
lib/ory-client/api/o_auth2_api.rb,
lib/ory-client/api/project_api.rb,
lib/ory-client/models/identity.rb,
lib/ory-client/models/provider.rb,
lib/ory-client/api/frontend_api.rb,
lib/ory-client/api/identity_api.rb,
lib/ory-client/api/metadata_api.rb,
lib/ory-client/models/attribute.rb,
lib/ory-client/models/namespace.rb,
lib/ory-client/models/workspace.rb,
lib/ory-client/api/wellknown_api.rb,
lib/ory-client/api/workspace_api.rb,
lib/ory-client/models/flow_error.rb,
lib/ory-client/models/json_patch.rb,
lib/ory-client/models/login_flow.rb,
lib/ory-client/api/permission_api.rb,
lib/ory-client/models/logout_flow.rb,
lib/ory-client/models/parse_error.rb,
lib/ory-client/models/quota_usage.rb,
lib/ory-client/models/set_project.rb,
lib/ory-client/models/subject_set.rb,
lib/ory-client/models/event_stream.rb,
lib/ory-client/models/json_web_key.rb,
lib/ory-client/models/line_item_v1.rb,
lib/ory-client/models/organization.rb,
lib/ory-client/models/plan_details.rb,
lib/ory-client/models/project_cors.rb,
lib/ory-client/models/project_host.rb,
lib/ory-client/models/relationship.rb,
lib/ory-client/models/schema_patch.rb,
lib/ory-client/models/subscription.rb,
lib/ory-client/models/ui_container.rb,
lib/ory-client/models/ui_node_meta.rb,
lib/ory-client/api/relationship_api.rb,
lib/ory-client/models/cloud_account.rb,
lib/ory-client/models/continue_with.rb,
lib/ory-client/models/custom_domain.rb,
lib/ory-client/models/error_generic.rb,
lib/ory-client/models/error_o_auth2.rb,
lib/ory-client/models/generic_error.rb,
lib/ory-client/models/generic_usage.rb,
lib/ory-client/models/health_status.rb,
lib/ory-client/models/member_invite.rb,
lib/ory-client/models/recovery_flow.rb,
lib/ory-client/models/relationships.rb,
lib/ory-client/models/settings_flow.rb,
lib/ory-client/models/tax_line_item.rb,
lib/ory-client/models/time_interval.rb,
lib/ory-client/models/identity_patch.rb,
lib/ory-client/models/keto_namespace.rb,
lib/ory-client/models/o_auth2_client.rb,
lib/ory-client/models/oidc_user_info.rb,
lib/ory-client/models/project_member.rb,
lib/ory-client/models/relation_query.rb,
lib/ory-client/models/session_device.rb,
lib/ory-client/models/invoice_data_v1.rb,
lib/ory-client/models/list_workspaces.rb,
lib/ory-client/models/project_api_key.rb,
lib/ory-client/models/source_position.rb,
lib/ory-client/models/attribute_filter.rb,
lib/ory-client/models/json_web_key_set.rb,
lib/ory-client/models/login_flow_state.rb,
lib/ory-client/models/message_dispatch.rb,
lib/ory-client/models/project_branding.rb,
lib/ory-client/models/project_metadata.rb,
lib/ory-client/models/project_services.rb,
lib/ory-client/models/token_pagination.rb,
lib/ory-client/models/invite_token_body.rb,
lib/ory-client/models/metrics_datapoint.rb,
lib/ory-client/models/organization_body.rb,
lib/ory-client/models/registration_flow.rb,
lib/ory-client/models/verification_flow.rb,
lib/ory-client/models/workspace_api_key.rb,
lib/ory-client/models/basic_organization.rb,
lib/ory-client/models/list_event_streams.rb,
lib/ory-client/models/normalized_project.rb,
lib/ory-client/models/oidc_configuration.rb,
lib/ory-client/models/relationship_patch.rb,
lib/ory-client/models/rfc6749_error_json.rb,
lib/ory-client/models/ui_node_attributes.rb,
lib/ory-client/models/create_project_body.rb,
lib/ory-client/models/email_template_data.rb,
lib/ory-client/models/error_flow_replaced.rb,
lib/ory-client/models/o_auth2_redirect_to.rb,
lib/ory-client/models/recovery_flow_state.rb,
lib/ory-client/models/settings_flow_state.rb,
lib/ory-client/models/courier_message_type.rb,
lib/ory-client/models/create_identity_body.rb,
lib/ory-client/models/device_authorization.rb,
lib/ory-client/models/identity_credentials.rb,
lib/ory-client/models/update_identity_body.rb,
lib/ory-client/models/billing_period_bucket.rb,
lib/ory-client/models/create_workspace_body.rb,
lib/ory-client/models/generic_error_content.rb,
lib/ory-client/models/o_auth2_login_request.rb,
lib/ory-client/models/patch_identities_body.rb,
lib/ory-client/models/set_event_stream_body.rb,
lib/ory-client/models/update_workspace_body.rb,
lib/ory-client/models/courier_message_status.rb,
lib/ory-client/models/create_invite_response.rb,
lib/ory-client/models/identity_schema_preset.rb,
lib/ory-client/models/list_invoices_response.rb,
lib/ory-client/models/o_auth2_logout_request.rb,
lib/ory-client/models/o_auth2_token_exchange.rb,
lib/ory-client/models/onboarding_portal_link.rb,
lib/ory-client/models/project_branding_theme.rb,
lib/ory-client/models/reject_o_auth2_request.rb,
lib/ory-client/models/set_custom_domain_body.rb,
lib/ory-client/models/update_fedcm_flow_body.rb,
lib/ory-client/models/update_login_flow_body.rb,
lib/ory-client/models/check_opl_syntax_result.rb,
lib/ory-client/models/check_permission_result.rb,
lib/ory-client/models/create_json_web_key_set.rb,
lib/ory-client/models/create_project_branding.rb,
lib/ory-client/models/get_project_events_body.rb,
lib/ory-client/models/get_version200_response.rb,
lib/ory-client/models/health_not_ready_status.rb,
lib/ory-client/models/identity_patch_response.rb,
lib/ory-client/models/list_workspace_projects.rb,
lib/ory-client/models/managed_identity_schema.rb,
lib/ory-client/models/o_auth2_consent_request.rb,
lib/ory-client/models/o_auth2_consent_session.rb,
lib/ory-client/models/project_branding_colors.rb,
lib/ory-client/models/project_service_o_auth2.rb,
lib/ory-client/models/registration_flow_state.rb,
lib/ory-client/models/relationship_namespaces.rb,
lib/ory-client/models/successful_native_login.rb,
lib/ory-client/models/ui_node_text_attributes.rb,
lib/ory-client/models/verification_flow_state.rb,
lib/ory-client/models/create_event_stream_body.rb,
lib/ory-client/models/create_relationship_body.rb,
lib/ory-client/models/create_subscription_body.rb,
lib/ory-client/models/delete_my_sessions_count.rb,
lib/ory-client/models/device_user_auth_request.rb,
lib/ory-client/models/email_template_data_body.rb,
lib/ory-client/models/expanded_permission_tree.rb,
lib/ory-client/models/permissions_on_workspace.rb,
lib/ory-client/models/project_events_datapoint.rb,
lib/ory-client/models/project_service_identity.rb,
lib/ory-client/models/token_pagination_headers.rb,
lib/ory-client/models/ui_node_image_attributes.rb,
lib/ory-client/models/ui_node_input_attributes.rb,
lib/ory-client/models/update_subscription_body.rb,
lib/ory-client/models/verify_user_code_request.rb,
lib/ory-client/models/account_experience_colors.rb,
lib/ory-client/models/active_project_in_console.rb,
lib/ory-client/models/continue_with_recovery_ui.rb,
lib/ory-client/models/continue_with_settings_ui.rb,
lib/ory-client/models/create_custom_domain_body.rb,
lib/ory-client/models/get_organization_response.rb,
lib/ory-client/models/identity_credentials_code.rb,
lib/ory-client/models/identity_credentials_oidc.rb,
lib/ory-client/models/identity_schema_container.rb,
lib/ory-client/models/identity_with_credentials.rb,
lib/ory-client/models/recovery_identity_address.rb,
lib/ory-client/models/successful_project_update.rb,
lib/ory-client/models/ui_node_anchor_attributes.rb,
lib/ory-client/models/ui_node_script_attributes.rb,
lib/ory-client/models/update_recovery_flow_body.rb,
lib/ory-client/models/update_settings_flow_body.rb,
lib/ory-client/models/attributes_count_datapoint.rb,
lib/ory-client/models/create_fedcm_flow_response.rb,
lib/ory-client/models/create_subscription_common.rb,
lib/ory-client/models/introspected_o_auth2_token.rb,
lib/ory-client/models/perform_native_logout_body.rb,
lib/ory-client/models/post_check_permission_body.rb,
lib/ory-client/models/project_service_permission.rb,
lib/ory-client/models/recovery_code_for_identity.rb,
lib/ory-client/models/recovery_link_for_identity.rb,
lib/ory-client/models/session_activity_datapoint.rb,
lib/ory-client/models/batch_check_permission_body.rb,
lib/ory-client/models/get_project_events_response.rb,
lib/ory-client/models/list_organizations_response.rb,
lib/ory-client/models/normalized_project_revision.rb,
lib/ory-client/models/ui_node_division_attributes.rb,
lib/ory-client/models/verifiable_credential_proof.rb,
lib/ory-client/models/verifiable_identity_address.rb,
lib/ory-client/models/accept_o_auth2_login_request.rb,
lib/ory-client/models/credential_supported_draft00.rb,
lib/ory-client/models/get_project_metrics_response.rb,
lib/ory-client/models/is_owner_for_project_by_slug.rb,
lib/ory-client/models/add_project_to_workspace_body.rb,
lib/ory-client/models/authenticator_assurance_level.rb,
lib/ory-client/models/batch_check_permission_result.rb,
lib/ory-client/models/continue_with_verification_ui.rb,
lib/ory-client/models/create_workspace_api_key_body.rb,
lib/ory-client/models/get_attributes_count_response.rb,
lib/ory-client/models/get_session_activity_response.rb,
lib/ory-client/models/identity_credentials_password.rb,
lib/ory-client/models/session_authentication_method.rb,
lib/ory-client/models/update_registration_flow_body.rb,
lib/ory-client/models/update_verification_flow_body.rb,
lib/ory-client/models/accept_o_auth2_consent_request.rb,
lib/ory-client/models/consistency_request_parameters.rb,
lib/ory-client/models/continue_with_recovery_ui_flow.rb,
lib/ory-client/models/continue_with_settings_ui_flow.rb,
lib/ory-client/models/create_project_api_key_request.rb,
lib/ory-client/models/identity_with_credentials_oidc.rb,
lib/ory-client/models/identity_with_credentials_saml.rb,
lib/ory-client/models/needs_privileged_session_error.rb,
lib/ory-client/models/o_auth2_client_token_lifespans.rb,
lib/ory-client/models/onboarding_portal_organization.rb,
lib/ory-client/models/successful_native_registration.rb,
lib/ory-client/models/trust_o_auth2_jwt_grant_issuer.rb,
lib/ory-client/models/verifiable_credential_response.rb,
lib/ory-client/models/accept_device_user_code_request.rb,
lib/ory-client/models/batch_patch_identities_response.rb,
lib/ory-client/models/self_service_flow_expired_error.rb,
lib/ory-client/models/set_project_branding_theme_body.rb,
lib/ory-client/models/account_experience_configuration.rb,
lib/ory-client/models/get_metrics_event_types_response.rb,
lib/ory-client/models/normalized_project_revision_hook.rb,
lib/ory-client/models/trusted_o_auth2_jwt_grant_issuer.rb,
lib/ory-client/models/continue_with_redirect_browser_to.rb,
lib/ory-client/models/create_project_member_invite_body.rb,
lib/ory-client/models/create_project_normalized_payload.rb,
lib/ory-client/models/identity_credentials_code_address.rb,
lib/ory-client/models/successful_code_exchange_response.rb,
lib/ory-client/models/token_pagination_response_headers.rb,
lib/ory-client/models/account_experience_theme_variables.rb,
lib/ory-client/models/check_permission_result_with_error.rb,
lib/ory-client/models/continue_with_verification_ui_flow.rb,
lib/ory-client/models/create_workspace_subscription_body.rb,
lib/ory-client/models/identity_credentials_oidc_provider.rb,
lib/ory-client/models/identity_with_credentials_password.rb,
lib/ory-client/models/internal_get_project_branding_body.rb,
lib/ory-client/models/keyset_pagination_response_headers.rb,
lib/ory-client/models/o_auth2_consent_session_expires_at.rb,
lib/ory-client/models/set_active_project_in_console_body.rb,
lib/ory-client/models/update_login_flow_with_code_method.rb,
lib/ory-client/models/update_login_flow_with_oidc_method.rb,
lib/ory-client/models/update_login_flow_with_saml_method.rb,
lib/ory-client/models/update_login_flow_with_totp_method.rb,
lib/ory-client/models/continue_with_set_ory_session_token.rb,
lib/ory-client/models/create_workspace_member_invite_body.rb,
lib/ory-client/models/post_check_permission_or_error_body.rb,
lib/ory-client/models/token_pagination_request_parameters.rb,
lib/ory-client/models/get_managed_identity_schema_location.rb,
lib/ory-client/models/keyset_pagination_request_parameters.rb,
lib/ory-client/models/get_metrics_event_attributes_response.rb,
lib/ory-client/models/identity_with_credentials_oidc_config.rb,
lib/ory-client/models/identity_with_credentials_saml_config.rb,
lib/ory-client/models/update_login_flow_with_passkey_method.rb,
lib/ory-client/models/update_recovery_flow_with_code_method.rb,
lib/ory-client/models/update_recovery_flow_with_link_method.rb,
lib/ory-client/models/update_settings_flow_with_oidc_method.rb,
lib/ory-client/models/update_settings_flow_with_saml_method.rb,
lib/ory-client/models/update_settings_flow_with_totp_method.rb,
lib/ory-client/models/accept_o_auth2_consent_request_session.rb,
lib/ory-client/models/create_recovery_code_for_identity_body.rb,
lib/ory-client/models/create_recovery_link_for_identity_body.rb,
lib/ory-client/models/error_browser_location_change_required.rb,
lib/ory-client/models/trusted_o_auth2_jwt_grant_json_web_key.rb,
lib/ory-client/models/update_login_flow_with_password_method.rb,
lib/ory-client/models/verifiable_credential_priming_response.rb,
lib/ory-client/models/normalized_project_revision_scim_client.rb,
lib/ory-client/models/update_login_flow_with_web_authn_method.rb,
lib/ory-client/models/update_settings_flow_with_lookup_method.rb,
lib/ory-client/models/update_settings_flow_with_passkey_method.rb,
lib/ory-client/models/update_settings_flow_with_profile_method.rb,
lib/ory-client/models/create_verifiable_credential_request_body.rb,
lib/ory-client/models/identity_with_credentials_password_config.rb,
lib/ory-client/models/managed_identity_schema_validation_result.rb,
lib/ory-client/models/normalized_project_revision_saml_provider.rb,
lib/ory-client/models/update_registration_flow_with_code_method.rb,
lib/ory-client/models/update_registration_flow_with_oidc_method.rb,
lib/ory-client/models/update_registration_flow_with_saml_method.rb,
lib/ory-client/models/update_settings_flow_with_password_method.rb,
lib/ory-client/models/update_verification_flow_with_code_method.rb,
lib/ory-client/models/update_verification_flow_with_link_method.rb,
lib/ory-client/models/internal_is_owner_for_project_by_slug_body.rb,
lib/ory-client/models/update_settings_flow_with_web_authn_method.rb,
lib/ory-client/models/normalized_project_revision_courier_channel.rb,
lib/ory-client/models/normalized_project_revision_identity_schema.rb,
lib/ory-client/models/update_login_flow_with_lookup_secret_method.rb,
lib/ory-client/models/update_registration_flow_with_passkey_method.rb,
lib/ory-client/models/update_registration_flow_with_profile_method.rb,
lib/ory-client/models/organization_onboarding_portal_links_response.rb,
lib/ory-client/models/update_registration_flow_with_password_method.rb,
lib/ory-client/models/identity_with_credentials_oidc_config_provider.rb,
lib/ory-client/models/identity_with_credentials_saml_config_provider.rb,
lib/ory-client/models/internal_is_owner_for_project_by_slug_response.rb,
lib/ory-client/models/normalized_project_revision_tokenizer_template.rb,
lib/ory-client/models/update_login_flow_with_identifier_first_method.rb,
lib/ory-client/models/update_registration_flow_with_web_authn_method.rb,
lib/ory-client/models/create_organization_onboarding_portal_link_body.rb,
lib/ory-client/models/o_auth2_consent_request_open_id_connect_context.rb,
lib/ory-client/models/update_organization_onboarding_portal_link_body.rb,
lib/ory-client/models/normalized_project_revision_third_party_provider.rb,
lib/ory-client/models/error_authenticator_assurance_level_not_satisfied.rb,
lib/ory-client/models/set_organization_from_onboarding_portal_link_body.rb,
lib/ory-client/models/internal_is_ax_welcome_screen_enabled_for_project_body.rb

Overview

#Ory APIs

## Introduction Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers. ## SDKs This document describes the APIs available in the Ory Network. The APIs are available as SDKs for the following languages: | Language | Download SDK | Documentation | | ————– | —————————————————————- | ———————————————————————————— | | Dart | [pub.dev](pub.dev/packages/ory_client) | [README](github.com/ory/sdk/blob/master/clients/client/dart/README.md) | | .NET | [nuget.org](www.nuget.org/packages/Ory.Client/) | [README](github.com/ory/sdk/blob/master/clients/client/dotnet/README.md) | | Elixir | [hex.pm](hex.pm/packages/ory_client) | [README](github.com/ory/sdk/blob/master/clients/client/elixir/README.md) | | Go | [github.com](github.com/ory/client-go) | [README](github.com/ory/sdk/blob/master/clients/client/go/README.md) | | Java | [maven.org](search.maven.org/artifact/sh.ory/ory-client) | [README](github.com/ory/sdk/blob/master/clients/client/java/README.md) | | JavaScript | [npmjs.com](www.npmjs.com/package/@ory/client) | [README](github.com/ory/sdk/blob/master/clients/client/typescript/README.md) | | JavaScript (With fetch) | [npmjs.com](www.npmjs.com/package/@ory/client-fetch) | [README](github.com/ory/sdk/blob/master/clients/client/typescript-fetch/README.md) | | PHP | [packagist.org](packagist.org/packages/ory/client) | [README](github.com/ory/sdk/blob/master/clients/client/php/README.md) | | Python | [pypi.org](pypi.org/project/ory-client/) | [README](github.com/ory/sdk/blob/master/clients/client/python/README.md) | | Ruby | [rubygems.org](rubygems.org/gems/ory-client) | [README](github.com/ory/sdk/blob/master/clients/client/ruby/README.md) | | Rust | [crates.io](crates.io/crates/ory-client) | [README](github.com/ory/sdk/blob/master/clients/client/rust/README.md) |

The version of the OpenAPI document: v1.21.4 Contact: [email protected] Generated by: openapi-generator.tech Generator version: 7.12.0

Defined Under Namespace

Constant Summary collapse

VERSION =

'1.21.4'

Class Method Summary collapse

.configure ⇒ Object

Customize default settings for the SDK using block.

Class Method Details

.configure ⇒ `Object`

Customize default settings for the SDK using block.

OryClient.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.

# File 'lib/ory-client.rb', line 338

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end