Installation

Java

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 3, 2025

v4.18.1

Latest
December 3, 2025

What's Changed

  • Bump version 4.18.1 by @kendallstrautman in #304
  • Multiple roles support: Add roles property to directory user and SSO profile by @kendallstrautman in #302

Full Changelog: v4.17.0...v4.18.1

December 2, 2025

v4.18.0

December 2, 2025

⚠️ Misconfigured release version. Use v4.18.1 instead

In this version, the package semver was not updated properly and still references v4.17.0

What's Changed

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

Full Changelog: v4.17.0...v4.18.0

November 21, 2025

v4.17.0

November 21, 2025

What's Changed

  • Add ability to resend invitation by @antn in #299

New Contributors

  • @antn made their first contribution in #299

Full Changelog: v4.16.0...v4.17.0

October 10, 2025

v4.16.0

October 10, 2025

What's Changed

  • Update Nexus publishing endpoints by @nicknisi in #296
  • Add multiple roles support for OrganizationMemberships by @csrbarber in #295
  • v4.16.0 by @csrbarber in #297

New Contributors

  • @csrbarber made their first contribution in #295

Full Changelog: v4.15.0...v4.16.0

September 29, 2025

v4.15.0

September 29, 2025

Added

  • Added Events API Support (#292)
  • Added Invitation Accepted, Revoked Events (#291)

Fixed

  • Fixed OAuth error response mapping for authentication endpoints (#290)
June 23, 2025

v4.14.0

June 23, 2025

What's Changed

  • Added email to UpdateUserOptions (#281)
  • Added user webhook events (#284)
  • Added support for custom scopes (#285)

Full Changelog: v4.13.0...v4.14.0

May 20, 2025

v4.13.0

May 20, 2025

What's Changed

  • adding "deleting" to connectionState enums by @rarevalo13 in #278
  • Add warnings to FGA check and query responses by @atainter in #280
  • Bump to v4.13.0 by @rarevalo13 in #279

New Contributors

  • @rarevalo13 made their first contribution in #278
  • @atainter made their first contribution in #280

Full Changelog: v4.12.0...v4.13.0

May 2, 2025

v4.12.0

May 2, 2025

What's Changed

  • Add customAttributes field to SSO Profile (#275)

Full Changelog: v4.11.0...v4.12.0

April 10, 2025

v4.11.0

April 10, 2025

What's Changed

  • Added password_reset.succeeded event type (#273)

Full Changelog: v4.10.0...v4.11.0

March 28, 2025

v4.10.0

March 28, 2025

What's Changed

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

Full Changelog: v4.9.0...v4.10.0

February 21, 2025

v4.9.0

February 21, 2025

What's Changed

  • Added state, verificationStrategy, and verificationToken to OrganizationDomain (#266)
  • Added lastSignInAt to User (#268)

Full Changelog: v4.8.0...v4.9.0

January 15, 2025

v4.8.0

January 15, 2025

Added

  • Added optional returnTo parameter to getLogoutUrl (#264)

Full Changelog: v4.7.0...v4.8.0

January 6, 2025

v4.7.0

January 6, 2025

Added

  • Add GET /organization/:orgId/roles API support (#262)

Full Changelog: v4.6.1...v4.7.0

December 11, 2024

v4.6.1

December 11, 2024

Fixed

  • Make role attribute optional on directorysync.models.User by @jonatascastro12 in #259

Full Changelog: v4.6.0...v4.6.1

November 15, 2024

v4.6.0

November 15, 2024

Added

  • Add widgets get token API support (#257)

Full Changelog: v4.5.0...v4.6.0

October 21, 2024

v4.5.0

October 21, 2024

What's Changed

  • Add role to directory user by @kendallstrautman in #254

Full Changelog: v4.4.0...v4.5.0

October 17, 2024

v4.4.0

October 17, 2024

What's Changed

  • Add ProfileRole property in #252

Full Changelog: v4.3.1...v4.4.0

September 13, 2024

v4.3.1

September 13, 2024

Fixed

  • Fixed FGA query method to make correct requests #250
August 26, 2024

v4.3.0

August 26, 2024

Added

  • Added support for authentication.sso_failed and authentication.oauth_failed events (#248)
August 14, 2024

v4.2.1

August 14, 2024

Added

  • Add warrant token support to listWarrants [#246]
August 14, 2024

v4.2.0

August 14, 2024

Added

  • Add support for FGA endpoints with request retries (#244)
August 8, 2024

v4.1.0

August 8, 2024

Added

  • Add organizationId parameter for refresh_token authentication method (#242)
July 19, 2024

v4.0.0

July 19, 2024

This is a major release of the WorkOS Kotlin 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

  • Deprecate allowProfilesOutsideOrganization option by @mthadley in #235
  • Add AppleOAuth to comments by @gcarvelli in #234
  • Add User Management by @PaulAsjes in #238

New Contributors

  • @gcarvelli made their first contribution in #234

Full Changelog: v3.1.0...v4.0.0

June 21, 2024

v3.1.0-beta.user-management6

Pre-release
June 21, 2024

What's Changed

  • Add find invitation by token method by @blairlunceford in #230
  • Fix list endpoints by @PaulAsjes in #236
  • v3.1.0-beta.user-management6 by @blairlunceford in #233

New Contributors

  • @PaulAsjes made their first contribution in #236

Full Changelog: v3.1.0-beta.user-management5...v3.1.0-beta.user-management6

May 24, 2024

v3.1.0-beta.user-management5

Pre-release
May 24, 2024

Added

  • Added inviterUserId to invitation object returned by API (#228)
  • Support email_verification.created and password_reset.created events (#228)
  • Added new endpoints to the User Management API to support sending your own emails: getEmailVerification, getPasswordReset, and createPasswordReset (#228)
  • Deprecation notice for the sendPasswordResetEmail method in favor of createPasswordReset (#228)
May 21, 2024

v3.1.0-beta.user-management4

Pre-release
May 21, 2024

Added

  • Add organization membership deactivate and reactivate API methods (#226)
May 7, 2024

v3.1.0

May 7, 2024

Added

  • Add domainData to Organization create and update methods, replacing deprecated domains (#223)
May 3, 2024

v3.1.0-beta.user-management3

Pre-release
May 3, 2024

Added

  • Added acceptInvitationUrl to invitation object returned by API (#221)
  • Added new event types: invitation.created and magic_auth.created (#221)
  • Added new endpoints for the Magic Auth API: getMagicAuth and createMagicAuth (#221)
  • Deprecation notice for sendMagicAuthCode method in favor of createMagicAuth (#221)
April 26, 2024

v3.1.0-beta.user-management2

Pre-release
April 26, 2024

Added

  • Add organization membership events (#218)
April 25, 2024

v3.1.0-beta.user-management1

Pre-release
April 25, 2024

User Management support: #212