Module: WorkOS

Defined in:

lib/workos/client.rb,
lib/workos.rb,
lib/workos/sso.rb,
lib/workos/pkce.rb,
lib/workos/util.rb,
lib/workos/pipes.rb,
lib/workos/radar.rb,
lib/workos/vault.rb,
lib/workos/errors.rb,
lib/workos/events.rb,
lib/workos/actions.rb,
lib/workos/connect.rb,
lib/workos/session.rb,
lib/workos/version.rb,
lib/workos/widgets.rb,
lib/workos/api_keys.rb,
lib/workos/webhooks.rb,
lib/workos/audit_logs.rb,
lib/workos/encryptors.rb,
lib/workos/base_client.rb,
lib/workos/sso/profile.rb,
lib/workos/admin_portal.rb,
lib/workos/passwordless.rb,
lib/workos/shared/group.rb,
lib/workos/authorization.rb,
lib/workos/configuration.rb,
lib/workos/feature_flags.rb,
lib/workos/hash_provider.rb,
lib/workos/organizations.rb,
lib/workos/public_client.rb,
lib/workos/webhook_event.rb,
lib/workos/directory_sync.rb,
lib/workos/sso/connection.rb,
lib/workos/util/signature.rb,
lib/workos/session_manager.rb,
lib/workos/sso/token_query.rb,
lib/workos/types/role_type.rb,
lib/workos/user_management.rb,
lib/workos/api_keys/api_key.rb,
lib/workos/types/base_model.rb,
lib/workos/types/radar_type.rb,
lib/workos/multi_factor_auth.rb,
lib/workos/types/list_struct.rb,
lib/workos/authorization/role.rb,
lib/workos/encryptors/aes_gcm.rb,
lib/workos/feature_flags/flag.rb,
lib/workos/types/api_response.rb,
lib/workos/types/events_order.rb,
lib/workos/types/radar_action.rb,
lib/workos/types/sso_provider.rb,
lib/workos/connect/user_object.rb,
lib/workos/events/event_schema.rb,
lib/workos/organization_domains.rb,
lib/workos/shared/event_context.rb,
lib/workos/shared/group_created.rb,
lib/workos/shared/group_deleted.rb,
lib/workos/shared/group_updated.rb,
lib/workos/types/directory_type.rb,
lib/workos/types/webhooks_order.rb,
lib/workos/user_management/user.rb,
lib/workos/vault/vault_dek_read.rb,
lib/workos/sso/connection_domain.rb,
lib/workos/sso/connection_option.rb,
lib/workos/types/connection_type.rb,
lib/workos/types/directory_state.rb,
lib/workos/types/request_options.rb,
lib/workos/vault/vault_data_read.rb,
lib/workos/api_keys/api_key_owner.rb,
lib/workos/sso/connection_deleted.rb,
lib/workos/sso/sso_token_response.rb,
lib/workos/types/audit_logs_order.rb,
lib/workos/types/connection_state.rb,
lib/workos/types/invitation_state.rb,
lib/workos/authorization/role_list.rb,
lib/workos/authorization/slim_role.rb,
lib/workos/pipes/connected_account.rb,
lib/workos/types/connection_status.rb,
lib/workos/types/connections_order.rb,
lib/workos/types/directories_order.rb,
lib/workos/types/permissions_order.rb,
lib/workos/types/user_invite_state.rb,
lib/workos/vault/vault_kek_created.rb,
lib/workos/api_keys/api_key_created.rb,
lib/workos/api_keys/api_key_revoked.rb,
lib/workos/authorization/permission.rb,
lib/workos/directory_sync/directory.rb,
lib/workos/feature_flags/flag_owner.rb,
lib/workos/sso/connection_activated.rb,
lib/workos/types/applications_order.rb,
lib/workos/vault/vault_data_created.rb,
lib/workos/vault/vault_data_deleted.rb,
lib/workos/vault/vault_data_updated.rb,
lib/workos/vault/vault_names_listed.rb,
lib/workos/api_keys/validate_api_key.rb,
lib/workos/authorization/assign_role.rb,
lib/workos/authorization/create_role.rb,
lib/workos/authorization/remove_role.rb,
lib/workos/authorization/update_role.rb,
lib/workos/shared/group_member_added.rb,
lib/workos/types/authorization_order.rb,
lib/workos/types/feature_flags_order.rb,
lib/workos/types/organizations_order.rb,
lib/workos/vault/vault_dek_decrypted.rb,
lib/workos/vault/vault_dek_read_data.rb,
lib/workos/vault/vault_metadata_read.rb,
lib/workos/webhooks/webhook_endpoint.rb,
lib/workos/admin_portal/generate_link.rb,
lib/workos/audit_logs/audit_log_event.rb,
lib/workos/authorization/role_created.rb,
lib/workos/authorization/role_deleted.rb,
lib/workos/authorization/role_updated.rb,
lib/workos/connect/redirect_uri_input.rb,
lib/workos/feature_flags/feature_flag.rb,
lib/workos/feature_flags/flag_created.rb,
lib/workos/feature_flags/flag_deleted.rb,
lib/workos/feature_flags/flag_updated.rb,
lib/workos/organizations/organization.rb,
lib/workos/shared/event_context_actor.rb,
lib/workos/sso/connection_deactivated.rb,
lib/workos/types/directory_user_state.rb,
lib/workos/types/generate_link_intent.rb,
lib/workos/types/user_sessions_status.rb,
lib/workos/user_management/invitation.rb,
lib/workos/user_management/magic_auth.rb,
lib/workos/vault/vault_data_read_data.rb,
lib/workos/admin_portal/intent_options.rb,
lib/workos/api_keys/api_key_with_value.rb,
lib/workos/audit_logs/audit_log_action.rb,
lib/workos/audit_logs/audit_log_export.rb,
lib/workos/audit_logs/audit_log_schema.rb,
lib/workos/connect/connect_application.rb,
lib/workos/connect/user_consent_option.rb,
lib/workos/shared/group_member_removed.rb,
lib/workos/sso/connection_deleted_data.rb,
lib/workos/types/directory_users_order.rb,
lib/workos/user_management/create_user.rb,
lib/workos/user_management/update_user.rb,
lib/workos/user_management/user_invite.rb,
lib/workos/directory_sync/dsync_deleted.rb,
lib/workos/types/audit_log_export_state.rb,
lib/workos/types/directory_groups_order.rb,
lib/workos/user_management/email_change.rb,
lib/workos/user_management/redirect_uri.rb,
lib/workos/user_management/user_created.rb,
lib/workos/user_management/user_deleted.rb,
lib/workos/user_management/user_updated.rb,
lib/workos/vault/vault_kek_created_data.rb,
lib/workos/widgets/widget_session_token.rb,
lib/workos/api_keys/api_key_created_data.rb,
lib/workos/api_keys/api_key_revoked_data.rb,
lib/workos/authorization/role_assignment.rb,
lib/workos/directory_sync/directory_user.rb,
lib/workos/sso/connection_activated_data.rb,
lib/workos/types/connected_account_state.rb,
lib/workos/types/dsync_deleted_data_type.rb,
lib/workos/types/profile_connection_type.rb,
lib/workos/types/webhook_endpoint_status.rb,
lib/workos/user_management/jwks_response.rb,
lib/workos/vault/vault_data_created_data.rb,
lib/workos/vault/vault_data_deleted_data.rb,
lib/workos/vault/vault_data_updated_data.rb,
lib/workos/vault/vault_names_listed_data.rb,
lib/workos/connect/create_m2m_application.rb,
lib/workos/directory_sync/directory_group.rb,
lib/workos/directory_sync/dsync_activated.rb,
lib/workos/shared/group_member_added_data.rb,
lib/workos/sso/sso_authorize_url_response.rb,
lib/workos/types/authorization_assignment.rb,
lib/workos/types/dsync_deleted_data_state.rb,
lib/workos/user_management/password_reset.rb,
lib/workos/user_management/revoke_session.rb,
lib/workos/vault/vault_dek_decrypted_data.rb,
lib/workos/vault/vault_metadata_read_data.rb,
lib/workos/webhooks/webhook_endpoint_json.rb,
lib/workos/admin_portal/sso_intent_options.rb,
lib/workos/authorization/role_created_data.rb,
lib/workos/authorization/role_deleted_data.rb,
lib/workos/authorization/role_updated_data.rb,
lib/workos/events/event_list_list_metadata.rb,
lib/workos/feature_flags/flag_created_data.rb,
lib/workos/feature_flags/flag_deleted_data.rb,
lib/workos/feature_flags/flag_rule_updated.rb,
lib/workos/feature_flags/flag_updated_data.rb,
lib/workos/radar/radar_standalone_response.rb,
lib/workos/sso/connection_deactivated_data.rb,
lib/workos/types/dsync_activated_data_type.rb,
lib/workos/types/organization_domain_state.rb,
lib/workos/types/user_sessions_auth_method.rb,
lib/workos/user_management/session_created.rb,
lib/workos/user_management/session_revoked.rb,
lib/workos/audit_logs/audit_log_action_json.rb,
lib/workos/audit_logs/audit_log_event_actor.rb,
lib/workos/audit_logs/audit_log_export_json.rb,
lib/workos/audit_logs/audit_log_schema_json.rb,
lib/workos/authorization/permission_created.rb,
lib/workos/authorization/permission_deleted.rb,
lib/workos/authorization/permission_updated.rb,
lib/workos/connect/create_oauth_application.rb,
lib/workos/connect/update_oauth_application.rb,
lib/workos/directory_sync/dsync_deactivated.rb,
lib/workos/feature_flags/feature_flag_owner.rb,
lib/workos/organizations/organization_input.rb,
lib/workos/shared/group_member_removed_data.rb,
lib/workos/sso/sso_logout_authorize_request.rb,
lib/workos/types/authentication_factor_type.rb,
lib/workos/types/dsync_activated_data_state.rb,
lib/workos/types/event_context_actor_source.rb,
lib/workos/webhooks/create_webhook_endpoint.rb,
lib/workos/webhooks/update_webhook_endpoint.rb,
lib/workos/admin_portal/portal_link_response.rb,
lib/workos/api_keys/api_key_with_value_owner.rb,
lib/workos/audit_logs/audit_log_event_target.rb,
lib/workos/audit_logs/audit_log_schema_actor.rb,
lib/workos/authorization/add_role_permission.rb,
lib/workos/authorization/authorization_check.rb,
lib/workos/authorization/check_authorization.rb,
lib/workos/connect/create_application_secret.rb,
lib/workos/directory_sync/directory_metadata.rb,
lib/workos/directory_sync/dsync_deleted_data.rb,
lib/workos/directory_sync/dsync_user_created.rb,
lib/workos/directory_sync/dsync_user_deleted.rb,
lib/workos/directory_sync/dsync_user_updated.rb,
lib/workos/organizations/update_organization.rb,
lib/workos/sso/sso_logout_authorize_response.rb,
lib/workos/types/audit_log_export_json_state.rb,
lib/workos/types/connections_connection_type.rb,
lib/workos/types/dsync_deactivated_data_type.rb,
lib/workos/types/session_created_data_status.rb,
lib/workos/types/session_revoked_data_status.rb,
lib/workos/types/user_management_users_order.rb,
lib/workos/types/widget_session_token_scopes.rb,
lib/workos/user_management/invitation_resent.rb,
lib/workos/user_management/send_email_change.rb,
lib/workos/audit_logs/audit_log_event_context.rb,
lib/workos/audit_logs/audit_log_schema_target.rb,
lib/workos/authorization/set_role_permissions.rb,
lib/workos/connect/user_consent_option_choice.rb,
lib/workos/directory_sync/dsync_group_created.rb,
lib/workos/directory_sync/dsync_group_deleted.rb,
lib/workos/directory_sync/dsync_group_updated.rb,
lib/workos/feature_flags/flag_created_context.rb,
lib/workos/feature_flags/flag_deleted_context.rb,
lib/workos/feature_flags/flag_updated_context.rb,
lib/workos/organizations/audit_logs_retention.rb,
lib/workos/organizations/organization_created.rb,
lib/workos/organizations/organization_deleted.rb,
lib/workos/organizations/organization_updated.rb,
lib/workos/sso/sso_token_response_oauth_token.rb,
lib/workos/types/dsync_deactivated_data_state.rb,
lib/workos/types/invitation_resent_data_state.rb,
lib/workos/types/organizations_api_keys_order.rb,
lib/workos/types/webhook_endpoint_json_status.rb,
lib/workos/user_management/create_cors_origin.rb,
lib/workos/user_management/email_verification.rb,
lib/workos/user_management/invitation_created.rb,
lib/workos/user_management/invitation_revoked.rb,
lib/workos/user_management/jwks_response_keys.rb,
lib/workos/user_management/magic_auth_created.rb,
lib/workos/api_keys/api_key_created_data_owner.rb,
lib/workos/api_keys/api_key_revoked_data_owner.rb,
lib/workos/directory_sync/directory_user_email.rb,
lib/workos/directory_sync/dsync_activated_data.rb,
lib/workos/types/audit_log_configuration_state.rb,
lib/workos/types/connection_deleted_data_state.rb,
lib/workos/types/dsync_user_updated_data_state.rb,
lib/workos/types/invitation_created_data_state.rb,
lib/workos/types/invitation_revoked_data_state.rb,
lib/workos/user_management/create_redirect_uri.rb,
lib/workos/user_management/invitation_accepted.rb,
lib/workos/user_management/update_jwt_template.rb,
lib/workos/api_keys/api_key_validation_response.rb,
lib/workos/api_keys/create_organization_api_key.rb,
lib/workos/audit_logs/audit_log_event_ingestion.rb,
lib/workos/audit_logs/audit_log_export_creation.rb,
lib/workos/authorization/authorization_resource.rb,
lib/workos/feature_flags/flag_rule_updated_data.rb,
lib/workos/sso/connection_activated_data_domain.rb,
lib/workos/types/create_user_password_hash_type.rb,
lib/workos/types/create_webhook_endpoint_events.rb,
lib/workos/types/invitation_accepted_data_state.rb,
lib/workos/types/organization_domain_data_state.rb,
lib/workos/types/organization_membership_status.rb,
lib/workos/types/update_user_password_hash_type.rb,
lib/workos/types/update_webhook_endpoint_events.rb,
lib/workos/types/update_webhook_endpoint_status.rb,
lib/workos/user_management/confirm_email_change.rb,
lib/workos/user_management/cors_origin_response.rb,
lib/workos/user_management/session_created_data.rb,
lib/workos/user_management/session_revoked_data.rb,
lib/workos/user_management/verify_email_address.rb,
lib/workos/authorization/permission_created_data.rb,
lib/workos/authorization/permission_deleted_data.rb,
lib/workos/authorization/permission_updated_data.rb,
lib/workos/connect/user_management_login_request.rb,
lib/workos/directory_sync/dsync_deactivated_data.rb,
lib/workos/directory_sync/dsync_group_user_added.rb,
lib/workos/feature_flags/flag_created_data_owner.rb,
lib/workos/feature_flags/flag_deleted_data_owner.rb,
lib/workos/feature_flags/flag_updated_data_owner.rb,
lib/workos/organizations/audit_log_configuration.rb,
lib/workos/pipes/data_integrations_list_response.rb,
lib/workos/radar/radar_standalone_assess_request.rb,
lib/workos/types/connection_activated_data_state.rb,
lib/workos/user_management/authenticate_response.rb,
lib/workos/user_management/create_password_reset.rb,
lib/workos/user_management/jwt_template_response.rb,
lib/workos/user_management/verify_email_response.rb,
lib/workos/widgets/widget_session_token_response.rb,
lib/workos/audit_logs/audit_log_schema_json_actor.rb,
lib/workos/authorization/authorization_permission.rb,
lib/workos/authorization/create_organization_role.rb,
lib/workos/authorization/role_assignment_resource.rb,
lib/workos/authorization/update_organization_role.rb,
lib/workos/connect/new_connect_application_secret.rb,
lib/workos/directory_sync/directory_metadata_user.rb,
lib/workos/directory_sync/dsync_user_updated_data.rb,
lib/workos/organizations/organization_domain_data.rb,
lib/workos/sso/connection_deactivated_data_domain.rb,
lib/workos/types/connection_activated_data_status.rb,
lib/workos/types/directory_user_with_groups_state.rb,
lib/workos/types/session_created_data_auth_method.rb,
lib/workos/types/session_revoked_data_auth_method.rb,
lib/workos/types/vault_dek_read_data_actor_source.rb,
lib/workos/user_management/invitation_resent_data.rb,
lib/workos/user_management/password_reset_created.rb,
lib/workos/audit_logs/audit_log_schema_json_target.rb,
lib/workos/connect/external_auth_complete_response.rb,
lib/workos/directory_sync/dsync_group_updated_data.rb,
lib/workos/directory_sync/dsync_group_user_removed.rb,
lib/workos/feature_flags/flag_rule_updated_context.rb,
lib/workos/multi_factor_auth/authentication_factor.rb,
lib/workos/organizations/audit_logs_retention_json.rb,
lib/workos/organizations/organization_created_data.rb,
lib/workos/organizations/organization_deleted_data.rb,
lib/workos/organizations/organization_role_created.rb,
lib/workos/organizations/organization_role_deleted.rb,
lib/workos/organizations/organization_role_updated.rb,
lib/workos/organizations/organization_updated_data.rb,
lib/workos/sso/connection_saml_certificate_renewed.rb,
lib/workos/types/connection_deactivated_data_state.rb,
lib/workos/types/create_user_invite_options_locale.rb,
lib/workos/types/flag_created_context_actor_source.rb,
lib/workos/types/flag_deleted_context_actor_source.rb,
lib/workos/types/flag_updated_context_actor_source.rb,
lib/workos/types/organizations_feature_flags_order.rb,
lib/workos/types/radar_standalone_response_control.rb,
lib/workos/types/radar_standalone_response_verdict.rb,
lib/workos/types/resend_user_invite_options_locale.rb,
lib/workos/types/user_identities_get_item_provider.rb,
lib/workos/types/user_management_invitations_order.rb,
lib/workos/types/vault_data_read_data_actor_source.rb,
lib/workos/user_management/invitation_created_data.rb,
lib/workos/user_management/invitation_revoked_data.rb,
lib/workos/user_management/magic_auth_created_data.rb,
lib/workos/user_management/organization_membership.rb,
lib/workos/user_management/reset_password_response.rb,
lib/workos/user_management/user_sessions_list_item.rb,
lib/workos/feature_flags/flag_created_context_actor.rb,
lib/workos/feature_flags/flag_deleted_context_actor.rb,
lib/workos/feature_flags/flag_updated_context_actor.rb,
lib/workos/organization_domains/organization_domain.rb,
lib/workos/types/connection_deactivated_data_status.rb,
lib/workos/user_management/invitation_accepted_data.rb,
lib/workos/user_management/password_reset_succeeded.rb,
lib/workos/user_management/user_identities_get_item.rb,
lib/workos/connect/application_credentials_list_item.rb,
lib/workos/directory_sync/directory_user_with_groups.rb,
lib/workos/organizations/update_audit_logs_retention.rb,
lib/workos/types/authentication_factor_enrolled_type.rb,
lib/workos/types/user_organization_membership_status.rb,
lib/workos/types/vault_kek_created_data_actor_source.rb,
lib/workos/user_management/authentication_mfa_failed.rb,
lib/workos/user_management/authentication_sso_failed.rb,
lib/workos/user_management/email_change_confirmation.rb,
lib/workos/audit_logs/audit_log_event_create_response.rb,
lib/workos/directory_sync/dsync_activated_data_domain.rb,
lib/workos/directory_sync/dsync_group_user_added_data.rb,
lib/workos/feature_flags/flag_rule_updated_data_owner.rb,
lib/workos/multi_factor_auth/authentication_challenge.rb,
lib/workos/pipes/data_integrations_list_response_data.rb,
lib/workos/types/vault_data_created_data_actor_source.rb,
lib/workos/types/vault_data_deleted_data_actor_source.rb,
lib/workos/types/vault_data_updated_data_actor_source.rb,
lib/workos/types/vault_names_listed_data_actor_source.rb,
lib/workos/user_management/authentication_sso_started.rb,
lib/workos/user_management/create_user_invite_options.rb,
lib/workos/user_management/email_verification_created.rb,
lib/workos/user_management/resend_user_invite_options.rb,
lib/workos/user_management/user_sessions_impersonator.rb,
lib/workos/authorization/create_authorization_resource.rb,
lib/workos/authorization/update_authorization_resource.rb,
lib/workos/multi_factor_auth/authentication_factor_sms.rb,
lib/workos/types/flag_rule_updated_context_access_type.rb,
lib/workos/types/organization_domain_stand_alone_state.rb,
lib/workos/types/vault_dek_decrypted_data_actor_source.rb,
lib/workos/types/vault_metadata_read_data_actor_source.rb,
lib/workos/user_management/authentication_oauth_failed.rb,
lib/workos/user_management/create_password_reset_token.rb,
lib/workos/user_management/password_reset_created_data.rb,
lib/workos/vault/vault_byok_key_verification_completed.rb,
lib/workos/directory_sync/dsync_deactivated_data_domain.rb,
lib/workos/directory_sync/dsync_group_user_removed_data.rb,
lib/workos/directory_sync/dsync_user_updated_data_email.rb,
lib/workos/multi_factor_auth/authentication_factor_totp.rb,
lib/workos/organizations/organization_role_created_data.rb,
lib/workos/organizations/organization_role_deleted_data.rb,
lib/workos/organizations/organization_role_updated_data.rb,
lib/workos/pipes/data_integration_access_token_response.rb,
lib/workos/sso/connection_saml_certificate_renewed_data.rb,
lib/workos/types/flag_rule_updated_context_actor_source.rb,
lib/workos/types/organization_created_data_domain_state.rb,
lib/workos/types/organization_deleted_data_domain_state.rb,
lib/workos/types/organization_domain_created_data_state.rb,
lib/workos/types/organization_domain_deleted_data_state.rb,
lib/workos/types/organization_domain_updated_data_state.rb,
lib/workos/types/organization_updated_data_domain_state.rb,
lib/workos/types/radar_standalone_assess_request_action.rb,
lib/workos/user_management/action_authentication_denied.rb,
lib/workos/user_management/authentication_mfa_succeeded.rb,
lib/workos/user_management/authentication_sso_succeeded.rb,
lib/workos/user_management/authentication_sso_timed_out.rb,
lib/workos/user_management/create_magic_code_and_return.rb,
lib/workos/user_management/user_organization_membership.rb,
lib/workos/authorization/create_authorization_permission.rb,
lib/workos/authorization/update_authorization_permission.rb,
lib/workos/feature_flags/flag_rule_updated_context_actor.rb,
lib/workos/organizations/organization_membership_created.rb,
lib/workos/organizations/organization_membership_deleted.rb,
lib/workos/organizations/organization_membership_updated.rb,
lib/workos/pipes/data_integration_authorize_url_response.rb,
lib/workos/shared/event_context_google_analytics_session.rb,
lib/workos/types/audit_log_configuration_log_stream_type.rb,
lib/workos/types/connection_deleted_data_connection_type.rb,
lib/workos/types/organization_domain_verified_data_state.rb,
lib/workos/types/user_management_authentication_provider.rb,
lib/workos/user_management/authentication_passkey_failed.rb,
lib/workos/user_management/device_authorization_response.rb,
lib/workos/user_management/password_reset_succeeded_data.rb,
lib/workos/organizations/organization_created_data_domain.rb,
lib/workos/organizations/organization_deleted_data_domain.rb,
lib/workos/organizations/organization_updated_data_domain.rb,
lib/workos/pipes/data_integrations_get_user_token_request.rb,
lib/workos/types/audit_log_configuration_log_stream_state.rb,
lib/workos/types/radar_standalone_response_blocklist_type.rb,
lib/workos/user_management/authentication_mfa_failed_data.rb,
lib/workos/user_management/authentication_oauth_succeeded.rb,
lib/workos/user_management/authentication_password_failed.rb,
lib/workos/user_management/authentication_sso_failed_data.rb,
lib/workos/user_management/email_change_confirmation_user.rb,
lib/workos/directory_sync/directory_user_with_groups_email.rb,
lib/workos/organization_domains/create_organization_domain.rb,
lib/workos/radar/radar_list_entry_already_present_response.rb,
lib/workos/types/connection_activated_data_connection_type.rb,
lib/workos/types/organization_domain_verification_strategy.rb,
lib/workos/types/user_management_users_feature_flags_order.rb,
lib/workos/user_management/action_user_registration_denied.rb,
lib/workos/user_management/authentication_sso_started_data.rb,
lib/workos/user_management/email_verification_created_data.rb,
lib/workos/multi_factor_auth/authentication_factor_enrolled.rb,
lib/workos/organization_domains/organization_domain_created.rb,
lib/workos/organization_domains/organization_domain_deleted.rb,
lib/workos/organization_domains/organization_domain_updated.rb,
lib/workos/organizations/audit_log_configuration_log_stream.rb,
lib/workos/radar/radar_standalone_update_radar_list_request.rb,
lib/workos/sso/connection_saml_certificate_renewal_required.rb,
lib/workos/types/authentication_factors_create_request_type.rb,
lib/workos/types/user_management_authentication_screen_hint.rb,
lib/workos/user_management/authentication_magic_auth_failed.rb,
lib/workos/user_management/authentication_oauth_failed_data.rb,
lib/workos/user_management/authentication_passkey_succeeded.rb,
lib/workos/user_management/send_verification_email_response.rb,
lib/workos/user_management/sso_device_authorization_request.rb,
lib/workos/vault/vault_byok_key_verification_completed_data.rb,
lib/workos/multi_factor_auth/challenge_authentication_factor.rb,
lib/workos/organization_domains/organization_domain_verified.rb,
lib/workos/types/authenticate_response_authentication_method.rb,
lib/workos/types/connection_deactivated_data_connection_type.rb,
lib/workos/types/organization_membership_created_data_status.rb,
lib/workos/types/organization_membership_deleted_data_status.rb,
lib/workos/types/organization_membership_updated_data_status.rb,
lib/workos/types/radar_standalone_assess_request_auth_method.rb,
lib/workos/user_management/action_authentication_denied_data.rb,
lib/workos/user_management/authenticate_response_oauth_token.rb,
lib/workos/user_management/authentication_mfa_succeeded_data.rb,
lib/workos/user_management/authentication_password_succeeded.rb,
lib/workos/user_management/authentication_sso_succeeded_data.rb,
lib/workos/user_management/authentication_sso_timed_out_data.rb,
lib/workos/user_management/session_created_data_impersonator.rb,
lib/workos/user_management/session_revoked_data_impersonator.rb,
lib/workos/organizations/organization_membership_created_data.rb,
lib/workos/organizations/organization_membership_deleted_data.rb,
lib/workos/organizations/organization_membership_updated_data.rb,
lib/workos/types/data_integration_access_token_response_error.rb,
lib/workos/user_management/authenticate_response_impersonator.rb,
lib/workos/user_management/authentication_passkey_failed_data.rb,
lib/workos/user_management/authentication_radar_risk_detected.rb,
lib/workos/user_management/authentication_sso_failed_data_sso.rb,
lib/workos/multi_factor_auth/enroll_user_authentication_factor.rb,
lib/workos/radar/radar_standalone_update_radar_attempt_request.rb,
lib/workos/types/user_management_organization_membership_order.rb,
lib/workos/user_management/authentication_magic_auth_succeeded.rb,
lib/workos/user_management/authentication_oauth_succeeded_data.rb,
lib/workos/user_management/authentication_password_failed_data.rb,
lib/workos/user_management/authentication_sso_started_data_sso.rb,
lib/workos/user_management/create_user_organization_membership.rb,
lib/workos/user_management/update_user_organization_membership.rb,
lib/workos/multi_factor_auth/authentication_factor_enrolled_sms.rb,
lib/workos/organization_domains/organization_domain_stand_alone.rb,
lib/workos/types/authentication_radar_risk_detected_data_action.rb,
lib/workos/types/data_integrations_list_response_data_ownership.rb,
lib/workos/user_management/action_user_registration_denied_data.rb,
lib/workos/user_management/authentication_mfa_failed_data_error.rb,
lib/workos/user_management/authentication_sso_failed_data_error.rb,
lib/workos/feature_flags/flag_updated_context_previous_attribute.rb,
lib/workos/multi_factor_auth/authentication_factor_enrolled_totp.rb,
lib/workos/organization_domains/organization_domain_created_data.rb,
lib/workos/organization_domains/organization_domain_deleted_data.rb,
lib/workos/organization_domains/organization_domain_updated_data.rb,
lib/workos/sso/connection_saml_certificate_renewal_required_data.rb,
lib/workos/user_management/authentication_magic_auth_failed_data.rb,
lib/workos/user_management/authentication_passkey_succeeded_data.rb,
lib/workos/user_management/authentication_sso_succeeded_data_sso.rb,
lib/workos/user_management/authentication_sso_timed_out_data_sso.rb,
lib/workos/user_management/mfa_totp_session_authenticate_request.rb,
lib/workos/user_management/password_session_authenticate_request.rb,
lib/workos/organization_domains/organization_domain_verified_data.rb,
lib/workos/radar/radar_standalone_delete_radar_list_entry_request.rb,
lib/workos/types/user_management_organization_membership_statuses.rb,
lib/workos/user_management/authentication_oauth_failed_data_error.rb,
lib/workos/user_management/authentication_password_succeeded_data.rb,
lib/workos/multi_factor_auth/authentication_factors_create_request.rb,
lib/workos/sso/connection_saml_certificate_renewed_data_connection.rb,
lib/workos/types/user_management_multi_factor_authentication_order.rb,
lib/workos/user_management/authentication_radar_risk_detected_data.rb,
lib/workos/user_management/authentication_sso_timed_out_data_error.rb,
lib/workos/sso/connection_saml_certificate_renewed_data_certificate.rb,
lib/workos/types/user_organization_membership_base_list_data_status.rb,
lib/workos/user_management/authentication_email_verification_failed.rb,
lib/workos/user_management/authentication_magic_auth_succeeded_data.rb,
lib/workos/user_management/authentication_passkey_failed_data_error.rb,
lib/workos/user_management/authorized_connect_application_list_data.rb,
lib/workos/user_management/device_code_session_authenticate_request.rb,
lib/workos/authorization/user_organization_membership_base_list_data.rb,
lib/workos/feature_flags/flag_rule_updated_context_configured_target.rb,
lib/workos/pipes/data_integration_access_token_response_access_token.rb,
lib/workos/types/organization_domain_verification_failed_data_reason.rb,
lib/workos/types/user_management_users_authorized_applications_order.rb,
lib/workos/user_management/authentication_password_failed_data_error.rb,
lib/workos/feature_flags/flag_rule_updated_context_previous_attribute.rb,
lib/workos/feature_flags/flag_updated_context_previous_attribute_data.rb,
lib/workos/multi_factor_auth/authentication_challenge_verify_response.rb,
lib/workos/multi_factor_auth/authentication_challenges_verify_request.rb,
lib/workos/user_management/refresh_token_session_authenticate_request.rb,
lib/workos/types/organization_domain_stand_alone_verification_strategy.rb,
lib/workos/user_management/authentication_email_verification_succeeded.rb,
lib/workos/user_management/authentication_magic_auth_failed_data_error.rb,
lib/workos/multi_factor_auth/user_authentication_factor_enroll_response.rb,
lib/workos/organization_domains/organization_domain_verification_failed.rb,
lib/workos/pipes/data_integrations_list_response_data_connected_account.rb,
lib/workos/types/organization_created_data_domain_verification_strategy.rb,
lib/workos/types/organization_deleted_data_domain_verification_strategy.rb,
lib/workos/types/organization_domain_created_data_verification_strategy.rb,
lib/workos/types/organization_domain_deleted_data_verification_strategy.rb,
lib/workos/types/organization_domain_updated_data_verification_strategy.rb,
lib/workos/types/organization_updated_data_domain_verification_strategy.rb,
lib/workos/user_management/magic_auth_code_session_authenticate_request.rb,
lib/workos/types/organization_domain_verified_data_verification_strategy.rb,
lib/workos/types/vault_byok_key_verification_completed_data_key_provider.rb,
lib/workos/user_management/authentication_email_verification_failed_data.rb,
lib/workos/feature_flags/flag_rule_updated_context_configured_target_user.rb,
lib/workos/feature_flags/flag_rule_updated_context_previous_attribute_data.rb,
lib/workos/user_management/authorization_code_session_authenticate_request.rb,
lib/workos/sso/connection_saml_certificate_renewal_required_data_connection.rb,
lib/workos/user_management/authentication_email_verification_succeeded_data.rb,
lib/workos/organization_domains/organization_domain_verification_failed_data.rb,
lib/workos/sso/connection_saml_certificate_renewal_required_data_certificate.rb,
lib/workos/feature_flags/flag_rule_updated_context_previous_attribute_context.rb,
lib/workos/pipes/data_integrations_get_data_integration_authorize_url_request.rb,
lib/workos/types/data_integrations_list_response_data_connected_account_state.rb,
lib/workos/user_management/authentication_email_verification_failed_data_error.rb,
lib/workos/user_management/organization_selection_session_authenticate_request.rb,
lib/workos/user_management/email_verification_code_session_authenticate_request.rb,
lib/workos/feature_flags/flag_rule_updated_context_configured_target_organization.rb,
lib/workos/types/flag_rule_updated_context_previous_attribute_context_access_type.rb,
lib/workos/types/connection_saml_certificate_renewed_data_certificate_certificate_type.rb,
lib/workos/types/organization_domain_verification_failed_data_organization_domain_state.rb,
lib/workos/user_management/urn_workos_oauth_grant_type_mfa_totp_session_authenticate_request.rb,
lib/workos/feature_flags/flag_rule_updated_context_previous_attribute_context_configured_target.rb,
lib/workos/types/connection_saml_certificate_renewal_required_data_certificate_certificate_type.rb,
lib/workos/organization_domains/organization_domain_verification_failed_data_organization_domain.rb,
lib/workos/user_management/urn_workos_oauth_grant_type_magic_auth_code_session_authenticate_request.rb,
lib/workos/feature_flags/flag_rule_updated_context_previous_attribute_context_configured_target_user.rb,
lib/workos/user_management/urn_ietf_params_oauth_grant_type_device_code_session_authenticate_request.rb,
lib/workos/types/organization_domain_verification_failed_data_organization_domain_verification_strategy.rb,
lib/workos/user_management/urn_workos_oauth_grant_type_organization_selection_session_authenticate_request.rb,
lib/workos/user_management/urn_workos_oauth_grant_type_email_verification_code_session_authenticate_request.rb,
lib/workos/feature_flags/flag_rule_updated_context_previous_attribute_context_configured_target_organization.rb

