WorkOS Docs Homepage
SDKs
API referenceDashboardSign In
SDKs

Ruby SDK

github.com
workos/workos-ruby
29 Stars
15 Forks
38 Contributors
github.com
Official Ruby SDK for interacting with the WorkOS API.

Installation

Ruby

Beta Versions

Certain WorkOS features may be available only in the beta version of the SDK. Beta versions have the -beta.* suffix, for example, 3.2.0-beta.1. For more information on how to use the beta versions, refer to the README in the GitHub repository.

Releases

July 19, 2024

v5.3.0

Latest
July 19, 2024

Added

  • Support for Apple OAuth (https://github.com/workos/workos-ruby/pull/306)
June 26, 2024

v5.2.1

June 26, 2024

Fixed

  • update_organization_membership method fixes (https://github.com/workos/workos-ruby/pull/312/)
June 24, 2024

v5.2.0

June 24, 2024

Added

  • "role" property to organization memberships and directory users (https://github.com/workos/workos-ruby/pull/309)
June 20, 2024

v5.1.0

June 20, 2024

Deprecated

  • Marked the allow_profiles_outside_organization Organization parameter as deprecated (#307)
June 6, 2024

v5.0.0

June 6, 2024

This is a major release of the WorkOS Ruby SDK that may contain breaking changes for your application. Please carefully read these release notes and contact support@workos.com if you encounter any issues.

What's Changed

  • Add new error types and add data to error response by @PaulAsjes in https://github.com/workos/workos-ruby/pull/303
  • Remove "domain" from directory query params by @ameesha in https://github.com/workos/workos-ruby/pull/259
  • Make events parameter required for list_events by @mattgd in https://github.com/workos/workos-ruby/pull/282
  • Major bump to version 5.0.0 by @mattgd in https://github.com/workos/workos-ruby/pull/304
  • Add missing events parameter to test by @mattgd in https://github.com/workos/workos-ruby/pull/305

New Contributors

  • @PaulAsjes made their first contribution in https://github.com/workos/workos-ruby/pull/303
  • @ameesha made their first contribution in https://github.com/workos/workos-ruby/pull/259

Full Changelog: https://github.com/workos/workos-ruby/compare/v4.8.0...v5.0.0

June 4, 2024

v4.8.0

June 4, 2024

Added

  • Added support for totp_secret on user_management.enroll_auth_factor (#300)
  • Introduced user_management.find_invitation_by_token method (#301)
May 24, 2024

v4.7.0

May 24, 2024

Added

  • Added inviter_user_id to invitation object returned by API (#298)
  • Added new endpoints to the User Management API to support sending your own emails: get_email_verification, get_password_reset, and create_password_reset (#298)
  • Deprecation notice for the send_password_reset_email method in favor of create_password_reset (#298)
May 21, 2024

v4.6.0

May 21, 2024

Added

  • Add organization membership deactivate and reactivate API methods (#295)
May 3, 2024

v4.5.0

May 3, 2024

Added

  • Added accept_invitation_url to invitation object returned by API (#293)
  • Added new endpoints to the Magic Auth API: get_magic_auth and create_magic_auth (#293)
  • Deprecation notice for the send_magic_auth_code method in favor of create_magic_auth (#293)
May 1, 2024

v4.4.0

May 1, 2024

Added

  • Add domain_data to Organizations Create and Update methods to replace the now deprecated domains parameter (https://github.com/workos/workos-ruby/pull/291)
May 1, 2024

v4.3.0

May 1, 2024

Added

  • Document organization_id support in events (https://github.com/workos/workos-ruby/pull/289)
April 11, 2024

v4.2.1

April 11, 2024

Fixed

  • Fixed the revoke_session method which was not correctly including authorization headers (#283)

Full Changelog: https://github.com/workos/workos-ruby/compare/v4.2.0...v4.2.1

April 9, 2024

v4.2.0

April 9, 2024

What's Changed

  • Update os_image for rubygems workflow in https://github.com/workos/workos-ruby/pull/271
  • Remove Sorbet in https://github.com/workos/workos-ruby/pull/274
  • Support newer Ruby versions in https://github.com/workos/workos-ruby/pull/273
  • Migrate repo to use GitHub Actions in https://github.com/workos/workos-ruby/pull/272
  • Build and push new releases to RubyGems automatically in https://github.com/workos/workos-ruby/pull/276
  • Remove now-unused Semaphore and Devbox configs in https://github.com/workos/workos-ruby/pull/277
  • Add password_hash and password_hash_type to User creation in https://github.com/workos/workos-ruby/pull/278
  • Remove Codecov in https://github.com/workos/workos-ruby/pull/281
  • Add role_slug to send invitation API in https://github.com/workos/workos-ruby/pull/280

Full Changelog: https://github.com/workos/workos-ruby/compare/v4.1.0...v4.2.0

March 20, 2024

v4.1.0

March 20, 2024

Added

  • Add impersonator metadata to AuthenticationResponse (#268)
  • Add Session-related API's (#269)
March 8, 2024

v4.0.0

March 8, 2024

Changed

  • Changed all resource list methods to default to descending order (#265)

Addded

  • Added status to organization membership (#264)

Full Changelog: https://github.com/workos/workos-ruby/compare/v3.1.0...v4.0.0

February 7, 2024

v3.1.0

February 7, 2024

Added

  • Add profile_picture_url attribute to the User object by @mthadley in https://github.com/workos/workos-ruby/pull/260

Full Changelog: https://github.com/workos/workos-ruby/compare/v3.0.0...v3.1.0

December 21, 2023

v3.0.0

December 21, 2023

Added

December 14, 2023

v2.17.0

December 14, 2023

Added

  • Added GitHub provider for to WorkOS::SSO.authorization_url (https://github.com/workos/workos-ruby/pull/250)

Changed

  • Made WorkOS environment variables load lazily (https://github.com/workos/workos-ruby/pull/203)
  • Stopped including development executables (https://github.com/workos/workos-ruby/pull/229
July 13, 2023

v2.16.0

July 13, 2023

Changed

  • Changed the Events API (in beta) to fetch list metadata using list_metadata instead of listMetadata (deprecated) (https://github.com/workos/workos-ruby/pull/204).
June 26, 2023

v2.15.0

June 26, 2023

Added

  • Added actor_ids, and actor_names parameters to auditLogs.createExport method, deprecated actors (https://github.com/workos/workos-ruby/pull/197).

Changed

  • Changed the Events API (in beta) rangeStart and rangeEnd parameters to range_start and range_end(https://github.com/workos/workos-ruby/pull/200).
June 12, 2023

v2.14.0

June 12, 2023

Added

  • Added Events API beta
April 25, 2023

v2.13.0

April 25, 2023

Added

  • Added created_at and updated_at to directory_user (#188)
March 28, 2023

v2.12.1

March 28, 2023

Fixed

  • Adds a generic default error to response handler for unaccounted for API response codes.
March 7, 2023

v2.12.0

March 7, 2023

Added

  • Added groups attribute to SSO user profile. This feature is in beta, please reach out to support@workos.com to access this feature. (#188)
February 10, 2023

v2.11.0

February 10, 2023

Updated

  • Migrate from Sorbet to tapioca for RBIs (https://github.com/workos/workos-ruby/pull/186)

Fixed

  • Tapioca RBIs fix an issue where the gem failed to install on NTFS partitions due to reserved character usage.
December 8, 2022

v2.10.0

December 8, 2022

Added

  • Add log_streams Admin Portal intent (https://github.com/workos/workos-ruby/pull/184)
October 18, 2022

v2.9.0

October 18, 2022

Added

  • Add success_url to generate_link (https://github.com/workos/workos-ruby/pull/180)
October 12, 2022

v2.8.0

October 12, 2022

Added

  • Added job title attribute for directory users (#178)
September 16, 2022

v2.7.0

September 16, 2022

Added

  • Added support for creating Admin Portal links for viewing Audit Logs (#176)
September 15, 2022

v2.6.0

September 15, 2022

Added

  • Added idempotency_key parameter to the create_organization method (#173)
  • Added Audit Logs module (#175)

Updated

  • Uncovered private methods in Webhooks class (#171)
  • Updated sorbet (#174)