WorkOS Docs Homepage
SDKs
API referenceDashboardSign In
SDKs

Java SDK

github.com
workos/workos-kotlin
10 Stars
6 Forks
23 Contributors
github.com
Official Java SDK for interacting with the WorkOS API.

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

July 19, 2024

v4.0.0

Latest
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

January 20, 2023

v2.9.0

January 20, 2023

Updated

  • Changes customAttributes, rawAttributes, and previousAttributes to allow type Any? (#154)
December 8, 2022

v2.8.0

December 8, 2022

Added

  • Add log_streams Admin Portal intent (https://github.com/workos/workos-kotlin/pull/152)
November 18, 2022

v2.7.0

November 18, 2022

Added

  • Java support idempotency key for createOrganization (https://github.com/workos/workos-kotlin/pull/145)
November 17, 2022

v2.6.1

November 17, 2022

Updated:

  • Made totp properties nullable (#147)
October 27, 2022

v2.6.0

October 27, 2022

Added:

  • Publicly accessible webhook validation methods
October 12, 2022

v2.5.0

October 12, 2022

Added

  • Added primaryEmail method to directory users (#139)
  • Added job title attribute for directory users (#140)
September 16, 2022

v2.4.0

September 16, 2022

Added

  • Added support for creating Admin Portal links for viewing Audit Logs (#137)
August 24, 2022

v2.3.1

August 24, 2022

Updated

  • Updated user directory model to support created_At and updated_At (#129)
August 24, 2022

v2.3.2

August 24, 2022

Update KeycloakSAML enum casing to match documentation

July 20, 2022

v2.3.0

July 20, 2022

Added

  • Added organization_id to Directory User and Directory Group (#123)

Updated

  • Updated endpoints used for MFA operations (#125)
June 14, 2022

v2.2.0

June 14, 2022

Added

  • Added order param to pagination (#117)
  • Added created_at and updated_at to Groups (#120)

Updated

  • Made Authentication Challenge expiresAt field non nullable (#119)
  • Updated provider enums and bump version (#121)
  • Ensure Dokka runs after Javadoc task (#122)

Removed

  • Removed environment_id fields (#118)
May 23, 2022

v2.1.4

May 23, 2022

Updated

  • Updated Apache HTTP Client to 4.5.13
May 2, 2022

v2.1.3

May 2, 2022

Updated

  • Made Challenge model expiresAt nullable for totp
May 2, 2022

v2.1.2

May 2, 2022

Updated

  • Updated JSON serialization for TOTP factor enrollment
April 28, 2022

v2.1.1

April 28, 2022

Updated

  • Made the code property nullable for the Challenge class