Overview

This file is auto-generated by oagen. Do not edit.

Defined Under Namespace

Modules: Actions, Encryptors, HashProvider, PKCE, PublicClient, Types, Util Classes: APIConnectionError, APIError, ActionAuthenticationDenied, ActionAuthenticationDeniedData, ActionUserRegistrationDenied, ActionUserRegistrationDeniedData, AddRolePermission, AdminPortal, ApiKey, ApiKeyCreated, ApiKeyCreatedData, ApiKeyCreatedDataOwner, ApiKeyRevoked, ApiKeyValidationResponse, ApiKeyWithValue, ApiKeys, ApplicationCredentialsListItem, AssignRole, AuditLogAction, AuditLogActionJson, AuditLogConfiguration, AuditLogConfigurationLogStream, AuditLogEvent, AuditLogEventActor, AuditLogEventContext, AuditLogEventCreateResponse, AuditLogEventIngestion, AuditLogExport, AuditLogExportCreation, AuditLogExportJson, AuditLogSchema, AuditLogSchemaActor, AuditLogSchemaJson, AuditLogSchemaJsonTarget, AuditLogs, AuditLogsRetention, AuditLogsRetentionJson, AuthenticateResponse, AuthenticateResponseImpersonator, AuthenticateResponseOAuthToken, AuthenticationChallenge, AuthenticationChallengeVerifyResponse, AuthenticationChallengesVerifyRequest, AuthenticationEmailVerificationFailed, AuthenticationEmailVerificationFailedData, AuthenticationEmailVerificationFailedDataError, AuthenticationEmailVerificationSucceeded, AuthenticationEmailVerificationSucceededData, AuthenticationError, AuthenticationFactor, AuthenticationFactorEnrolled, AuthenticationFactorEnrolledSms, AuthenticationFactorEnrolledTotp, AuthenticationFactorTotp, AuthenticationFactorsCreateRequest, AuthenticationMFAFailed, AuthenticationMFAFailedData, AuthenticationMFASucceeded, AuthenticationMFASucceededData, AuthenticationMagicAuthFailed, AuthenticationMagicAuthFailedData, AuthenticationMagicAuthSucceeded, AuthenticationMagicAuthSucceededData, AuthenticationOAuthFailed, AuthenticationOAuthFailedData, AuthenticationOAuthSucceeded, AuthenticationOAuthSucceededData, AuthenticationPasskeyFailed, AuthenticationPasskeyFailedData, AuthenticationPasskeySucceeded, AuthenticationPasskeySucceededData, AuthenticationPasswordFailed, AuthenticationPasswordFailedData, AuthenticationPasswordSucceeded, AuthenticationPasswordSucceededData, AuthenticationRadarRiskDetected, AuthenticationRadarRiskDetectedData, AuthenticationSSOFailed, AuthenticationSSOFailedData, AuthenticationSSOFailedDataSSO, AuthenticationSSOStarted, AuthenticationSSOStartedData, AuthenticationSSOSucceeded, AuthenticationSSOSucceededData, AuthenticationSSOTimedOut, AuthenticationSSOTimedOutData, Authorization, AuthorizationCheck, AuthorizationCodeSessionAuthenticateRequest, AuthorizationPermission, AuthorizationResource, AuthorizedConnectApplicationListData, BaseClient, CORSOriginResponse, ChallengeAuthenticationFactor, CheckAuthorization, Client, Configuration, Connect, ConnectApplication, ConnectedAccount, Connection, ConnectionActivated, ConnectionActivatedData, ConnectionActivatedDataDomain, ConnectionDeactivated, ConnectionDeactivatedData, ConnectionDeleted, ConnectionDeletedData, ConnectionOption, ConnectionSAMLCertificateRenewalRequired, ConnectionSAMLCertificateRenewalRequiredData, ConnectionSAMLCertificateRenewalRequiredDataCertificate, ConnectionSAMLCertificateRenewalRequiredDataConnection, ConnectionSAMLCertificateRenewed, ConnectionSAMLCertificateRenewedData, ConnectionSAMLCertificateRenewedDataCertificate, CreateApplicationSecret, CreateAuthorizationPermission, CreateAuthorizationResource, CreateCORSOrigin, CreateM2MApplication, CreateMagicCodeAndReturn, CreateOAuthApplication, CreateOrganizationApiKey, CreateOrganizationDomain, CreateOrganizationRole, CreatePasswordReset, CreatePasswordResetToken, CreateRedirectUri, CreateUser, CreateUserInviteOptions, CreateUserOrganizationMembership, CreateWebhookEndpoint, DataIntegrationAccessTokenResponse, DataIntegrationAccessTokenResponseAccessToken, DataIntegrationAuthorizeUrlResponse, DataIntegrationsGetDataIntegrationAuthorizeUrlRequest, DataIntegrationsGetUserTokenRequest, DataIntegrationsListResponse, DataIntegrationsListResponseData, DataIntegrationsListResponseDataConnectedAccount, DeviceAuthorizationResponse, DeviceCodeSessionAuthenticateRequest, Directory, DirectoryGroup, DirectoryMetadata, DirectoryMetadataUser, DirectorySync, DirectoryUser, DirectoryUserEmail, DirectoryUserWithGroups, DsyncActivated, DsyncActivatedData, DsyncActivatedDataDomain, DsyncDeactivated, DsyncDeactivatedData, DsyncDeleted, DsyncDeletedData, DsyncGroupCreated, DsyncGroupDeleted, DsyncGroupUpdated, DsyncGroupUpdatedData, DsyncGroupUserAdded, DsyncGroupUserAddedData, DsyncGroupUserRemoved, DsyncUserCreated, DsyncUserDeleted, DsyncUserUpdated, DsyncUserUpdatedData, EmailChange, EmailChangeConfirmation, EmailChangeConfirmationUser, EmailVerification, EmailVerificationCodeSessionAuthenticateRequest, EmailVerificationCreated, EmailVerificationCreatedData, EnrollUserAuthenticationFactor, Error, EventContext, EventContextActor, EventContextGoogleAnalyticsSession, EventListListMetadata, EventSchema, Events, ExternalAuthCompleteResponse, FeatureFlag, FeatureFlagOwner, FeatureFlags, FlagCreated, FlagCreatedContext, FlagCreatedContextActor, FlagCreatedData, FlagDeleted, FlagDeletedContext, FlagDeletedContextActor, FlagRuleUpdated, FlagRuleUpdatedContext, FlagRuleUpdatedContextActor, FlagRuleUpdatedContextConfiguredTarget, FlagRuleUpdatedContextConfiguredTargetOrganization, FlagRuleUpdatedContextConfiguredTargetUser, FlagRuleUpdatedContextPreviousAttribute, FlagRuleUpdatedContextPreviousAttributeContext, FlagRuleUpdatedContextPreviousAttributeData, FlagUpdated, FlagUpdatedContext, FlagUpdatedContextActor, FlagUpdatedContextPreviousAttribute, FlagUpdatedContextPreviousAttributeData, ForbiddenRequestError, GenerateLink, Group, GroupCreated, GroupDeleted, GroupMemberAdded, GroupMemberAddedData, GroupMemberRemoved, GroupUpdated, IdempotencyError, IntentOptions, InvalidRequestError, Invitation, InvitationAccepted, InvitationAcceptedData, InvitationCreated, InvitationCreatedData, InvitationResent, InvitationResentData, InvitationRevoked, InvitationRevokedData, JWTTemplateResponse, JwksResponse, JwksResponseKeys, MFATotpSessionAuthenticateRequest, MagicAuth, MagicAuthCodeSessionAuthenticateRequest, MagicAuthCreated, MagicAuthCreatedData, MultiFactorAuth, NewConnectApplicationSecret, NotFoundError, Organization, OrganizationCreated, OrganizationCreatedData, OrganizationCreatedDataDomain, OrganizationDeleted, OrganizationDeletedData, OrganizationDeletedDataDomain, OrganizationDomain, OrganizationDomainCreated, OrganizationDomainCreatedData, OrganizationDomainData, OrganizationDomainDeleted, OrganizationDomainDeletedData, OrganizationDomainStandAlone, OrganizationDomainUpdated, OrganizationDomainUpdatedData, OrganizationDomainVerificationFailed, OrganizationDomainVerificationFailedData, OrganizationDomainVerificationFailedDataOrganizationDomain, OrganizationDomainVerified, OrganizationDomainVerifiedData, OrganizationDomains, OrganizationInput, OrganizationMembership, OrganizationMembershipCreated, OrganizationMembershipCreatedData, OrganizationMembershipDeleted, OrganizationMembershipDeletedData, OrganizationMembershipUpdated, OrganizationMembershipUpdatedData, OrganizationRoleCreated, OrganizationRoleCreatedData, OrganizationRoleDeleted, OrganizationRoleUpdated, OrganizationSelectionSessionAuthenticateRequest, OrganizationUpdated, OrganizationUpdatedData, OrganizationUpdatedDataDomain, Organizations, PasswordReset, PasswordResetCreated, PasswordResetCreatedData, PasswordResetSucceeded, PasswordSessionAuthenticateRequest, Passwordless, PermissionCreated, PermissionCreatedData, PermissionDeleted, PermissionUpdated, Pipes, PortalLinkResponse, Profile, Radar, RadarListEntryAlreadyPresentResponse, RadarStandaloneAssessRequest, RadarStandaloneDeleteRadarListEntryRequest, RadarStandaloneResponse, RadarStandaloneUpdateRadarAttemptRequest, RateLimitExceededError, RedirectUri, RedirectUriInput, RefreshTokenSessionAuthenticateRequest, ResendUserInviteOptions, ResetPasswordResponse, RevokeSession, Role, RoleAssignment, RoleAssignmentResource, RoleCreated, RoleCreatedData, RoleDeleted, RoleList, RoleUpdated, SSO, SSOAuthorizeUrlResponse, SSODeviceAuthorizationRequest, SSOIntentOptions, SSOLogoutAuthorizeRequest, SSOLogoutAuthorizeResponse, SSOTokenResponse, SendEmailChange, Session, SessionCreated, SessionCreatedData, SessionManager, SessionRevoked, SessionRevokedData, SetRolePermissions, SignatureVerificationError, TokenQuery, UnprocessableEntityError, UpdateAuditLogsRetention, UpdateAuthorizationPermission, UpdateAuthorizationResource, UpdateJWTTemplate, UpdateOAuthApplication, UpdateOrganization, UpdateUser, UpdateUserOrganizationMembership, UpdateWebhookEndpoint, UserAuthenticationFactorEnrollResponse, UserConsentOption, UserConsentOptionChoice, UserCreated, UserDeleted, UserIdentitiesGetItem, UserInvite, UserManagement, UserManagementLoginRequest, UserObject, UserOrganizationMembership, UserOrganizationMembershipBaseListData, UserSessionsListItem, UserUpdated, ValidateApiKey, Vault, VaultByokKeyVerificationCompleted, VaultByokKeyVerificationCompletedData, VaultDataCreated, VaultDataCreatedData, VaultDataDeleted, VaultDataDeletedData, VaultDataRead, VaultDataReadData, VaultDataUpdated, VaultDataUpdatedData, VaultDekDecrypted, VaultDekDecryptedData, VaultDekRead, VaultDekReadData, VaultKekCreated, VaultKekCreatedData, VaultMetadataRead, VaultMetadataReadData, VaultNamesListed, VaultNamesListedData, WebhookEndpoint, WebhookEndpointJson, WebhookEvent, Webhooks, WidgetSessionToken, WidgetSessionTokenResponse, Widgets

