Java SDK

Installation

Java

 <dependency>
  <groupId>com.workos</groupId>
  <artifactId>workos</artifactId>
  <version>{version}</version>
</dependency>

 dependencies {
  implementation 'com.workos:workos:VERSION'
}

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

May 2, 2025

v4.12.0

Latest

May 2, 2025

What's Changed

Add customAttributes field to SSO Profile (#275)

Full Changelog: https://github.com/workos/workos-kotlin/compare/v4.11.0...v4.12.0

April 10, 2025

v4.11.0

April 10, 2025

What's Changed

Added password_reset.succeeded event type (https://github.com/workos/workos-kotlin/pull/273)

Full Changelog: https://github.com/workos/workos-kotlin/compare/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: https://github.com/workos/workos-kotlin/compare/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 (https://github.com/workos/workos-kotlin/pull/266)

Added lastSignInAt to User (https://github.com/workos/workos-kotlin/pull/268)

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

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

Full Changelog: https://github.com/workos/workos-kotlin/compare/v4.4.0...v4.5.0

October 17, 2024

v4.4.0

October 17, 2024

What's Changed

Add ProfileRole property in https://github.com/workos/workos-kotlin/pull/252

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

Add AppleOAuth to comments by @gcarvelli in https://github.com/workos/workos-kotlin/pull/234

Add User Management by @PaulAsjes in https://github.com/workos/workos-kotlin/pull/238

New Contributors

@gcarvelli made their first contribution in https://github.com/workos/workos-kotlin/pull/234

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

Fix list endpoints by @PaulAsjes in https://github.com/workos/workos-kotlin/pull/236

v3.1.0-beta.user-management6 by @blairlunceford in https://github.com/workos/workos-kotlin/pull/233

New Contributors

@PaulAsjes made their first contribution in https://github.com/workos/workos-kotlin/pull/236

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

March 25, 2024

V3.0.1

March 25, 2024

Fix pagination order issue.

January 31, 2024

v3.0.0

January 31, 2024

Updated

Replaced ConnectionType enum with string representation, allowing for new connection types.

Deprecated "suspended" state in the Directory Sync user object, consolidating into the "inactive" state.

May 10, 2023

v2.11.3

May 10, 2023

Adds "validating" enum type to ConnectionType model

May 1, 2023

v2.11.2

May 1, 2023

Removes optional Groups parameter from the UserUpdated interface

April 25, 2023

v2.11.1

April 25, 2023

Added

Added successUrl to GeneratePortalLinkOptions (#142)

Updated DirectoryType members for accuracy (#163)

February 17, 2023

v2.10.0

February 17, 2023

Added

Added User and Issuer to TTOP properties (#151)

Added groups attribute to SSO user profile. This feature is in beta - contact support@workos.com to get access to this feature. (#159)

January 31, 2023

v2.9.1

January 31, 2023

Add Cezanne HR to directory type enum list