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

December 2, 2025

v5.30.1

Latest
December 2, 2025

What's Changed

  • Version bump v5.30.1 by @kendallstrautman in #412
  • Multiple roles support: Add roles to SSO profile and directory user by @kendallstrautman in #411

Full Changelog: v5.29.0...v5.30.1

December 2, 2025

v5.30.0

December 2, 2025

⚠️ Misconfigured release version. Use v5.30.1 instead

In this version, the package semver was not updated properly and still references v5.29.0

What's Changed

  • Multiple roles support: Add roles to SSO profile and directory user by @kendallstrautman in #411

Full Changelog: v5.29.0...v5.30.0

November 21, 2025

v5.29.0

November 21, 2025

What's Changed

  • expose authentication object even if expired by @ollym in #398

New Contributors

  • @ollym made their first contribution in #398

Full Changelog: v5.28.0...v5.29.0

November 20, 2025

v5.28.0

November 20, 2025

What's Changed

  • Add ability to resend invitations by @antn in #404
  • Fix reset_password to handle wrapped API response by @nicknisi in #406

New Contributors

  • @antn made their first contribution in #404

Full Changelog: v5.27.0...v5.28.0

October 27, 2025

v5.27.0

October 27, 2025

What's Changed

  • Added locale to user (#400)

Full Changelog: v5.26.0...v5.27.0

October 10, 2025

v5.26.0

October 10, 2025

What's Changed

  • Add SSO and Domain Verification widget scopes by @adam-h in #396
  • AuthKit multiple roles support by @csrbarber in #397
  • Bump to 5.26.0 by @csrbarber in #399

New Contributors

  • @csrbarber made their first contribution in #397

Full Changelog: v5.25.0...v5.26.0

August 5, 2025

v5.25.0

August 5, 2025

What's Changed

  • Add GET /organizations/:orgId/feature-flags support by @stanleyphu in #391
  • v5.25.0 by @stanleyphu in #393

New Contributors

  • @stanleyphu made their first contribution in #391

Full Changelog: v5.24.0...v5.25.0

July 30, 2025

v5.24.0

July 30, 2025

What's Changed

  • Add screen_hint to Ruby Gem + vcr 6 by @Teyler7 in #389
  • v5.24.0 by @nholden in #390

Full Changelog: v5.23.0...v5.24.0

July 23, 2025

v5.23.0

July 23, 2025

What's Changed

  • Add external_id to user and organization in #381

Full Changelog: v5.22.0...v5.23.0

July 22, 2025

v5.22.0

July 22, 2025

What's Changed

  • Include decoded Feature Flags from the JWT into the payload of a WorkOS Session by @vdyalex in #386
  • Fix request body construction to only send non-nil values by @nicknisi in #384
  • Fix SSO error handling to surface detailed validation errors by @nicknisi in #385

New Contributors

  • @vdyalex made their first contribution in #386

Full Changelog: v5.21.0...v5.22.0

July 7, 2025

v5.21.0

July 7, 2025

What's Changed

  • user: allow updating external_id, add to User object by @mxlje in #378
  • Add permissions to Role by @andrewhampton in #382

New Contributors

  • @mxlje made their first contribution in #378
  • @andrewhampton made their first contribution in #382

Full Changelog: v5.20.0...v5.21.0

June 23, 2025

v5.20.0

June 23, 2025

What's Changed

  • Added support for custom OAuth scopes (#379)

Full Changelog: v5.19.0...v5.20.0

May 29, 2025

v5.19.0

May 29, 2025

What's Changed

  • add missing session param to authenticate_with methods by @jameslcarpino in #375

New Contributors

  • @jameslcarpino made their first contribution in #375

Full Changelog: v5.18.0...v5.19.0

May 22, 2025

v5.18.0

May 22, 2025

What's Changed

  • Added support for email in UserManagement.update_user (#365)
April 25, 2025

v5.17.1

April 25, 2025

What's Changed

  • Bump rexml from 3.2.6 to 3.4.1 by @alexandrule in #359
  • v5.17.1 by @nicknisi in #364

New Contributors

  • @alexandrule made their first contribution in #359

Full Changelog: v5.17.0...v5.17.1

April 24, 2025

v5.17.0

April 24, 2025

What's Changed

  • Add custom_attributes field to SSO Profile (#360)

Full Changelog: v5.16.1...v5.17.0

April 23, 2025

v5.16.1

April 23, 2025

What's Changed

  • Pin third-party actions to currently used SHA by @nickcollisson-workos in #357
  • Bump rexml from 3.2.6 to 3.3.3 by @dependabot in #318
  • v5.16.1 by @nicknisi in #362

New Contributors

  • @nickcollisson-workos made their first contribution in #357

Full Changelog: v5.16.0...v5.16.1

March 21, 2025

v5.16.0

March 21, 2025

What's Changed

  • Add email standard attribute to DirectoryUser
  • Mark emails, job_title, and username standard attributes as deprecated. Enable the equivalent auto-mapped custom attributes instead (#413)

Full Changelog: v5.15.0...v5.16.0

February 20, 2025

v5.15.0

February 20, 2025

What's Changed

  • Added last_sign_in_at to user (#352)

Full Changelog: v5.14.0...v5.15.0

February 13, 2025

v5.14.0

February 13, 2025

What's Changed

  • Add domain verification intent in admin portal link generation by @sahilbansal17 in #351
  • v5.14.0 by @nicknisi in #353

New Contributors

  • @sahilbansal17 made their first contribution in #351

Full Changelog: v5.13.0...v5.14.0

January 28, 2025

v5.13.0

January 28, 2025

What's Changed

Added

  • Add entitlements to session by @adam-h in #349

Full Changelog: v5.12.0...v5.13.0

January 23, 2025

v5.12.0

January 23, 2025

Added

  • update_organization stripe_customer_id param + .rbenv update by @Teyler7 in #346

Changed

  • Bump minimum required Ruby version to 3.1 by @dandorman in #347

Full Changelog: v5.11.1...v5.12.0

January 16, 2025

v5.11.1

January 16, 2025

Added

  • Add caching to JWKS fetch (#342)

Full Changelog: v5.11.0...v5.11.1

January 15, 2025

v5.11.0

January 15, 2025

Added

  • Added return_to param to UserManagement.get_logout_url (#343)

Full Changelog: v5.10.0...v5.11.0

January 6, 2025

v5.10.0

January 6, 2025

What's Changed

  • Add GET /organization/:orgId/roles API support (#338)
  • Add new ForbiddenRequestError (#339)

Full Changelog: v5.9.0...v5.10.0

November 15, 2024

v5.9.0

November 15, 2024

Added

  • Add get widget token API support (#332)

Full Changelog: v5.8.0...v5.9.0

October 16, 2024

v5.8.0

October 16, 2024

What's Changed

  • Add "role" to profile in #330

Full Changelog: v5.7.0...v5.8.0

August 29, 2024

v5.7.0

August 29, 2024

What's Changed

  • Session helper class by @PaulAsjes in #328

Full Changelog: v5.6.0...v5.7.0

August 19, 2024

v5.6.0

August 19, 2024

Added

  • Added certificate_renewal intent by @alisherry #326
August 9, 2024

v5.5.1

August 9, 2024

Fixed

  • Added missing Apple OAuth constants used for parameter validation (#323)