Constant Summary

VERSION =

"7.0.0"

Flag =

FeatureFlag

User =

EmailChangeConfirmationUser

ConnectionDomain =

ConnectionActivatedDataDomain

ApiKeyOwner =

ApiKeyCreatedDataOwner

SlimRole =

AddRolePermission

Permission =

AuthorizationPermission

FlagOwner =

FeatureFlagOwner

CreateRole =

CreateAuthorizationPermission

RemoveRole =

AssignRole

UpdateRole =

UpdateAuthorizationPermission

ApiKeyRevokedData =

ApiKeyCreatedData

RoleDeletedData =

RoleCreatedData

RoleUpdatedData =

RoleCreatedData

FlagDeletedData =

FlagCreatedData

FlagUpdatedData =

FlagCreatedData

GroupMemberRemovedData =

GroupMemberAddedData

ApiKeyWithValueOwner =

ApiKeyCreatedDataOwner

AuditLogEventTarget =

AuditLogEventActor

AuditLogSchemaTarget =

AuditLogSchemaJsonTarget

SSOTokenResponseOAuthToken =

AuthenticateResponseOAuthToken

ApiKeyRevokedDataOwner =

ApiKeyCreatedDataOwner

FlagRuleUpdatedData =

FlagCreatedData

ConfirmEmailChange =

