WorkOS Docs Homepage
SDKs
API referenceDashboardSign In
SDKs

Ruby SDK

github.com
workos/workos-ruby
34 Stars
33 Forks
53 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

October 27, 2025

v5.27.0

Latest
October 27, 2025

What's Changed

  • Added locale to user (https://github.com/workos/workos-ruby/pull/400)

Full Changelog: https://github.com/workos/workos-ruby/compare/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 https://github.com/workos/workos-ruby/pull/396
  • AuthKit multiple roles support by @csrbarber in https://github.com/workos/workos-ruby/pull/397
  • Bump to 5.26.0 by @csrbarber in https://github.com/workos/workos-ruby/pull/399

New Contributors

  • @csrbarber made their first contribution in https://github.com/workos/workos-ruby/pull/397

Full Changelog: https://github.com/workos/workos-ruby/compare/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 https://github.com/workos/workos-ruby/pull/391
  • v5.25.0 by @stanleyphu in https://github.com/workos/workos-ruby/pull/393

New Contributors

  • @stanleyphu made their first contribution in https://github.com/workos/workos-ruby/pull/391

Full Changelog: https://github.com/workos/workos-ruby/compare/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 https://github.com/workos/workos-ruby/pull/389
  • v5.24.0 by @nholden in https://github.com/workos/workos-ruby/pull/390

Full Changelog: https://github.com/workos/workos-ruby/compare/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 https://github.com/workos/workos-ruby/pull/381

Full Changelog: https://github.com/workos/workos-ruby/compare/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 https://github.com/workos/workos-ruby/pull/386
  • Fix request body construction to only send non-nil values by @nicknisi in https://github.com/workos/workos-ruby/pull/384
  • Fix SSO error handling to surface detailed validation errors by @nicknisi in https://github.com/workos/workos-ruby/pull/385

New Contributors

  • @vdyalex made their first contribution in https://github.com/workos/workos-ruby/pull/386

Full Changelog: https://github.com/workos/workos-ruby/compare/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 https://github.com/workos/workos-ruby/pull/378
  • Add permissions to Role by @andrewhampton in https://github.com/workos/workos-ruby/pull/382

New Contributors

  • @mxlje made their first contribution in https://github.com/workos/workos-ruby/pull/378
  • @andrewhampton made their first contribution in https://github.com/workos/workos-ruby/pull/382

Full Changelog: https://github.com/workos/workos-ruby/compare/v5.20.0...v5.21.0

June 23, 2025

v5.20.0

June 23, 2025

What's Changed

  • Added support for custom OAuth scopes (https://github.com/workos/workos-ruby/pull/379)

Full Changelog: https://github.com/workos/workos-ruby/compare/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 https://github.com/workos/workos-ruby/pull/375

New Contributors

  • @jameslcarpino made their first contribution in https://github.com/workos/workos-ruby/pull/375

Full Changelog: https://github.com/workos/workos-ruby/compare/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 https://github.com/workos/workos-ruby/pull/359
  • v5.17.1 by @nicknisi in https://github.com/workos/workos-ruby/pull/364

New Contributors

  • @alexandrule made their first contribution in https://github.com/workos/workos-ruby/pull/359

Full Changelog: https://github.com/workos/workos-ruby/compare/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: https://github.com/workos/workos-ruby/compare/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 https://github.com/workos/workos-ruby/pull/357
  • Bump rexml from 3.2.6 to 3.3.3 by @dependabot in https://github.com/workos/workos-ruby/pull/318
  • v5.16.1 by @nicknisi in https://github.com/workos/workos-ruby/pull/362

New Contributors

  • @nickcollisson-workos made their first contribution in https://github.com/workos/workos-ruby/pull/357

Full Changelog: https://github.com/workos/workos-ruby/compare/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: https://github.com/workos/workos-ruby/compare/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: https://github.com/workos/workos-ruby/compare/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 https://github.com/workos/workos-ruby/pull/351
  • v5.14.0 by @nicknisi in https://github.com/workos/workos-ruby/pull/353

New Contributors

  • @sahilbansal17 made their first contribution in https://github.com/workos/workos-ruby/pull/351

Full Changelog: https://github.com/workos/workos-ruby/compare/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 https://github.com/workos/workos-ruby/pull/349

Full Changelog: https://github.com/workos/workos-ruby/compare/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 https://github.com/workos/workos-ruby/pull/346

Changed

  • Bump minimum required Ruby version to 3.1 by @dandorman in https://github.com/workos/workos-ruby/pull/347

Full Changelog: https://github.com/workos/workos-ruby/compare/v5.11.1...v5.12.0

January 16, 2025

v5.11.1

January 16, 2025

Added

  • Add caching to JWKS fetch (#342)

Full Changelog: https://github.com/workos/workos-ruby/compare/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: https://github.com/workos/workos-ruby/compare/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: https://github.com/workos/workos-ruby/compare/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: https://github.com/workos/workos-ruby/compare/v5.8.0...v5.9.0

October 16, 2024

v5.8.0

October 16, 2024

What's Changed

  • Add "role" to profile in https://github.com/workos/workos-ruby/pull/330

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

August 29, 2024

v5.7.0

August 29, 2024

What's Changed

  • Session helper class by @PaulAsjes in https://github.com/workos/workos-ruby/pull/328

Full Changelog: https://github.com/workos/workos-ruby/compare/v5.6.0...v5.7.0

August 19, 2024

v5.6.0

August 19, 2024

Added

  • Added certificate_renewal intent by @alisherry https://github.com/workos/workos-ruby/pull/326
August 9, 2024

v5.5.1

August 9, 2024

Fixed

  • Added missing Apple OAuth constants used for parameter validation (#323)
August 8, 2024

v5.5.0

August 8, 2024

Added

  • Add organization_id parameter to authenticate_with_refresh_token method (#321)

Changed

  • Make name optional when updating an Organization (#319)
August 5, 2024

v5.4.0

August 5, 2024

Added

  • Make name optional when updating an organization (#319)
July 19, 2024

v5.3.0

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