Releases: workos/workos-ruby
v7.0.0
This is a major release that introduces a fully redesigned SDK architecture. The SDK is now generated from the WorkOS OpenAPI spec, bringing type safety, consistent interfaces, and improved developer ergonomics.
High-Level Changes
-
Client-centric architecture: The SDK now revolves around an instantiated
WorkOS::Clientrather than module-level service calls. All product areas are accessed through client methods (e.g.,client.organizations,client.user_management,client.sso). -
Generated request/response models: Typed models replace raw hashes. Response models no longer inherit from
Hash— use accessor methods instead of bracket notation. -
Per-request overrides: The new runtime supports
request_options:for per-request API key, timeout, base URL, and retry overrides — useful for multi-tenant setups. -
Minimum Ruby 3.3+: The minimum Ruby version has been raised to 3.3.
-
Renamed services and methods: Several top-level services were renamed (e.g.,
WorkOS::Portal→client.admin_portal,WorkOS::MFA→client.multi_factor_auth). Method signatures now use explicit keyword arguments. -
Session management refactor: AuthKit session sealing, refresh, and authentication flows were overhauled with a dedicated
SessionManageron the client instance. -
New capabilities: Device code flow, public/PKCE clients,
auto_paging_eachpagination, andlast_responseobservability on all responses.
Migration Guide
For detailed instructions on updating your application, see the v7 Migration Guide.
v6.2.0
v6.1.0
See CHANGELOG.md for details
What's Changed
- Add release-please for automated releases by @workos-sdk-automation[bot] in #435
- fix: add
invitation_tokenparameter to authentication methods by @gjtorikian in #438 - Update amannn/action-semantic-pull-request action to v6 by @renovate[bot] in #436
- chore(main): release workos 6.1.0 by @workos-sdk-automation[bot] in #437
- fix: use simple v-prefixed tags and fix gem publish path by @workos-sdk-automation[bot] in #441
- fix: revert VERSION extraction to handle simple v-prefixed tags by @workos-sdk-automation[bot] in #442
Full Changelog: v6.0.0...v6.1.0
v6.0.0
What's Changed
- Add Rakefile to fix release workflow by @workos-sdk-automation[bot] in #426
- Use gem-push-command to skip git push in release workflow by @workos-sdk-automation[bot] in #427
- Fix release workflow to use OIDC credentials directly by @workos-sdk-automation[bot] in #429
- Update actions/create-github-app-token action to v2 by @renovate[bot] in #422
- Update peter-evans/create-pull-request action to v8 by @renovate[bot] in #424
- Add ability to extract custom claims from the JWT during authentication by @adam-h in #431
- Upgrade jwt gem from ~> 2.8 to ~> 3.1 by @workos-sdk-automation[bot] in #433
- Allow pluggable encryptors for session seal/unseal by @gjtorikian in #432
- v6.0.0 by @workos-sdk-automation[bot] in #434
Full Changelog: v5.31.1...v6.0.0
v5.31.1
What's Changed
- Add custom_attributes field to OrganizationMembership by @ajworkos in #419
- v5.31.1 by @workos-sdk-automation[bot] in #420
- Update actions/checkout action to v6 by @renovate[bot] in #421
- Add rake as a development dependency by @gjtorikian in #423
New Contributors
Full Changelog: v5.31.0...v5.31.1
v5.31.0
What's Changed
- Add context7.json to repo by @nicknisi in #413
- Update ruby/setup-ruby action to v1.281.0 by @renovate[bot] in #358
- Update actions/checkout action to v6 by @renovate[bot] in #409
- Update CODEOWNERS to point to the right Rubyist Team by @gjtorikian in #416
- Bump rexml from 3.4.1 to 3.4.2 by @dependabot[bot] in #395
- Add list sessions to user management by @adam-h in #415
- 💎 5.31.0 by @gjtorikian in #418
New Contributors
- @gjtorikian made their first contribution in #416
Full Changelog: v5.30.1...v5.31.0
v5.30.1
What's Changed
- Version bump v5.30.1 by @kendallstrautman in #412
- Multiple roles support: Add
rolesto SSO profile and directory user by @kendallstrautman in #411
Full Changelog: v5.29.0...v5.30.1
v5.30.0
⚠️ 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
rolesto SSO profile and directory user by @kendallstrautman in #411
Full Changelog: v5.29.0...v5.30.0