AuthenticationChallengesVerifyRequest

VerifyEmailAddress =

AuthenticationChallengesVerifyRequest

PermissionDeletedData =

PermissionCreatedData

PermissionUpdatedData =

PermissionCreatedData

FlagCreatedDataOwner =

FeatureFlagOwner

FlagDeletedDataOwner =

FeatureFlagOwner

FlagUpdatedDataOwner =

FeatureFlagOwner

VerifyEmailResponse =

ResetPasswordResponse

AuditLogSchemaJsonActor =

AuditLogSchemaActor

UpdateOrganizationRole =

UpdateAuthorizationPermission

ConnectionDeactivatedDataDomain =

ConnectionActivatedDataDomain

FlagRuleUpdatedDataOwner =

FeatureFlagOwner

UserSessionsImpersonator =

AuthenticateResponseImpersonator

AuthenticationFactorSms =

AuthenticationFactorEnrolledSms

DsyncDeactivatedDataDomain =

DsyncActivatedDataDomain

DsyncGroupUserRemovedData =

DsyncGroupUserAddedData

DsyncUserUpdatedDataEmail =

DirectoryUserEmail

OrganizationRoleDeletedData =

OrganizationRoleCreatedData

OrganizationRoleUpdatedData =

OrganizationRoleCreatedData

