Ruby SDK

Installation

Ruby

 gem install workos

 gem "workos"

Releases

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

v4.1.0

March 20, 2024

Added

Add impersonator metadata to AuthenticationResponse (#268)

Add Session-related API's (#269)

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

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

v3.0.0

December 21, 2023

Added

Added support for all User Management APIs

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

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).

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).

v2.14.0

June 12, 2023

Added

Added Events API beta

v2.13.0

April 25, 2023

Added

Added created_at and updated_at to directory_user (#188)

v2.12.1

March 28, 2023

Fixed

Adds a generic default error to response handler for unaccounted for API response codes.

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)

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.

v2.10.0

December 8, 2022

Added

Add log_streams Admin Portal intent (https://github.com/workos/workos-ruby/pull/184)

v2.9.0

October 18, 2022

Added

Add success_url to generate_link (https://github.com/workos/workos-ruby/pull/180)

v2.8.0

October 12, 2022

Added

Added job title attribute for directory users (#178)

v2.7.0

September 16, 2022

Added

Added support for creating Admin Portal links for viewing Audit Logs (#176)

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)

v2.5.1

August 12, 2022

Fixed

Fixed backwards capability issue to only set write_timeout if Ruby version is greater than or equal to 2.6.0 (#169)

v2.5.0

July 25, 2022

Added

Added config initializer for key and timeout (#164)

Changed

Updated endpoints for MFA operations (#167)

v2.4.0

July 14, 2022

Added

Added organization_id to Directory User and Directory Group, Added directory_id to Directory User (#165)

v2.3.0

June 13, 2022

Added

Added order pagination parameter (#156)

Added idp_id, directory_id, created_at, updated_at, and raw_attributes to directory group (#157)

Added primary_email method for Directory User API (#161)

Changed

Removed environment_id fields (#155)

Required expires_at to not be nullable for authentication challenge (#158)

v2.2.1

April 28, 2022

Fixed

Fixed bug where we were returning inconsistent data types from list_users and get_user endpoints (#147)

v2.2.0

March 30, 2022

Added

Added support for MFA API (#144)

Added organization ID filter to list directories method (#142)

Added full type for get_timestamp_and_signature_hash (#140)

v2.1.1

January 14, 2022

Fixed

Fixed bug in webhook tolerance check (#138)

v2.1.0

December 16, 2021

Added

Added support for domain_hint and login_hint parameters to authorization_url (#136)

Added support for organization parameter to authorization_url (#135)

Deprecated

Deprecated the domain parameter for authorization_url in favor of organization (#135)

v2.0.0

November 12, 2021

Breaking Changes

The organization_id field on the following objects is now nullable (#129):

Connection

Directory

Profile

Added

Added DirectorySync.get_directory for retrieving a Directory by its ID (#132)

v1.6.1

November 3, 2021

Fixed

Fixed bug to make directory domain nullable (#130)

v1.6.0

September 23, 2021

Added

Added WorkOS::Webhooks module for verifying webhook signatures and timestamps (#113)

Added support for allow_profiles_outside_organization for organizations (#125)

Added organization_id to profiles (#126)

v1.5.1

September 1, 2021

Fixed

Fixed thread safety issues with HTTP client (#110)