workos 9.5.1 → 10.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.claude/CLAUDE.md +38 -0
- data/.github/workflows/block-generated-edits.yml +13 -0
- data/.github/workflows/ci.yml +2 -2
- data/.github/workflows/docs.yml +2 -2
- data/.github/workflows/lint.yml +2 -2
- data/.github/workflows/release-please.yml +11 -6
- data/.github/workflows/release.yml +2 -2
- data/.last-synced-sha +1 -1
- data/.oagen-manifest.json +502 -57
- data/.release-please-manifest.json +1 -1
- data/AGENTS.md +1 -0
- data/CHANGELOG.md +330 -2
- data/Gemfile.lock +2 -2
- data/README.md +15 -14
- data/lib/workos/agents/agent_admin_link_claim_attempt_to_external_user_request.rb +28 -0
- data/lib/workos/agents/agent_admin_link_claim_attempt_to_external_user_request_user.rb +22 -0
- data/lib/workos/agents/agent_admin_validate_credential_request.rb +25 -0
- data/lib/workos/agents/agent_blueprint.rb +43 -0
- data/lib/workos/agents/agent_blueprint_invocable_by.rb +7 -0
- data/lib/workos/agents/agent_blueprint_session_setting.rb +25 -0
- data/lib/workos/agents/agent_blueprints_create_request.rb +31 -0
- data/lib/workos/agents/agent_blueprints_create_request_invocable_by.rb +22 -0
- data/lib/workos/agents/agent_blueprints_create_request_session_setting.rb +7 -0
- data/lib/workos/agents/agent_blueprints_token_mint_token_request.rb +34 -0
- data/lib/workos/agents/agent_blueprints_token_validate_token_request.rb +18 -0
- data/lib/workos/agents/agent_blueprints_update_request.rb +31 -0
- data/lib/workos/agents/agent_blueprints_update_request_invocable_by.rb +7 -0
- data/lib/workos/agents/agent_blueprints_update_request_session_setting.rb +25 -0
- data/lib/workos/agents/agent_credential_validation.rb +25 -0
- data/lib/workos/{organization_domains/organization_domain_stand_alone.rb → agents/agent_instance.rb} +10 -16
- data/lib/workos/agents/agent_instance_session.rb +40 -0
- data/lib/workos/agents/agent_registration.rb +40 -0
- data/lib/workos/agents/agent_registration_agent_identity.rb +28 -0
- data/lib/workos/agents/agent_registration_claim.rb +31 -0
- data/lib/workos/agents/agent_registration_claim_claim_completion.rb +31 -0
- data/lib/workos/agents/agent_token.rb +40 -0
- data/lib/workos/agents/agent_token_validation.rb +40 -0
- data/lib/workos/agents/claim_view_response.rb +28 -0
- data/lib/workos/agents/claim_view_response_organization.rb +7 -0
- data/lib/workos/agents.rb +488 -0
- data/lib/workos/api_keys/api_key_validation_response.rb +6 -2
- data/lib/workos/api_keys/validate_api_key.rb +1 -12
- data/lib/workos/api_keys.rb +3 -4
- data/lib/workos/audit_logs.rb +23 -5
- data/lib/workos/authorization/permission_created_data.rb +1 -34
- data/lib/workos/authorization/permission_deleted_data.rb +1 -1
- data/lib/workos/authorization/permission_updated_data.rb +1 -1
- data/lib/workos/authorization.rb +27 -27
- data/lib/workos/base_client.rb +4 -4
- data/lib/workos/client.rb +8 -0
- data/lib/workos/connect.rb +25 -21
- data/lib/workos/directory_sync.rb +10 -2
- data/lib/workos/events.rb +2 -2
- data/lib/workos/groups.rb +13 -9
- data/lib/workos/inflections.rb +15 -1
- data/lib/workos/organization_domains.rb +4 -4
- data/lib/workos/{sso/connection_option.rb → organizations/create_it_contact.rb} +4 -4
- data/lib/workos/organizations/invite_it_contact.rb +18 -0
- data/lib/workos/organizations/it_contact.rb +31 -0
- data/lib/workos/organizations/it_contact_list.rb +25 -0
- data/lib/workos/organizations/organization_authorized_connect_application_list_data.rb +34 -0
- data/lib/workos/organizations/organization_input.rb +10 -1
- data/lib/workos/organizations/update_audit_logs_retention.rb +13 -1
- data/lib/workos/organizations.rb +167 -11
- data/lib/workos/pipes/api_key_installation.rb +25 -0
- data/lib/workos/pipes/connected_account.rb +9 -0
- data/lib/workos/pipes/{connected_account_dto.rb → connected_account_input.rb} +1 -1
- data/lib/workos/pipes/create_data_integration.rb +10 -1
- data/lib/workos/pipes/data_integration.rb +9 -0
- data/lib/workos/pipes/{data_integration_credentials_dto.rb → data_integration_credentials_input.rb} +1 -1
- data/lib/workos/pipes/data_integration_installation.rb +28 -0
- data/lib/workos/pipes/data_integrations_get_data_integration_authorize_url_request.rb +5 -2
- data/lib/workos/pipes/data_integrations_list_response_data_connected_account.rb +9 -0
- data/lib/workos/pipes/data_integrations_upsert_api_key_request.rb +1 -19
- data/lib/workos/pipes/data_integrations_upsert_client_credentials_request.rb +31 -0
- data/lib/workos/pipes/update_data_integration.rb +4 -1
- data/lib/workos/pipes.rb +69 -17
- data/lib/workos/pipes_provider/configure_data_integration_body.rb +5 -2
- data/lib/workos/pipes_provider/data_integration_configuration_response.rb +3 -0
- data/lib/workos/pipes_provider.rb +6 -3
- data/lib/workos/platform_teams/create_team.rb +22 -0
- data/lib/workos/platform_teams/team.rb +37 -0
- data/lib/workos/platform_teams.rb +58 -0
- data/lib/workos/shared/access_token_agent_registration_credential_issued_data_detail.rb +25 -0
- data/lib/workos/shared/agent_blueprint_created.rb +34 -0
- data/lib/workos/shared/agent_blueprint_created_data.rb +43 -0
- data/lib/workos/shared/agent_blueprint_created_data_invocable_by.rb +22 -0
- data/lib/workos/shared/agent_blueprint_created_data_session_setting.rb +25 -0
- data/lib/workos/shared/agent_blueprint_deleted.rb +34 -0
- data/lib/workos/shared/agent_blueprint_deleted_data.rb +31 -0
- data/lib/workos/shared/agent_blueprint_updated.rb +34 -0
- data/lib/workos/shared/agent_blueprint_updated_data.rb +7 -0
- data/lib/workos/shared/agent_blueprint_updated_data_invocable_by.rb +7 -0
- data/lib/workos/shared/agent_blueprint_updated_data_session_setting.rb +7 -0
- data/lib/workos/shared/agent_instance_created.rb +34 -0
- data/lib/workos/shared/agent_instance_created_data.rb +40 -0
- data/lib/workos/shared/agent_instance_deleted.rb +34 -0
- data/lib/workos/shared/agent_instance_deleted_data.rb +40 -0
- data/lib/workos/shared/agent_instance_session_created.rb +34 -0
- data/lib/workos/shared/agent_instance_session_created_data.rb +43 -0
- data/lib/workos/shared/agent_instance_session_revoked.rb +34 -0
- data/lib/workos/shared/agent_instance_session_revoked_data.rb +40 -0
- data/lib/workos/shared/agent_registration_claim_attempt_created.rb +34 -0
- data/lib/workos/shared/agent_registration_claim_attempt_created_data.rb +40 -0
- data/lib/workos/shared/agent_registration_claim_completed.rb +34 -0
- data/lib/workos/shared/agent_registration_claim_completed_data.rb +40 -0
- data/lib/workos/shared/agent_registration_claim_completed_data_claimed_by.rb +22 -0
- data/lib/workos/shared/agent_registration_created.rb +34 -0
- data/lib/workos/shared/agent_registration_created_data.rb +43 -0
- data/lib/workos/shared/agent_registration_created_data_agent_identity.rb +25 -0
- data/lib/workos/shared/agent_registration_credential_issued.rb +34 -0
- data/lib/workos/shared/agent_registration_credential_issued_data.rb +34 -0
- data/lib/workos/shared/agent_registration_credential_issued_data_detail.rb +22 -0
- data/lib/workos/shared/agent_registration_deleted.rb +34 -0
- data/lib/workos/shared/agent_registration_deleted_data.rb +18 -0
- data/lib/workos/shared/agent_registration_expired.rb +34 -0
- data/lib/workos/shared/agent_registration_expired_data.rb +7 -0
- data/lib/workos/shared/agent_registration_organization_switched.rb +34 -0
- data/lib/workos/shared/agent_registration_organization_switched_data.rb +25 -0
- data/lib/workos/shared/agent_registration_refreshed.rb +34 -0
- data/lib/workos/shared/agent_registration_refreshed_data.rb +7 -0
- data/lib/workos/shared/agent_registration_revoked.rb +34 -0
- data/lib/workos/shared/agent_registration_revoked_data.rb +7 -0
- data/lib/workos/shared/pipes_connected_account_connection_failed.rb +34 -0
- data/lib/workos/shared/pipes_connected_account_connection_failed_data.rb +46 -0
- data/lib/workos/shared/radar_challenge_created.rb +34 -0
- data/lib/workos/shared/radar_challenge_created_data.rb +28 -0
- data/lib/workos/shared/resource_export_completed.rb +34 -0
- data/lib/workos/shared/resource_export_completed_data.rb +22 -0
- data/lib/workos/shared/resource_export_created.rb +34 -0
- data/lib/workos/shared/resource_export_created_data.rb +22 -0
- data/lib/workos/shared/resource_export_downloaded.rb +34 -0
- data/lib/workos/shared/resource_export_downloaded_data.rb +22 -0
- data/lib/workos/shared/resource_export_failed.rb +34 -0
- data/lib/workos/shared/resource_export_failed_data.rb +22 -0
- data/lib/workos/shared/waitlist_user.rb +11 -5
- data/lib/workos/sso/connection.rb +0 -3
- data/lib/workos/sso/create_connection.rb +37 -0
- data/lib/workos/sso/create_connection_attribute_maps.rb +22 -0
- data/lib/workos/sso/create_connection_key_pair.rb +22 -0
- data/lib/workos/sso/create_connection_oidc_options.rb +43 -0
- data/lib/workos/sso/create_connection_saml_options.rb +40 -0
- data/lib/workos/sso/create_connection_standard_attributes.rb +34 -0
- data/lib/workos/{admin_portal/domain_verification_intent_options.rb → sso/create_saml_idp_signing_certificate.rb} +4 -4
- data/lib/workos/sso/patch_connection.rb +34 -0
- data/lib/workos/sso/patch_connection_attribute_maps.rb +22 -0
- data/lib/workos/sso/patch_connection_oidc_options.rb +40 -0
- data/lib/workos/sso/patch_connection_saml_options.rb +31 -0
- data/lib/workos/sso/patch_connection_standard_attributes.rb +7 -0
- data/lib/workos/sso/saml_idp_signing_certificate.rb +34 -0
- data/lib/workos/sso/saml_idp_signing_certificate_list.rb +22 -0
- data/lib/workos/sso/saml_sp_encryption_certificate.rb +34 -0
- data/lib/workos/sso/saml_sp_encryption_certificate_list.rb +22 -0
- data/lib/workos/sso/saml_sp_signing_certificate.rb +34 -0
- data/lib/workos/sso/token_query.rb +11 -2
- data/lib/workos/sso.rb +378 -30
- data/lib/workos/types/agent_admin_validate_credential_request_type.rb +13 -0
- data/lib/workos/types/agent_blueprints_token_mint_token_request_type.rb +15 -0
- data/lib/workos/types/agent_instance_created_data_type.rb +13 -0
- data/lib/workos/types/{data_integration_credentials_type.rb → agent_instance_deleted_data_type.rb} +1 -1
- data/lib/workos/types/agent_instance_session_status.rb +14 -0
- data/lib/workos/types/{organization_domain_stand_alone_state.rb → agent_instance_type.rb} +1 -1
- data/lib/workos/types/agent_registration_created_data_kind.rb +14 -0
- data/lib/workos/types/agent_registration_created_data_method.rb +14 -0
- data/lib/workos/types/agent_registration_created_data_status.rb +15 -0
- data/lib/workos/types/{organization_domain_stand_alone_verification_strategy.rb → agent_registration_kind.rb} +1 -1
- data/lib/workos/types/agent_registration_status.rb +9 -0
- data/lib/workos/types/applications_registration_types.rb +13 -0
- data/lib/workos/types/authenticate_response_authentication_method.rb +1 -2
- data/lib/workos/types/claim_view_response_status.rb +9 -0
- data/lib/workos/types/connected_account_auth_method.rb +2 -1
- data/lib/workos/types/connected_account_input_state.rb +13 -0
- data/lib/workos/types/connected_account_state.rb +2 -1
- data/lib/workos/types/connection_activated_data_connection_type.rb +1 -2
- data/lib/workos/types/connection_type.rb +1 -2
- data/lib/workos/types/connections_connection_type.rb +1 -2
- data/lib/workos/types/create_connection_oidc_options_id_token_signature_algorithm.rb +24 -0
- data/lib/workos/types/create_connection_oidc_options_token_authentication_method.rb +14 -0
- data/lib/workos/types/create_data_integration_auth_methods.rb +9 -0
- data/lib/workos/types/create_user_password_hash_type.rb +2 -1
- data/lib/workos/types/create_user_password_salt_position.rb +13 -0
- data/lib/workos/types/create_webhook_endpoint_events.rb +13 -1
- data/lib/workos/types/data_integration_auth_methods.rb +9 -0
- data/lib/workos/types/data_integration_credentials_input_type.rb +9 -0
- data/lib/workos/types/data_integrations_list_response_data_connected_account_state.rb +1 -6
- data/lib/workos/types/invite_it_contact_intents.rb +16 -0
- data/lib/workos/types/patch_connection_oidc_options_id_token_signature_algorithm.rb +9 -0
- data/lib/workos/types/patch_connection_oidc_options_token_authentication_method.rb +9 -0
- data/lib/workos/types/pipe_connected_account_state.rb +1 -5
- data/lib/workos/types/resource_export_completed_data_resource_type.rb +16 -0
- data/lib/workos/types/resource_export_created_data_resource_type.rb +9 -0
- data/lib/workos/types/resource_export_downloaded_data_resource_type.rb +9 -0
- data/lib/workos/types/resource_export_failed_data_resource_type.rb +9 -0
- data/lib/workos/types/session_created_data_status.rb +1 -6
- data/lib/workos/types/session_revoked_data_status.rb +1 -1
- data/lib/workos/types/sso_grant_type.rb +13 -0
- data/lib/workos/types/team_production_state.rb +15 -0
- data/lib/workos/types/token_query_grant_type.rb +9 -0
- data/lib/workos/types/update_audit_logs_retention_retention_period.rb +32 -0
- data/lib/workos/types/update_user_password_salt_position.rb +9 -0
- data/lib/workos/types/user_identities_get_item_provider.rb +1 -2
- data/lib/workos/types/user_management_waitlists_state.rb +14 -0
- data/lib/workos/types/user_sessions_status.rb +1 -1
- data/lib/workos/types/vault_kek_deleted_data_actor_source.rb +9 -0
- data/lib/workos/types/waitlist_entry_state.rb +9 -0
- data/lib/workos/types/waitlist_user_state.rb +1 -6
- data/lib/workos/user_management/authentication_oauth_failed_data.rb +5 -2
- data/lib/workos/user_management/authentication_oauth_succeeded_data.rb +5 -2
- data/lib/workos/user_management/authentication_reauthentication_succeeded.rb +34 -0
- data/lib/workos/user_management/authentication_reauthentication_succeeded_data.rb +34 -0
- data/lib/workos/user_management/create_password_reset_token.rb +1 -12
- data/lib/workos/user_management/create_user.rb +5 -2
- data/lib/workos/user_management/create_waitlist_entry.rb +25 -0
- data/lib/workos/user_management/email_completion_session_authenticate_request.rb +43 -0
- data/lib/workos/user_management/radar_challenge.rb +43 -0
- data/lib/workos/user_management/update_user.rb +5 -2
- data/lib/workos/user_management/waitlist.rb +28 -0
- data/lib/workos/user_management/waitlist_entry.rb +43 -0
- data/lib/workos/user_management.rb +340 -74
- data/lib/workos/vault/vault_kek_deleted.rb +34 -0
- data/lib/workos/vault/vault_kek_deleted_data.rb +31 -0
- data/lib/workos/vault.rb +4 -4
- data/lib/workos/version.rb +1 -1
- data/lib/workos/widgets.rb +2 -2
- data/lib/workos.rb +12 -0
- data/rbi/workos/access_token_agent_registration_credential_issued_data_detail.rbi +36 -0
- data/rbi/workos/agent_admin_link_claim_attempt_to_external_user_request.rbi +42 -0
- data/rbi/workos/agent_admin_link_claim_attempt_to_external_user_request_user.rbi +30 -0
- data/rbi/workos/agent_admin_validate_credential_request.rbi +36 -0
- data/rbi/workos/agent_blueprint.rbi +72 -0
- data/rbi/workos/agent_blueprint_created.rbi +54 -0
- data/rbi/workos/agent_blueprint_created_data.rbi +72 -0
- data/rbi/workos/agent_blueprint_created_data_invocable_by.rbi +30 -0
- data/rbi/workos/agent_blueprint_created_data_session_setting.rbi +36 -0
- data/rbi/workos/agent_blueprint_deleted.rbi +54 -0
- data/rbi/workos/agent_blueprint_deleted_data.rbi +48 -0
- data/rbi/workos/agent_blueprint_invocable_by.rbi +30 -0
- data/rbi/workos/agent_blueprint_session_setting.rbi +36 -0
- data/rbi/workos/agent_blueprint_updated.rbi +54 -0
- data/rbi/workos/agent_blueprint_updated_data.rbi +72 -0
- data/rbi/workos/agent_blueprint_updated_data_invocable_by.rbi +30 -0
- data/rbi/workos/agent_blueprint_updated_data_session_setting.rbi +36 -0
- data/rbi/workos/agent_blueprints_create_request.rbi +48 -0
- data/rbi/workos/agent_blueprints_create_request_invocable_by.rbi +30 -0
- data/rbi/workos/agent_blueprints_create_request_session_setting.rbi +36 -0
- data/rbi/workos/agent_blueprints_token_mint_token_request.rbi +54 -0
- data/rbi/workos/{domain_verification_intent_options.rbi → agent_blueprints_token_validate_token_request.rbi} +5 -5
- data/rbi/workos/agent_blueprints_update_request.rbi +48 -0
- data/rbi/workos/agent_blueprints_update_request_invocable_by.rbi +30 -0
- data/rbi/workos/agent_blueprints_update_request_session_setting.rbi +36 -0
- data/rbi/workos/{sso_intent_options.rbi → agent_credential_validation.rbi} +11 -5
- data/rbi/workos/agent_instance.rbi +66 -0
- data/rbi/workos/agent_instance_created.rbi +54 -0
- data/rbi/workos/agent_instance_created_data.rbi +66 -0
- data/rbi/workos/agent_instance_deleted.rbi +54 -0
- data/rbi/workos/agent_instance_deleted_data.rbi +66 -0
- data/rbi/workos/agent_instance_session.rbi +66 -0
- data/rbi/workos/agent_instance_session_created.rbi +54 -0
- data/rbi/workos/agent_instance_session_created_data.rbi +72 -0
- data/rbi/workos/agent_instance_session_revoked.rbi +54 -0
- data/rbi/workos/agent_instance_session_revoked_data.rbi +66 -0
- data/rbi/workos/agent_registration.rbi +66 -0
- data/rbi/workos/agent_registration_agent_identity.rbi +42 -0
- data/rbi/workos/agent_registration_claim.rbi +48 -0
- data/rbi/workos/agent_registration_claim_attempt_created.rbi +54 -0
- data/rbi/workos/agent_registration_claim_attempt_created_data.rbi +66 -0
- data/rbi/workos/agent_registration_claim_claim_completion.rbi +48 -0
- data/rbi/workos/agent_registration_claim_completed.rbi +54 -0
- data/rbi/workos/agent_registration_claim_completed_data.rbi +66 -0
- data/rbi/workos/agent_registration_claim_completed_data_claimed_by.rbi +30 -0
- data/rbi/workos/agent_registration_created.rbi +54 -0
- data/rbi/workos/agent_registration_created_data.rbi +72 -0
- data/rbi/workos/agent_registration_created_data_agent_identity.rbi +36 -0
- data/rbi/workos/agent_registration_credential_issued.rbi +54 -0
- data/rbi/workos/agent_registration_credential_issued_data.rbi +54 -0
- data/rbi/workos/agent_registration_credential_issued_data_detail.rbi +30 -0
- data/rbi/workos/agent_registration_deleted.rbi +54 -0
- data/rbi/workos/{connection_option.rbi → agent_registration_deleted_data.rbi} +5 -5
- data/rbi/workos/agent_registration_expired.rbi +54 -0
- data/rbi/workos/agent_registration_expired_data.rbi +24 -0
- data/rbi/workos/agent_registration_organization_switched.rbi +54 -0
- data/rbi/workos/agent_registration_organization_switched_data.rbi +36 -0
- data/rbi/workos/agent_registration_refreshed.rbi +54 -0
- data/rbi/workos/agent_registration_refreshed_data.rbi +24 -0
- data/rbi/workos/agent_registration_revoked.rbi +54 -0
- data/rbi/workos/agent_registration_revoked_data.rbi +24 -0
- data/rbi/workos/agent_token.rbi +66 -0
- data/rbi/workos/agent_token_validation.rbi +66 -0
- data/rbi/workos/agents.rbi +175 -0
- data/rbi/workos/api_key_installation.rbi +36 -0
- data/rbi/workos/api_key_validation_response.rbi +6 -0
- data/rbi/workos/audit_logs.rbi +26 -2
- data/rbi/workos/authentication_oauth_failed_data.rbi +6 -0
- data/rbi/workos/authentication_oauth_succeeded_data.rbi +6 -0
- data/rbi/workos/authentication_reauthentication_succeeded.rbi +54 -0
- data/rbi/workos/authentication_reauthentication_succeeded_data.rbi +54 -0
- data/rbi/workos/claim_view_response.rbi +42 -0
- data/rbi/workos/claim_view_response_organization.rbi +30 -0
- data/rbi/workos/client.rbi +6 -0
- data/rbi/workos/configure_data_integration_body.rbi +6 -0
- data/rbi/workos/connect.rbi +2 -1
- data/rbi/workos/connected_account.rbi +18 -0
- data/rbi/workos/{connected_account_dto.rbi → connected_account_input.rbi} +1 -1
- data/rbi/workos/connection.rbi +0 -6
- data/rbi/workos/create_connection.rbi +60 -0
- data/rbi/workos/create_connection_attribute_maps.rbi +30 -0
- data/rbi/workos/create_connection_key_pair.rbi +30 -0
- data/rbi/workos/create_connection_oidc_options.rbi +72 -0
- data/rbi/workos/create_connection_saml_options.rbi +66 -0
- data/rbi/workos/create_connection_standard_attributes.rbi +54 -0
- data/rbi/workos/create_data_integration.rbi +20 -2
- data/rbi/workos/create_it_contact.rbi +24 -0
- data/rbi/workos/create_saml_idp_signing_certificate.rbi +24 -0
- data/rbi/workos/create_team.rbi +30 -0
- data/rbi/workos/create_user.rbi +6 -0
- data/rbi/workos/create_waitlist_entry.rbi +36 -0
- data/rbi/workos/custom_provider_definition.rbi +4 -4
- data/rbi/workos/data_integration.rbi +20 -2
- data/rbi/workos/data_integration_configuration_response.rbi +6 -0
- data/rbi/workos/{data_integration_credentials_dto.rbi → data_integration_credentials_input.rbi} +1 -1
- data/rbi/workos/data_integration_installation.rbi +42 -0
- data/rbi/workos/data_integrations_get_data_integration_authorize_url_request.rbi +6 -0
- data/rbi/workos/data_integrations_list_response_data_connected_account.rbi +18 -0
- data/rbi/workos/data_integrations_upsert_client_credentials_request.rbi +48 -0
- data/rbi/workos/directory_sync.rbi +3 -1
- data/rbi/workos/email_completion_session_authenticate_request.rbi +72 -0
- data/rbi/workos/events.rbi +2 -2
- data/rbi/workos/groups.rbi +2 -1
- data/rbi/workos/invite_it_contact.rbi +24 -0
- data/rbi/workos/it_contact.rbi +48 -0
- data/rbi/workos/organization_authorized_connect_application_list_data.rbi +54 -0
- data/rbi/workos/organization_domains.rbi +2 -2
- data/rbi/workos/organizations.rbi +57 -0
- data/rbi/workos/patch_connection.rbi +54 -0
- data/rbi/workos/patch_connection_attribute_maps.rbi +30 -0
- data/rbi/workos/patch_connection_oidc_options.rbi +66 -0
- data/rbi/workos/patch_connection_saml_options.rbi +48 -0
- data/rbi/workos/patch_connection_standard_attributes.rbi +54 -0
- data/rbi/workos/permission_created_data.rbi +6 -0
- data/rbi/workos/permission_deleted_data.rbi +6 -0
- data/rbi/workos/permission_updated_data.rbi +6 -0
- data/rbi/workos/pipes.rbi +23 -5
- data/rbi/workos/pipes_connected_account_connection_failed.rbi +54 -0
- data/rbi/workos/{organization_domain_stand_alone.rbi → pipes_connected_account_connection_failed_data.rbi} +23 -23
- data/rbi/workos/pipes_provider.rbi +2 -1
- data/rbi/workos/platform_teams.rbi +30 -0
- data/rbi/workos/radar_challenge.rbi +72 -0
- data/rbi/workos/radar_challenge_created.rbi +54 -0
- data/rbi/workos/radar_challenge_created_data.rbi +42 -0
- data/rbi/workos/radar_sms_challenge_code_session_authenticate_request.rbi +4 -4
- data/rbi/workos/resource_export_completed.rbi +54 -0
- data/rbi/workos/resource_export_completed_data.rbi +30 -0
- data/rbi/workos/resource_export_created.rbi +54 -0
- data/rbi/workos/resource_export_created_data.rbi +30 -0
- data/rbi/workos/resource_export_downloaded.rbi +54 -0
- data/rbi/workos/resource_export_downloaded_data.rbi +30 -0
- data/rbi/workos/resource_export_failed.rbi +54 -0
- data/rbi/workos/resource_export_failed_data.rbi +30 -0
- data/rbi/workos/saml_idp_signing_certificate.rbi +54 -0
- data/rbi/workos/saml_idp_signing_certificate_list.rbi +30 -0
- data/rbi/workos/saml_sp_encryption_certificate.rbi +54 -0
- data/rbi/workos/saml_sp_encryption_certificate_list.rbi +30 -0
- data/rbi/workos/saml_sp_signing_certificate.rbi +54 -0
- data/rbi/workos/sso.rbi +181 -2
- data/rbi/workos/team.rbi +60 -0
- data/rbi/workos/token_query.rbi +20 -2
- data/rbi/workos/update_audit_logs_retention.rbi +8 -2
- data/rbi/workos/update_data_integration.rbi +8 -2
- data/rbi/workos/update_user.rbi +6 -0
- data/rbi/workos/user_management.rbi +116 -2
- data/rbi/workos/vault_kek_deleted.rbi +54 -0
- data/rbi/workos/vault_kek_deleted_data.rbi +48 -0
- data/rbi/workos/waitlist.rbi +42 -0
- data/rbi/workos/waitlist_entry.rbi +72 -0
- data/rbi/workos/waitlist_user.rbi +18 -6
- data/rbi/workos/widget_session_token.rbi +2 -2
- data/rbi/workos/widgets.rbi +1 -1
- data/test/workos/test_agents.rb +153 -0
- data/test/workos/test_agents_model_round_trip.rb +410 -0
- data/test/workos/test_api_keys_model_round_trip.rb +307 -0
- data/test/workos/test_audit_logs.rb +11 -2
- data/test/workos/test_authkit_helpers.rb +22 -10
- data/test/workos/test_authorization.rb +6 -6
- data/test/workos/test_authorization_model_round_trip.rb +237 -0
- data/test/workos/test_base_client.rb +27 -0
- data/test/workos/test_client_api_model_round_trip.rb +31 -0
- data/test/workos/test_connect_model_round_trip.rb +175 -0
- data/test/workos/test_directory_sync_model_round_trip.rb +579 -0
- data/test/workos/test_events.rb +2 -2
- data/test/workos/test_feature_flags_model_round_trip.rb +580 -0
- data/test/workos/test_groups_model_round_trip.rb +56 -0
- data/test/workos/test_multi_factor_auth_model_round_trip.rb +192 -0
- data/test/workos/test_organization_domains_model_round_trip.rb +260 -0
- data/test/workos/test_organization_membership_model_round_trip.rb +89 -0
- data/test/workos/test_organizations.rb +49 -1
- data/test/workos/test_organizations_model_round_trip.rb +642 -1
- data/test/workos/test_pipes.rb +8 -0
- data/test/workos/test_pipes_model_round_trip.rb +68 -8
- data/test/workos/test_pipes_provider_model_round_trip.rb +77 -0
- data/test/workos/test_platform_teams.rb +41 -0
- data/test/workos/test_platform_teams_model_round_trip.rb +41 -0
- data/test/workos/test_shared_model_round_trip.rb +1263 -0
- data/test/workos/test_sso.rb +108 -2
- data/test/workos/test_sso_model_round_trip.rb +681 -0
- data/test/workos/test_user_management.rb +78 -6
- data/test/workos/test_user_management_model_round_trip.rb +1604 -27
- data/test/workos/test_vault_model_round_trip.rb +571 -0
- data/test/workos/test_widgets.rb +2 -2
- data/test/workos/test_widgets_model_round_trip.rb +30 -0
- metadata +287 -19
- data/lib/workos/admin_portal/intent_options.rb +0 -22
- data/lib/workos/admin_portal/sso_intent_options.rb +0 -22
- data/rbi/workos/intent_options.rbi +0 -30
- data/test/workos/test_model_round_trip.rb +0 -6
data/AGENTS.md
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
.claude/CLAUDE.md
|
data/CHANGELOG.md
CHANGED
|
@@ -1,11 +1,339 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
-
## [
|
|
3
|
+
## [10.3.0](https://github.com/workos/workos-ruby/compare/v10.2.1...v10.3.0) (2026-09-01)
|
|
4
|
+
|
|
5
|
+
* [#546](https://github.com/workos/workos-ruby/pull/546) feat(generated)!: regenerate from spec (5 changes)
|
|
6
|
+
|
|
7
|
+
**⚠️ Breaking**
|
|
8
|
+
* **[agents](https://workos.com/docs/reference/agents)**:
|
|
9
|
+
* Removed service `Agents`
|
|
10
|
+
* **[sso](https://workos.com/docs/reference/sso)**:
|
|
11
|
+
* Removed model `TokenBody`
|
|
12
|
+
* Removed enum `TokenBodyGrantType`
|
|
13
|
+
* Removed model `TokenQuery`
|
|
14
|
+
* Changed parameter `SSO.token.grant_type`
|
|
15
|
+
|
|
16
|
+
**Features**
|
|
17
|
+
* **[agents](https://workos.com/docs/reference/agents)**:
|
|
18
|
+
* Added model `AgentBlueprint`
|
|
19
|
+
* Added model `AgentInstance`
|
|
20
|
+
* Added model `AgentToken`
|
|
21
|
+
* Added model `AgentInstanceSession`
|
|
22
|
+
* Added model `AgentBlueprintInvocableBy`
|
|
23
|
+
* Added model `AgentBlueprintSessionSetting`
|
|
24
|
+
* Added model `AgentBlueprintsCreateRequest`
|
|
25
|
+
* Added model `AgentBlueprintsCreateRequestInvocableBy`
|
|
26
|
+
* Added model `AgentBlueprintsCreateRequestSessionSetting`
|
|
27
|
+
* Added model `AgentBlueprintsUpdateRequest`
|
|
28
|
+
* Added model `AgentBlueprintsUpdateRequestInvocableBy`
|
|
29
|
+
* Added model `AgentBlueprintsUpdateRequestSessionSetting`
|
|
30
|
+
* Added model `AgentBlueprintsTokenMintTokenRequest`
|
|
31
|
+
* Added enum `AgentInstanceType`
|
|
32
|
+
* Added enum `AgentInstanceSessionStatus`
|
|
33
|
+
* Added enum `AgentBlueprintsTokenMintTokenRequestType`
|
|
34
|
+
* **agents_blueprints**:
|
|
35
|
+
* Added service `AgentsBlueprints`
|
|
36
|
+
* **agents_blueprints_tokens**:
|
|
37
|
+
* Added service `AgentsBlueprintsTokens`
|
|
38
|
+
* **agents_instances**:
|
|
39
|
+
* Added service `AgentsInstances`
|
|
40
|
+
* **agents_registrations**:
|
|
41
|
+
* Added service `AgentsRegistrations`
|
|
42
|
+
* **agents_sessions**:
|
|
43
|
+
* Added service `AgentsSessions`
|
|
44
|
+
* **[organizations](https://workos.com/docs/reference/organization)**:
|
|
45
|
+
* Added `retention_period` to `UpdateAuditLogsRetention`
|
|
46
|
+
* Made `UpdateAuditLogsRetention.retention_period_in_days` optional
|
|
47
|
+
* Added enum `UpdateAuditLogsRetentionRetentionPeriod`
|
|
48
|
+
* Added model `CreateItContact`
|
|
49
|
+
* Added model `InviteItContact`
|
|
50
|
+
* Added model `ItContact`
|
|
51
|
+
* Added model `ItContactList`
|
|
52
|
+
* Added model `ItContactListListMetadata`
|
|
53
|
+
* Added enum `InviteItContactIntents`
|
|
54
|
+
* Added service `OrganizationsItContacts`
|
|
55
|
+
* **platform_teams**:
|
|
56
|
+
* Added model `CreateTeam`
|
|
57
|
+
* Added model `Team`
|
|
58
|
+
* Added enum `TeamProductionState`
|
|
59
|
+
* Added service `PlatformTeams`
|
|
60
|
+
* **[sso](https://workos.com/docs/reference/sso)**:
|
|
61
|
+
* Added model `TokenQuery`
|
|
62
|
+
* Added enum `TokenQueryGrantType`
|
|
63
|
+
* Added model `CreateConnectionKeyPair`
|
|
64
|
+
* Added model `CreateConnectionSAMLOptions`
|
|
65
|
+
* Added model `CreateConnectionOidcOptions`
|
|
66
|
+
* Added model `CreateConnectionStandardAttributes`
|
|
67
|
+
* Added model `CreateConnectionAttributeMaps`
|
|
68
|
+
* Added model `CreateConnection`
|
|
69
|
+
* Added model `PatchConnectionSAMLOptions`
|
|
70
|
+
* Added model `PatchConnectionOidcOptions`
|
|
71
|
+
* Added model `PatchConnectionStandardAttributes`
|
|
72
|
+
* Added model `PatchConnectionAttributeMaps`
|
|
73
|
+
* Added model `PatchConnection`
|
|
74
|
+
* Added model `CreateSAMLIdpSigningCertificate`
|
|
75
|
+
* Added model `SAMLIdpSigningCertificate`
|
|
76
|
+
* Added model `SAMLIdpSigningCertificateList`
|
|
77
|
+
* Added model `SAMLSpEncryptionCertificate`
|
|
78
|
+
* Added model `SAMLSpEncryptionCertificateList`
|
|
79
|
+
* Added model `SAMLSpSigningCertificate`
|
|
80
|
+
* Added enum `CreateConnectionOidcOptionsIdTokenSignatureAlgorithm`
|
|
81
|
+
* Added enum `PatchConnectionOidcOptionsIdTokenSignatureAlgorithm`
|
|
82
|
+
* Added endpoint `POST /connections`
|
|
83
|
+
* Added endpoint `GET /connections/{connectionId}/saml_idp_signing_certs`
|
|
84
|
+
* Added endpoint `POST /connections/{connectionId}/saml_idp_signing_certs`
|
|
85
|
+
* Added endpoint `DELETE /connections/{connectionId}/saml_idp_signing_certs/{certificateId}`
|
|
86
|
+
* Added endpoint `GET /connections/{connectionId}/saml_sp_encryption_certs`
|
|
87
|
+
* Added endpoint `POST /connections/{connectionId}/saml_sp_encryption_certs`
|
|
88
|
+
* Added endpoint `DELETE /connections/{connectionId}/saml_sp_encryption_certs/{certificateId}`
|
|
89
|
+
* Added endpoint `GET /connections/{connectionId}/saml_sp_signing_cert`
|
|
90
|
+
* Added endpoint `POST /connections/{connectionId}/saml_sp_signing_cert`
|
|
91
|
+
* Added endpoint `DELETE /connections/{connectionId}/saml_sp_signing_cert/{certificateId}`
|
|
92
|
+
* Added endpoint `PATCH /connections/{id}`
|
|
93
|
+
* Added model `TokenBody`
|
|
94
|
+
* Added enum `TokenBodyGrantType`
|
|
95
|
+
* Added enum `SSOGrantType`
|
|
96
|
+
* Changed required status for parameter `SSO.token.code`
|
|
97
|
+
* **[user_management](https://workos.com/docs/reference/authkit/user)**:
|
|
98
|
+
* Added enum `CreateConnectionOidcOptionsTokenAuthenticationMethod`
|
|
99
|
+
* Added enum `PatchConnectionOidcOptionsTokenAuthenticationMethod`
|
|
100
|
+
* Added model `EmailCompletionSessionAuthenticateRequest`
|
|
101
|
+
* Added model `CreateWaitlistEntry`
|
|
102
|
+
* Added model `Waitlist`
|
|
103
|
+
* Added model `WaitlistEntry`
|
|
104
|
+
* Added enum `WaitlistEntryState`
|
|
105
|
+
* Added enum `UserManagementWaitlistsState`
|
|
106
|
+
* Added service `UserManagementWaitlists`
|
|
107
|
+
* **[webhooks](https://workos.com/docs/reference/webhooks)**:
|
|
108
|
+
* Added `agent.instance.created` to `CreateWebhookEndpointEvents`
|
|
109
|
+
* Added `agent.instance.deleted` to `CreateWebhookEndpointEvents`
|
|
110
|
+
* Added `agent.instance.session.created` to `CreateWebhookEndpointEvents`
|
|
111
|
+
* Added `agent.instance.session.revoked` to `CreateWebhookEndpointEvents`
|
|
112
|
+
* Added `agent.instance.created` to `UpdateWebhookEndpointEvents`
|
|
113
|
+
* Added `agent.instance.deleted` to `UpdateWebhookEndpointEvents`
|
|
114
|
+
* Added `agent.instance.session.created` to `UpdateWebhookEndpointEvents`
|
|
115
|
+
* Added `agent.instance.session.revoked` to `UpdateWebhookEndpointEvents`
|
|
116
|
+
* Added `agent.blueprint.created` to `CreateWebhookEndpointEvents`
|
|
117
|
+
* Added `agent.blueprint.deleted` to `CreateWebhookEndpointEvents`
|
|
118
|
+
* Added `agent.blueprint.updated` to `CreateWebhookEndpointEvents`
|
|
119
|
+
* Added `agent.blueprint.created` to `UpdateWebhookEndpointEvents`
|
|
120
|
+
* Added `agent.blueprint.deleted` to `UpdateWebhookEndpointEvents`
|
|
121
|
+
* Added `agent.blueprint.updated` to `UpdateWebhookEndpointEvents`
|
|
122
|
+
|
|
123
|
+
**Fixes**
|
|
124
|
+
* **[sso](https://workos.com/docs/reference/sso)**:
|
|
125
|
+
* Changed request body of `SSO.token` from `TokenBody` to `TokenQuery`
|
|
126
|
+
* Removed `DiscordOAuth` from `ConnectionType`
|
|
127
|
+
* Removed `GrokOAuth` from `ConnectionType`
|
|
128
|
+
* Removed `XOAuth` from `ConnectionType`
|
|
129
|
+
* Removed `DiscordOAuth` from `ProfileConnectionType`
|
|
130
|
+
* Removed `GrokOAuth` from `ProfileConnectionType`
|
|
131
|
+
* Removed `XOAuth` from `ProfileConnectionType`
|
|
132
|
+
* Removed `DiscordOAuth` from `ConnectionsConnectionType`
|
|
133
|
+
* Removed `GrokOAuth` from `ConnectionsConnectionType`
|
|
134
|
+
* Removed `XOAuth` from `ConnectionsConnectionType`
|
|
135
|
+
* Changed request body of `SSO.token` from `TokenQuery` to `TokenBody`
|
|
136
|
+
* **[user_management](https://workos.com/docs/reference/authkit/user)**:
|
|
137
|
+
* Changed request body for `UserManagementAuthentication.authenticate`
|
|
138
|
+
* Changed errors for endpoint `POST /user_management/authenticate`
|
|
139
|
+
* Removed `DiscordOAuth` from `AuthenticateResponseAuthenticationMethod`
|
|
140
|
+
* Removed `GrokOAuth` from `AuthenticateResponseAuthenticationMethod`
|
|
141
|
+
* Removed `XOAuth` from `AuthenticateResponseAuthenticationMethod`
|
|
142
|
+
* Removed `DiscordOAuth` from `UserIdentitiesGetItemProvider`
|
|
143
|
+
* Removed `GrokOAuth` from `UserIdentitiesGetItemProvider`
|
|
144
|
+
* Removed `XOAuth` from `UserIdentitiesGetItemProvider`
|
|
145
|
+
* Changed errors for endpoint `DELETE /user_management/users/{id}`
|
|
146
|
+
|
|
147
|
+
* [#549](https://github.com/workos/workos-ruby/pull/549) fix(generated): regenerate from spec
|
|
148
|
+
|
|
149
|
+
**Features**
|
|
150
|
+
* **[agents](https://workos.com/docs/reference/agents)**:
|
|
151
|
+
* Made `AgentBlueprintsCreateRequest.session_settings` optional
|
|
152
|
+
* Added model `AgentTokenValidation`
|
|
153
|
+
* Added model `AgentBlueprintsTokenValidateTokenRequest`
|
|
154
|
+
* **agents_blueprints_tokens**:
|
|
155
|
+
* Added endpoint `POST /agents/blueprints/{agent_blueprint_id}/tokens/validate`
|
|
156
|
+
|
|
157
|
+
## [10.2.1](https://github.com/workos/workos-ruby/compare/v10.2.0...v10.2.1) (2026-08-20)
|
|
4
158
|
|
|
5
159
|
|
|
6
160
|
### Bug Fixes
|
|
7
161
|
|
|
8
|
-
* explicitly evict connections if request does not complete as success ([
|
|
162
|
+
* explicitly evict connections if request does not complete as success ([e792414](https://github.com/workos/workos-ruby/commit/e79241473e9cb0e8898632723200a7e23682ff24))
|
|
163
|
+
|
|
164
|
+
## [10.2.0](https://github.com/workos/workos-ruby/compare/v10.1.0...v10.2.0) (2026-08-11)
|
|
165
|
+
|
|
166
|
+
* [#533](https://github.com/workos/workos-ruby/pull/533) feat(generated)!: regenerate from spec (2 changes)
|
|
167
|
+
|
|
168
|
+
**⚠️ Breaking**
|
|
169
|
+
* **[events](https://workos.com/docs/reference/events)**:
|
|
170
|
+
* Changed required status for parameter `Events.list.events`
|
|
171
|
+
|
|
172
|
+
**Features**
|
|
173
|
+
* **[groups](https://workos.com/docs/reference/groups)**:
|
|
174
|
+
* Added parameter `Groups.list.search`
|
|
175
|
+
* **[connect](https://workos.com/docs/reference/workos-connect/standalone)**:
|
|
176
|
+
* Added `client_id` to `ConnectedAccount`
|
|
177
|
+
* Added `client_secret_last_4` to `ConnectedAccount`
|
|
178
|
+
* Added `config` to `ConnectedAccount`
|
|
179
|
+
* **[pipes](https://workos.com/docs/reference/pipes)**:
|
|
180
|
+
* Added `client_id` to `DataIntegrationsListResponseDataConnectedAccount`
|
|
181
|
+
* Added `client_secret_last_4` to `DataIntegrationsListResponseDataConnectedAccount`
|
|
182
|
+
* Added `config` to `DataIntegrationsListResponseDataConnectedAccount`
|
|
183
|
+
* Changed errors for endpoint `POST /data-integrations/{slug}/credentials`
|
|
184
|
+
* Made `CustomProviderDefinition.authorization_url` optional
|
|
185
|
+
* Made `CustomProviderDefinition.token_url` optional
|
|
186
|
+
* Added model `DataIntegrationsUpsertClientCredentialsRequest`
|
|
187
|
+
* Added `client_credentials` to `CreateDataIntegrationAuthMethods`
|
|
188
|
+
* Added endpoint `PUT /data-integrations/{slug}/client-credentials`
|
|
189
|
+
* **[sso](https://workos.com/docs/reference/sso)**:
|
|
190
|
+
* Added `XOAuth` to `ConnectionType`
|
|
191
|
+
* Added `XOAuth` to `ProfileConnectionType`
|
|
192
|
+
* Added `XOAuth` to `ConnectionsConnectionType`
|
|
193
|
+
* Added `GrokOAuth` to `ConnectionType`
|
|
194
|
+
* Added `GrokOAuth` to `ProfileConnectionType`
|
|
195
|
+
* Added `GrokOAuth` to `ConnectionsConnectionType`
|
|
196
|
+
* **[user_management](https://workos.com/docs/reference/authkit/user)**:
|
|
197
|
+
* Changed errors for endpoint `DELETE /user_management/users/{id}`
|
|
198
|
+
* Added `password_salt_position` to `CreateUser`
|
|
199
|
+
* Added `password_salt_position` to `UpdateUser`
|
|
200
|
+
* Made `RadarSmsChallengeCodeSessionAuthenticateRequest.verification_id` optional
|
|
201
|
+
* Made `RadarSmsChallengeCodeSessionAuthenticateRequest.phone_number` optional
|
|
202
|
+
* Added enum `CreateUserPasswordSaltPosition`
|
|
203
|
+
* Added enum `UpdateUserPasswordSaltPosition`
|
|
204
|
+
* Added `XOAuth` to `AuthenticateResponseAuthenticationMethod`
|
|
205
|
+
* Added `XOAuth` to `UserIdentitiesGetItemProvider`
|
|
206
|
+
* Added `GrokOAuth` to `AuthenticateResponseAuthenticationMethod`
|
|
207
|
+
* Added `GrokOAuth` to `UserIdentitiesGetItemProvider`
|
|
208
|
+
* **[webhooks](https://workos.com/docs/reference/webhooks)**:
|
|
209
|
+
* Added `agent.registration.refreshed` to `CreateWebhookEndpointEvents`
|
|
210
|
+
* Added `agent.registration.refreshed` to `UpdateWebhookEndpointEvents`
|
|
211
|
+
|
|
212
|
+
**Fixes**
|
|
213
|
+
* **[pipes](https://workos.com/docs/reference/pipes)**:
|
|
214
|
+
* Changed the type of `DataIntegration.credentials`
|
|
215
|
+
* **[user_management](https://workos.com/docs/reference/authkit/user)**:
|
|
216
|
+
* Changed errors for endpoint `POST /user_management/authenticate`
|
|
217
|
+
* Changed errors for endpoint `POST /user_management/users`
|
|
218
|
+
* Changed errors for endpoint `PUT /user_management/users/{id}`
|
|
219
|
+
|
|
220
|
+
## [10.1.0](https://github.com/workos/workos-ruby/compare/v10.0.0...v10.1.0) (2026-07-28)
|
|
221
|
+
|
|
222
|
+
### Features
|
|
223
|
+
|
|
224
|
+
* replace hand-written URL builders with generated ones ([b162486](https://github.com/workos/workos-ruby/commit/b1624866137d8364dda1726b0302b70bed00a75c))
|
|
225
|
+
|
|
226
|
+
* [#531](https://github.com/workos/workos-ruby/pull/531) fix(generated): regenerate from spec
|
|
227
|
+
|
|
228
|
+
**Features**
|
|
229
|
+
* **[pipes](https://workos.com/docs/reference/pipes)**:
|
|
230
|
+
* Added `config` to `DataIntegrationsGetDataIntegrationAuthorizeUrlRequest`
|
|
231
|
+
* Added `client_credentials` to `DataIntegrationAuthMethods`
|
|
232
|
+
* Added `client_credentials` to `DataIntegrationsListResponseDataAuthMethods`
|
|
233
|
+
* Added `client_credentials` to `DataIntegrationsListResponseDataConnectedAccountAuthMethod`
|
|
234
|
+
* Added `config` to Pipes models
|
|
235
|
+
* **[connect](https://workos.com/docs/reference/workos-connect/standalone)**:
|
|
236
|
+
* Added `client_credentials` to `ConnectedAccountAuthMethod`
|
|
237
|
+
|
|
238
|
+
**Fixes**
|
|
239
|
+
* **[user_management](https://workos.com/docs/reference/authkit/user)**:
|
|
240
|
+
* Changed errors for endpoint `POST /user_management/invitations`
|
|
241
|
+
* Changed errors for endpoint `POST /user_management/invitations/{id}/resend`
|
|
242
|
+
* Changed errors for endpoint `POST /user_management/magic_auth`
|
|
243
|
+
* Changed errors for endpoint `POST /user_management/authenticate`
|
|
244
|
+
|
|
245
|
+
* [#532](https://github.com/workos/workos-ruby/pull/532) fix(generated): regenerate from spec
|
|
246
|
+
|
|
247
|
+
**Fixes**
|
|
248
|
+
* **[sso](https://workos.com/docs/reference/sso)**:
|
|
249
|
+
* Removed `callback_endpoint` from `Connection`
|
|
250
|
+
|
|
251
|
+
## [10.0.0](https://github.com/workos/workos-ruby/compare/v9.5.0...v10.0.0) (2026-07-22)
|
|
252
|
+
|
|
253
|
+
### Bug Fixes
|
|
254
|
+
|
|
255
|
+
* Preserve explicit nil in request bodies as JSON null ([#522](https://github.com/workos/workos-ruby/issues/522)) ([5b06e32](https://github.com/workos/workos-ruby/commit/5b06e329ffe25b97ac9299571586ce2ecdca4a96))
|
|
256
|
+
|
|
257
|
+
* [#524](https://github.com/workos/workos-ruby/pull/524) feat(generated)!: regenerate from spec (3 changes)
|
|
258
|
+
|
|
259
|
+
**Features**
|
|
260
|
+
* **agents**:
|
|
261
|
+
* Added model `ClaimViewResponse`
|
|
262
|
+
* Added model `ClaimViewResponseOrganization`
|
|
263
|
+
* Added model `AgentAdminLinkClaimAttemptToExternalUserRequest`
|
|
264
|
+
* Added model `AgentAdminLinkClaimAttemptToExternalUserRequestUser`
|
|
265
|
+
* Added enum `ClaimViewResponseStatus`
|
|
266
|
+
* Added endpoint `PATCH /agents/claims/attempts`
|
|
267
|
+
* Added model `AgentRegistration`
|
|
268
|
+
* Added model `AgentCredentialValidation`
|
|
269
|
+
* Added model `AgentRegistrationAgentIdentity`
|
|
270
|
+
* Added model `AgentRegistrationClaim`
|
|
271
|
+
* Added model `AgentAdminValidateCredentialRequest`
|
|
272
|
+
* Added model `AgentRegistrationClaimClaimCompletion`
|
|
273
|
+
* Added enum `AgentRegistrationStatus`
|
|
274
|
+
* Added enum `AgentRegistrationKind`
|
|
275
|
+
* Added enum `AgentAdminValidateCredentialRequestType`
|
|
276
|
+
* Added service `Agents`
|
|
277
|
+
* **[api_keys](https://workos.com/docs/reference/authkit/api-keys)**:
|
|
278
|
+
* Added `agent_registration_id` to `ApiKeyValidationResponse`
|
|
279
|
+
* **[connect](https://workos.com/docs/reference/workos-connect/standalone)**:
|
|
280
|
+
* Added enum `ApplicationsRegistrationTypes`
|
|
281
|
+
* Added parameter `Applications.list.registration_types`
|
|
282
|
+
* **[directory_sync](https://workos.com/docs/reference/directory-sync)**:
|
|
283
|
+
* Added parameter `DirectoryUsers.list.idp_id`
|
|
284
|
+
* Added parameter `DirectoryUsers.list.email`
|
|
285
|
+
* **[organizations](https://workos.com/docs/reference/organization)**:
|
|
286
|
+
* Added model `OrganizationAuthorizedConnectApplicationList`
|
|
287
|
+
* Added model `OrganizationAuthorizedConnectApplicationListData`
|
|
288
|
+
* Added model `OrganizationAuthorizedConnectApplicationListListMetadata`
|
|
289
|
+
* Added service `OrganizationsAuthorizedApplications`
|
|
290
|
+
* **[pipes](https://workos.com/docs/reference/pipes)**:
|
|
291
|
+
* Added model `DataIntegrationInstallation`
|
|
292
|
+
* Added `auth_methods` to `CreateDataIntegration`
|
|
293
|
+
* Added `api_key` to `CreateDataIntegration`
|
|
294
|
+
* Added `api_key` to `UpdateDataIntegration`
|
|
295
|
+
* Added `auth_methods` to `DataIntegration`
|
|
296
|
+
* Added `installation` to `DataIntegration`
|
|
297
|
+
* Added enum `CreateDataIntegrationAuthMethods`
|
|
298
|
+
* Added enum `DataIntegrationAuthMethods`
|
|
299
|
+
* Added model `DataIntegrationCredentialsResponse`
|
|
300
|
+
* Added model `DataIntegrationCredentialsResponseCredential`
|
|
301
|
+
* Added model `DataIntegrationsUpsertApiKeyRequest`
|
|
302
|
+
* Added model `DataIntegrationsVendCredentialsRequest`
|
|
303
|
+
* Added enum `DataIntegrationCredentialsResponseError`
|
|
304
|
+
* Added endpoint `PUT /data-integrations/{slug}/api-key`
|
|
305
|
+
* Added endpoint `POST /data-integrations/{slug}/credentials`
|
|
306
|
+
* **[sso](https://workos.com/docs/reference/sso)**:
|
|
307
|
+
* Added parameter `SSO.authorize.prompt`
|
|
308
|
+
* **[user_management](https://workos.com/docs/reference/authkit/user)**:
|
|
309
|
+
* Added `ssha256` to `CreateUserPasswordHashType`
|
|
310
|
+
* Added `ssha256` to `UpdateUserPasswordHashType`
|
|
311
|
+
* Added endpoint `GET /user_management/radar_challenges/{id}`
|
|
312
|
+
* **[webhooks](https://workos.com/docs/reference/webhooks)**:
|
|
313
|
+
* Added `agent.registration.revoked` to `CreateWebhookEndpointEvents`
|
|
314
|
+
* Added `agent.registration.revoked` to `UpdateWebhookEndpointEvents`
|
|
315
|
+
* Added `agent.registration.deleted` to `CreateWebhookEndpointEvents`
|
|
316
|
+
* Added `agent.registration.deleted` to `UpdateWebhookEndpointEvents`
|
|
317
|
+
* Added `radar.challenge_created` to `CreateWebhookEndpointEvents`
|
|
318
|
+
* Added `radar.challenge_created` to `UpdateWebhookEndpointEvents`
|
|
319
|
+
* Added `agent.registration.expired` to `CreateWebhookEndpointEvents`
|
|
320
|
+
* Added `agent.registration.expired` to `UpdateWebhookEndpointEvents`
|
|
321
|
+
* **[widgets](https://workos.com/docs/reference/widgets)**:
|
|
322
|
+
* Made `WidgetSessionToken.organization_id` optional
|
|
323
|
+
|
|
324
|
+
* [#527](https://github.com/workos/workos-ruby/pull/527) feat(generated)!: regenerate from spec (5 changes)
|
|
325
|
+
|
|
326
|
+
**⚠️ Breaking**
|
|
327
|
+
* **[admin_portal](https://workos.com/docs/reference/admin-portal)**:
|
|
328
|
+
* SDK surface change: Symbol "IntentOptions" was removed
|
|
329
|
+
* **[connect](https://workos.com/docs/reference/workos-connect/standalone)**:
|
|
330
|
+
* SDK surface change: Symbol "ConnectedAccountDto" was removed
|
|
331
|
+
* **[organization_domains](https://workos.com/docs/reference/domain-verification)**:
|
|
332
|
+
* SDK surface change: Symbol "DomainVerificationIntentOptions" was removed
|
|
333
|
+
* **[pipes](https://workos.com/docs/reference/pipes)**:
|
|
334
|
+
* SDK surface change: Symbol "DataIntegrationCredentialsDto" was removed
|
|
335
|
+
* **[sso](https://workos.com/docs/reference/sso)**:
|
|
336
|
+
* SDK surface change: Symbol "SSOIntentOptions" was removed
|
|
9
337
|
|
|
10
338
|
## [9.5.0](https://github.com/workos/workos-ruby/compare/v9.4.0...v9.5.0) (2026-07-06)
|
|
11
339
|
|
data/Gemfile.lock
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
PATH
|
|
2
2
|
remote: .
|
|
3
3
|
specs:
|
|
4
|
-
workos (
|
|
4
|
+
workos (10.3.0)
|
|
5
5
|
jwt (~> 3.1)
|
|
6
6
|
logger (~> 1.7)
|
|
7
7
|
zeitwerk (~> 2.6)
|
|
@@ -153,7 +153,7 @@ CHECKSUMS
|
|
|
153
153
|
unicode-emoji (4.2.0) sha256=519e69150f75652e40bf736106cfbc8f0f73aa3fb6a65afe62fefa7f80b0f80f
|
|
154
154
|
webmock (3.26.2) sha256=774556f2ea6371846cca68c01769b2eac0d134492d21f6d0ab5dd643965a4c90
|
|
155
155
|
webrick (1.9.2) sha256=beb4a15fc474defed24a3bda4ffd88a490d517c9e4e6118c3edce59e45864131
|
|
156
|
-
workos (
|
|
156
|
+
workos (10.3.0)
|
|
157
157
|
yard (0.9.44) sha256=eb087e9b631ccd887b049f303d489963945452d5e2a7eb49a5a74a7cf6887f28
|
|
158
158
|
yard-markdown (0.7.1) sha256=06c378632dfe7ba053be9ba469eb4701aa0470e36bcf7e5546f353eb90c1bfd1
|
|
159
159
|
zeitwerk (2.7.5) sha256=d8da92128c09ea6ec62c949011b00ed4a20242b255293dd66bf41545398f73dd
|
data/README.md
CHANGED
|
@@ -25,13 +25,7 @@ gem "workos"
|
|
|
25
25
|
|
|
26
26
|
## Configuration
|
|
27
27
|
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
```sh
|
|
31
|
-
WORKOS_API_KEY=sk_test_123 WORKOS_CLIENT_ID=client_123 ruby app.rb
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
Or configure the SDK in an initializer:
|
|
28
|
+
Store your WorkOS API key (and, for AuthKit and SSO flows, your client ID) in environment variables such as `WORKOS_API_KEY` and `WORKOS_CLIENT_ID`, then pass them to the SDK explicitly. The SDK does not read these environment variables automatically — configure it in an initializer:
|
|
35
29
|
|
|
36
30
|
```ruby
|
|
37
31
|
# /config/initializers/workos.rb
|
|
@@ -77,6 +71,7 @@ tenant_b.organizations.list_organizations
|
|
|
77
71
|
```ruby
|
|
78
72
|
public_client = WorkOS::PublicClient.create(client_id: "client_123")
|
|
79
73
|
url, verifier, state = public_client.user_management.get_authorization_url_with_pkce(
|
|
74
|
+
provider: "authkit",
|
|
80
75
|
redirect_uri: "https://example.com/callback"
|
|
81
76
|
)
|
|
82
77
|
```
|
|
@@ -93,20 +88,22 @@ on_worker_boot { WorkOS.reset_client }
|
|
|
93
88
|
|
|
94
89
|
## Per-request options
|
|
95
90
|
|
|
96
|
-
Every
|
|
91
|
+
Every method that makes an HTTP request accepts `request_options:` for per-call overrides (local URL-building helpers such as `get_authorization_url` and `get_logout_url` do not):
|
|
97
92
|
|
|
98
93
|
```ruby
|
|
99
94
|
organization = WorkOS.client.organizations.get_organization(
|
|
100
95
|
id: "org_123",
|
|
101
96
|
request_options: {
|
|
102
97
|
timeout: 10,
|
|
103
|
-
extra_headers: {"X-Request-Source" => "admin"}
|
|
104
|
-
idempotency_key: "org-create-123"
|
|
98
|
+
extra_headers: {"X-Request-Source" => "admin"}
|
|
105
99
|
}
|
|
106
100
|
)
|
|
107
101
|
```
|
|
108
102
|
|
|
109
|
-
`Idempotency-Key` is only sent when you provide `request_options[:idempotency_key]`, or when the SDK retries
|
|
103
|
+
`Idempotency-Key` is only sent on `POST`, `PUT`, and `PATCH` requests — either when you provide `request_options[:idempotency_key]`, or auto-generated when the SDK retries one of those requests after a transient failure. It is never attached to `GET` or `DELETE` requests.
|
|
104
|
+
|
|
105
|
+
> [!NOTE]
|
|
106
|
+
> The WorkOS API currently honors `Idempotency-Key` only on the [Create Audit Log Event](https://workos.com/docs/reference/audit-logs/event) endpoint (`audit_logs.create_event`). Other endpoints accept the header but do not deduplicate requests, so a retried mutation elsewhere can still create a duplicate.
|
|
110
107
|
|
|
111
108
|
## Usage Examples
|
|
112
109
|
|
|
@@ -155,8 +152,8 @@ ruby -rsecurerandom -e 'puts SecureRandom.base64(32)'
|
|
|
155
152
|
```
|
|
156
153
|
|
|
157
154
|
Anything shorter than 32 bytes (including `nil` or `""`) raises
|
|
158
|
-
`ArgumentError`
|
|
159
|
-
proceed with a weakened key.
|
|
155
|
+
`ArgumentError` as soon as you load, seal, or unseal a session — sealing or
|
|
156
|
+
unsealing will not silently proceed with a weakened key.
|
|
160
157
|
|
|
161
158
|
### Verify a webhook
|
|
162
159
|
|
|
@@ -196,7 +193,9 @@ end
|
|
|
196
193
|
|
|
197
194
|
## Error Handling
|
|
198
195
|
|
|
199
|
-
The SDK raises typed errors for API
|
|
196
|
+
The SDK raises typed errors for API failures (`WorkOS::APIError` and
|
|
197
|
+
subclasses) and transport failures (`WorkOS::APIConnectionError`). Both
|
|
198
|
+
inherit from `WorkOS::Error`.
|
|
200
199
|
|
|
201
200
|
```ruby
|
|
202
201
|
begin
|
|
@@ -204,6 +203,8 @@ begin
|
|
|
204
203
|
rescue WorkOS::APIError => e
|
|
205
204
|
warn "#{e.class}: #{e.message}"
|
|
206
205
|
warn "status=#{e.http_status} request_id=#{e.request_id} code=#{e.code}"
|
|
206
|
+
rescue WorkOS::APIConnectionError => e
|
|
207
|
+
warn "connection failure: #{e.message}"
|
|
207
208
|
end
|
|
208
209
|
```
|
|
209
210
|
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# This file is auto-generated by oagen. Do not edit.
|
|
4
|
+
|
|
5
|
+
module WorkOS
|
|
6
|
+
class AgentAdminLinkClaimAttemptToExternalUserRequest < WorkOS::Types::BaseModel
|
|
7
|
+
HASH_ATTRS = {
|
|
8
|
+
type: :type,
|
|
9
|
+
claim_attempt_token: :claim_attempt_token,
|
|
10
|
+
user: :user,
|
|
11
|
+
organization_id: :organization_id
|
|
12
|
+
}.freeze
|
|
13
|
+
|
|
14
|
+
attr_accessor \
|
|
15
|
+
:type,
|
|
16
|
+
:claim_attempt_token,
|
|
17
|
+
:user,
|
|
18
|
+
:organization_id
|
|
19
|
+
|
|
20
|
+
def initialize(json)
|
|
21
|
+
hash = self.class.normalize(json)
|
|
22
|
+
@type = hash[:type]
|
|
23
|
+
@claim_attempt_token = hash[:claim_attempt_token]
|
|
24
|
+
@user = hash[:user] ? WorkOS::AgentAdminLinkClaimAttemptToExternalUserRequestUser.new(hash[:user]) : nil
|
|
25
|
+
@organization_id = hash[:organization_id]
|
|
26
|
+
end
|
|
27
|
+
end
|
|
28
|
+
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# This file is auto-generated by oagen. Do not edit.
|
|
4
|
+
|
|
5
|
+
module WorkOS
|
|
6
|
+
class AgentAdminLinkClaimAttemptToExternalUserRequestUser < WorkOS::Types::BaseModel
|
|
7
|
+
HASH_ATTRS = {
|
|
8
|
+
email: :email,
|
|
9
|
+
external_id: :external_id
|
|
10
|
+
}.freeze
|
|
11
|
+
|
|
12
|
+
attr_accessor \
|
|
13
|
+
:email,
|
|
14
|
+
:external_id
|
|
15
|
+
|
|
16
|
+
def initialize(json)
|
|
17
|
+
hash = self.class.normalize(json)
|
|
18
|
+
@email = hash[:email]
|
|
19
|
+
@external_id = hash[:external_id]
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# This file is auto-generated by oagen. Do not edit.
|
|
4
|
+
|
|
5
|
+
module WorkOS
|
|
6
|
+
class AgentAdminValidateCredentialRequest < WorkOS::Types::BaseModel
|
|
7
|
+
HASH_ATTRS = {
|
|
8
|
+
type: :type,
|
|
9
|
+
credential: :credential,
|
|
10
|
+
audience: :audience
|
|
11
|
+
}.freeze
|
|
12
|
+
|
|
13
|
+
attr_accessor \
|
|
14
|
+
:type,
|
|
15
|
+
:credential,
|
|
16
|
+
:audience
|
|
17
|
+
|
|
18
|
+
def initialize(json)
|
|
19
|
+
hash = self.class.normalize(json)
|
|
20
|
+
@type = hash[:type]
|
|
21
|
+
@credential = hash[:credential]
|
|
22
|
+
@audience = hash[:audience]
|
|
23
|
+
end
|
|
24
|
+
end
|
|
25
|
+
end
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# This file is auto-generated by oagen. Do not edit.
|
|
4
|
+
|
|
5
|
+
module WorkOS
|
|
6
|
+
class AgentBlueprint < WorkOS::Types::BaseModel
|
|
7
|
+
HASH_ATTRS = {
|
|
8
|
+
object: :object,
|
|
9
|
+
id: :id,
|
|
10
|
+
name: :name,
|
|
11
|
+
description: :description,
|
|
12
|
+
permissions: :permissions,
|
|
13
|
+
invocable_by: :invocable_by,
|
|
14
|
+
session_settings: :session_settings,
|
|
15
|
+
created_at: :created_at,
|
|
16
|
+
updated_at: :updated_at
|
|
17
|
+
}.freeze
|
|
18
|
+
|
|
19
|
+
attr_accessor \
|
|
20
|
+
:object,
|
|
21
|
+
:id,
|
|
22
|
+
:name,
|
|
23
|
+
:description,
|
|
24
|
+
:permissions,
|
|
25
|
+
:invocable_by,
|
|
26
|
+
:session_settings,
|
|
27
|
+
:created_at,
|
|
28
|
+
:updated_at
|
|
29
|
+
|
|
30
|
+
def initialize(json)
|
|
31
|
+
hash = self.class.normalize(json)
|
|
32
|
+
@object = hash[:object]
|
|
33
|
+
@id = hash[:id]
|
|
34
|
+
@name = hash[:name]
|
|
35
|
+
@description = hash[:description]
|
|
36
|
+
@permissions = hash[:permissions] || []
|
|
37
|
+
@invocable_by = hash[:invocable_by] ? WorkOS::AgentBlueprintInvocableBy.new(hash[:invocable_by]) : nil
|
|
38
|
+
@session_settings = hash[:session_settings] ? WorkOS::AgentBlueprintSessionSetting.new(hash[:session_settings]) : nil
|
|
39
|
+
@created_at = hash[:created_at]
|
|
40
|
+
@updated_at = hash[:updated_at]
|
|
41
|
+
end
|
|
42
|
+
end
|
|
43
|
+
end
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# This file is auto-generated by oagen. Do not edit.
|
|
4
|
+
|
|
5
|
+
module WorkOS
|
|
6
|
+
class AgentBlueprintSessionSetting < WorkOS::Types::BaseModel
|
|
7
|
+
HASH_ATTRS = {
|
|
8
|
+
max_age_seconds: :max_age_seconds,
|
|
9
|
+
access_token_ttl_seconds: :access_token_ttl_seconds,
|
|
10
|
+
refresh_token_ttl_seconds: :refresh_token_ttl_seconds
|
|
11
|
+
}.freeze
|
|
12
|
+
|
|
13
|
+
attr_accessor \
|
|
14
|
+
:max_age_seconds,
|
|
15
|
+
:access_token_ttl_seconds,
|
|
16
|
+
:refresh_token_ttl_seconds
|
|
17
|
+
|
|
18
|
+
def initialize(json)
|
|
19
|
+
hash = self.class.normalize(json)
|
|
20
|
+
@max_age_seconds = hash[:max_age_seconds]
|
|
21
|
+
@access_token_ttl_seconds = hash[:access_token_ttl_seconds]
|
|
22
|
+
@refresh_token_ttl_seconds = hash[:refresh_token_ttl_seconds]
|
|
23
|
+
end
|
|
24
|
+
end
|
|
25
|
+
end
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# This file is auto-generated by oagen. Do not edit.
|
|
4
|
+
|
|
5
|
+
module WorkOS
|
|
6
|
+
class AgentBlueprintsCreateRequest < WorkOS::Types::BaseModel
|
|
7
|
+
HASH_ATTRS = {
|
|
8
|
+
name: :name,
|
|
9
|
+
description: :description,
|
|
10
|
+
permissions: :permissions,
|
|
11
|
+
invocable_by: :invocable_by,
|
|
12
|
+
session_settings: :session_settings
|
|
13
|
+
}.freeze
|
|
14
|
+
|
|
15
|
+
attr_accessor \
|
|
16
|
+
:name,
|
|
17
|
+
:description,
|
|
18
|
+
:permissions,
|
|
19
|
+
:invocable_by,
|
|
20
|
+
:session_settings
|
|
21
|
+
|
|
22
|
+
def initialize(json)
|
|
23
|
+
hash = self.class.normalize(json)
|
|
24
|
+
@name = hash[:name]
|
|
25
|
+
@description = hash[:description]
|
|
26
|
+
@permissions = hash[:permissions] || []
|
|
27
|
+
@invocable_by = hash[:invocable_by] ? WorkOS::AgentBlueprintsCreateRequestInvocableBy.new(hash[:invocable_by]) : nil
|
|
28
|
+
@session_settings = hash[:session_settings] ? WorkOS::AgentBlueprintsCreateRequestSessionSetting.new(hash[:session_settings]) : nil
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
end
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# This file is auto-generated by oagen. Do not edit.
|
|
4
|
+
|
|
5
|
+
module WorkOS
|
|
6
|
+
class AgentBlueprintsCreateRequestInvocableBy < WorkOS::Types::BaseModel
|
|
7
|
+
HASH_ATTRS = {
|
|
8
|
+
role_slugs: :role_slugs,
|
|
9
|
+
organization_ids: :organization_ids
|
|
10
|
+
}.freeze
|
|
11
|
+
|
|
12
|
+
attr_accessor \
|
|
13
|
+
:role_slugs,
|
|
14
|
+
:organization_ids
|
|
15
|
+
|
|
16
|
+
def initialize(json)
|
|
17
|
+
hash = self.class.normalize(json)
|
|
18
|
+
@role_slugs = hash[:role_slugs] || []
|
|
19
|
+
@organization_ids = hash[:organization_ids] || []
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|