PasswordResetSucceededData =

PasswordResetCreatedData

DirectoryUserWithGroupsEmail =

DirectoryUserEmail

RadarStandaloneUpdateRadarListRequest =

RadarStandaloneDeleteRadarListEntryRequest

SendVerificationEmailResponse =

ResetPasswordResponse

SessionCreatedDataImpersonator =

AuthenticateResponseImpersonator

SessionRevokedDataImpersonator =

AuthenticateResponseImpersonator

AuthenticationSSOStartedDataSSO =

AuthenticationSSOFailedDataSSO

AuthenticationMFAFailedDataError =

AuthenticationEmailVerificationFailedDataError

AuthenticationSSOFailedDataError =

AuthenticationEmailVerificationFailedDataError

AuthenticationSSOSucceededDataSSO =

AuthenticationSSOFailedDataSSO

AuthenticationSSOTimedOutDataSSO =

AuthenticationSSOFailedDataSSO

AuthenticationOAuthFailedDataError =

AuthenticationEmailVerificationFailedDataError

ConnectionSAMLCertificateRenewedDataConnection =

ConnectionSAMLCertificateRenewalRequiredDataConnection

AuthenticationSSOTimedOutDataError =

AuthenticationEmailVerificationFailedDataError

AuthenticationPasskeyFailedDataError =

AuthenticationEmailVerificationFailedDataError

AuthenticationPasswordFailedDataError =

AuthenticationEmailVerificationFailedDataError

AuthenticationMagicAuthFailedDataError =

AuthenticationEmailVerificationFailedDataError

UrnWorkosOAuthGrantTypeMfaTotpSessionAuthenticateRequest =

Deprecated.

Use WorkOS::MFATotpSessionAuthenticateRequest instead.

MFATotpSessionAuthenticateRequest

FlagRuleUpdatedContextPreviousAttributeContextConfiguredTarget =

FlagRuleUpdatedContextConfiguredTarget

UrnWorkosOAuthGrantTypeMagicAuthCodeSessionAuthenticateRequest =

Deprecated.

Use WorkOS::MagicAuthCodeSessionAuthenticateRequest instead.

MagicAuthCodeSessionAuthenticateRequest

FlagRuleUpdatedContextPreviousAttributeContextConfiguredTargetUser =

FlagRuleUpdatedContextConfiguredTargetUser

UrnIetfParamsOAuthGrantTypeDeviceCodeSessionAuthenticateRequest =

Deprecated.

Use WorkOS::DeviceCodeSessionAuthenticateRequest instead.

DeviceCodeSessionAuthenticateRequest

UrnWorkosOAuthGrantTypeOrganizationSelectionSessionAuthenticateRequest =

Deprecated.

Use WorkOS::OrganizationSelectionSessionAuthenticateRequest instead.

OrganizationSelectionSessionAuthenticateRequest

UrnWorkosOAuthGrantTypeEmailVerificationCodeSessionAuthenticateRequest =

Deprecated.

Use WorkOS::EmailVerificationCodeSessionAuthenticateRequest instead.

EmailVerificationCodeSessionAuthenticateRequest

FlagRuleUpdatedContextPreviousAttributeContextConfiguredTargetOrganization =

FlagRuleUpdatedContextConfiguredTargetOrganization

Class Method Summary

• .client ⇒ Object

  A convenience client built from the global configuration.

• .configuration ⇒ Object

  The global configuration instance.

• .configure {|configuration| ... } ⇒ Object

  Yield the global configuration for modification.

• .reset_client ⇒ void

  Reset the cached singleton client.

Class Method Details

.client ⇒ Object

A convenience client built from the global configuration. Lazy-initialized; reset by calling WorkOS.reset_client.

# File 'lib/workos/configuration.rb', line 42

def client
  @client ||= Client.new(
    api_key: configuration.api_key,
    base_url: configuration.base_url,
    client_id: configuration.client_id,
    timeout: configuration.timeout,
    max_retries: configuration.max_retries,
    logger: configuration.logger,
    log_level: configuration.log_level
  )
end

.configuration ⇒ Object

The global configuration instance.

# File 'lib/workos/configuration.rb', line 36

def configuration
  @configuration ||= Configuration.new
end

.configure {|configuration| ... } ⇒ Object

Yield the global configuration for modification.

WorkOS.configure do |config|
  config.api_key = "sk_..."
  config.client_id = "client_..."
end

Yields:

• (configuration)

# File 'lib/workos/configuration.rb', line 31

def configure
  yield(configuration)
end

.reset_client ⇒ void

This method returns an undefined value.

Reset the cached singleton client. Shuts down any open connections on the current fiber/thread, then clears the cached client so the next call to client builds a fresh one.

Call this after reconfiguring, or in a Puma/Unicorn ‘on_worker_boot` block to avoid sharing sockets across forked processes.

# File 'lib/workos/configuration.rb', line 62

def reset_client
  @client&.shutdown
  @client = nil
end