WorkOS Docs Homepage
SDKs
API referenceDashboardSign In
SDKs

Java SDK

github.com
workos/ workos-kotlin
19 Stars
9 Forks
37 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 beta versions, refer to the README in the GitHub repository.

Releases

June 18, 2026

v6.2.0

Latest
June 18, 2026

⚠️ Breaking

  • organization_membership:
  • Changed response of UserManagementOrganizationMembership.list from UserOrganizationMembership to UserOrganizationMembershipList
  • pipes:
  • SDK surface change: Pipes.createDataIntegrationToken was renamed to Pipes.getAccessToken
  • user_management:
  • Changed response of UserManagementInvitations.list from UserInvite to UserInviteList

Features

  • authorization:
  • Added model ReplaceGroupRoleAssignmentEntry
  • Added model ReplaceGroupRoleAssignments
  • Added model DeleteGroupRoleAssignmentsByCriteria
  • Added endpoint POST /authorization/groups/{group_id}/role_assignments
  • Added endpoint PUT /authorization/groups/{group_id}/role_assignments
  • Added endpoint DELETE /authorization/groups/{group_id}/role_assignments
  • Added endpoint GET /authorization/groups/{group_id}/role_assignments/{role_assignment_id}
  • Added endpoint DELETE /authorization/groups/{group_id}/role_assignments/{role_assignment_id}
  • client:
  • Added model ClientApiToken
  • Added model ClientApiTokenResponse
  • Added service Client
  • connect:
  • Added auth_method to ConnectedAccount
  • Added api_key_last_4 to ConnectedAccount
  • Added enum ConnectedAccountAuthMethod
  • groups:
  • Added model CreateGroupRoleAssignment
  • Added model GroupRoleAssignment
  • Added model GroupRoleAssignmentList
  • Added model GroupRoleAssignmentResource
  • organization_membership:
  • Added model UserOrganizationMembershipList
  • Added model UserOrganizationMembershipListListMetadata
  • pipes:
  • Added model DataIntegrationCredentials
  • Added model DataIntegrationConfigurationResponse
  • Added model DataIntegrationConfigurationListResponse
  • Added model ConfigureDataIntegrationBody
  • Added auth_methods to DataIntegrationsListResponseData
  • Added auth_method to DataIntegrationsListResponseDataConnectedAccount
  • Added api_key_last_4 to DataIntegrationsListResponseDataConnectedAccount
  • Added enum DataIntegrationCredentialsCredentialsType
  • Added enum DataIntegrationsListResponseDataAuthMethods
  • Added enum DataIntegrationsListResponseDataConnectedAccountAuthMethod
  • Added service PipesProvider
  • user_management:
  • Added model UserInviteList
  • Added model UserInviteListListMetadata
  • Made AuthorizationCodeSessionAuthenticateRequest.client_secret optional
  • Made RefreshTokenSessionAuthenticateRequest.client_secret optional
  • widgets:
  • Added widgets:pipes:manage to WidgetSessionTokenScopes
June 17, 2026

v6.1.0

June 17, 2026

Bug Fixes

Features

  • api_keys:
  • Added model ExpireApiKey
  • Added model ApiKeyUpdated
  • Added model ApiKeyUpdatedData
  • Added model ApiKeyUpdatedDataOwner
  • Added model UserApiKeyUpdatedDataOwner
  • Added model ApiKeyUpdatedDataPreviousAttribute
  • Added endpoint POST /api_keys/{id}/expire
  • audit_logs:
  • Added Snowflake to AuditLogConfigurationLogStreamType
  • connect:
  • Added name to UserObject
  • directory_sync:
  • Added model DsyncTokenCreated
  • Added model DsyncTokenCreatedData
  • Added model DsyncTokenRevoked
  • Added model DsyncTokenRevokedData
  • user_management:
  • Added name to user management models
  • webhooks:
  • Added api_key.updated to CreateWebhookEndpointEvents
  • Added api_key.updated to UpdateWebhookEndpointEvents
May 26, 2026

v6.0.0

May 26, 2026

Bug Fixes

⚠️ Breaking

  • vault: Rewrite Vault service from auto-generated spec
  • Vault was previously a hand-maintained class; it is now auto-generated and accessible via WorkOS.vault
  • Renamed methods: listObjects → listKv, createObject → createKv, readObject/readObjectByName → getKv/getName, getObjectMetadata → listKvMetadata, updateObject → updateKv, deleteObject → deleteKv, listObjectVersions → listKvVersions, decryptDataKey → createDecrypt
  • Added new method: createRekey
  • Removed types previously defined in Vault.kt: DataKey, DataKeyPair, VaultObject, ObjectDigest, ObjectUpdateBy, ObjectMetadata, ObjectVersion, and KeyContext type alias — replaced by generated models in com.workos.models.*
  • Client-side encrypt and decrypt helper methods are preserved
  • user_management: Move organization membership methods to separate service
  • Removed organization membership methods from UserManagement: listOrganizationMemberships, createOrganizationMembership, getOrganizationMembership, updateOrganizationMembership, deleteOrganizationMembership, deactivateOrganizationMembership, reactivateOrganizationMembership
  • These methods are now available on the new OrganizationMembershipService as list, create, get, update, delete, deactivate, reactivate
  • Removed CreateUserRole class from UserManagement (now in OrganizationMembershipService)
  • Deleted UserManagementOrganizationMembershipGroups class and its package
  • Updated WorkOS.userManagementOrganizationMembershipGroups to WorkOS.organizationMembership
  • authorization: Remove search parameter from listResources operations
  • Removed search parameter from listResources method and related variants
  • Removed search parameter from listResourcesById, listResourcesByExternalId, and their suspend variants
  • Added new filter parameters to listRoleAssignments: resourceId, resourceExternalId, resourceTypeSlug
  • Added new filter parameter to listRoleAssignmentsForResourceByExternalId: roleSlug
  • Added new filter parameter to listRoleAssignmentsForResource: roleSlug
  • radar: Remove device fingerprint and bot score parameters from createAttempt
  • Removed deviceFingerprint parameter from Radar.createAttempt and createAttemptSuspend
  • Removed botScore parameter from Radar.createAttempt and createAttemptSuspend
  • Updated RadarStandaloneAssessRequest model to remove device_fingerprint and bot_score fields
  • radar: Update RadarStandaloneAssessRequestAction enum values
  • Removed enum values: Login, Signup, SignUp2, SignIn2, SignIn3, SignUp3
  • Changed SignUp value from 'sign up' to 'sign-up'
  • Changed SignIn value from 'sign in' to 'sign-in'
  • radar: Remove enum values from RadarStandaloneResponseControl
  • Removed CredentialStuffing enum value
  • Removed IpSignUpRateLimit enum value
  • audit_logs: Rename AuditLog model classes and update references
  • Renamed AuditLogActionJson to AuditLogAction
  • Renamed AuditLogExportJson to AuditLogExport
  • Renamed AuditLogsRetentionJson to AuditLogsRetention
  • Deleted AuditLogSchemaJson; its fields (version, createdAt, objectType) were absorbed into AuditLogSchema
  • Renamed AuditLogSchemaJsonActor to AuditLogSchemaActorInput
  • Renamed AuditLogSchemaJsonTarget to AuditLogSchemaTargetInput
  • Added new AuditLogSchemaInput model for create/update operations
  • Changed AuditLogs.createSchema parameter types from AuditLogSchemaTarget/AuditLogSchemaActor to AuditLogSchemaTargetInput/AuditLogSchemaActorInput
  • Updated all method return types and parameter types in AuditLogs service
  • webhooks: Rename WebhookEndpoint model and status enum
  • Renamed WebhookEndpointJson to WebhookEndpoint
  • Renamed WebhookEndpointJsonStatus to WebhookEndpointStatus
  • Updated UpdateWebhookEndpointStatus to alias the renamed status enum
  • Updated all Webhooks service method signatures and return types
  • Updated parameter type for status in updateEndpoint method
  • generated: Rename model classes and type aliases for consistency
  • Changed ApplicationCredentialsListItem.last_used_at field type from String? to OffsetDateTime?
  • Changed NewConnectApplicationSecret.last_used_at field type from String? to OffsetDateTime?
  • Updated FlagRuleUpdatedContextConfiguredTargetOrganization to be an alias for Actor
  • Updated FlagRuleUpdatedContextPreviousAttributeContextConfiguredTargetOrganization to be an alias for Actor
  • Changed UserManagementAuthenticationScreenHint to be an alias for RadarStandaloneAssessRequestAction

Features

  • organization_membership: Add new OrganizationMembershipService with membership and group operations
  • New service OrganizationMembershipService providing organization membership management
  • Includes list, create, get, update, delete, deactivate, reactivate operations for memberships
  • Includes listGroups operation to list groups for a membership
  • All operations available in blocking and suspend variants
  • vault: Add WorkOS.vault accessor and new operations
  • Vault is now accessible via WorkOS.vault (previously not exposed on the WorkOS class)
  • Key operations: createDataKey, createDecrypt, createRekey
  • Object operations: listKv, createKv, getName, getKv, updateKv, deleteKv, listKvMetadata, listKvVersions
  • All operations available in blocking and suspend variants
  • api_keys: Add expires_at field to API key models and creation methods
  • Added expires_at field to ApiKey, OrganizationApiKey, OrganizationApiKeyWithValue, UserApiKey, UserApiKeyWithValue models
  • Added expires_at optional parameter to createOrganizationApiKey method in ApiKeys service
  • Added expires_at optional parameter to createApiKey method in UserManagement service
  • Added expires_at field to request models: CreateOrganizationApiKey, CreateUserApiKey
  • Added expires_at field to event data models: ApiKeyCreatedData, ApiKeyRevokedData
  • webhooks: Add pipe connected account webhook event types
  • Added three new webhook event types: PIPES_CONNECTED_ACCOUNT_CONNECTED, PIPES_CONNECTED_ACCOUNT_DISCONNECTED, PIPES_CONNECTED_ACCOUNT_REAUTHORIZATION_NEEDED
  • Added to both CreateWebhookEndpointEvents and UpdateWebhookEndpointEvents enums
  • Added corresponding event models: PipesConnectedAccountConnected, PipesConnectedAccountDisconnected, PipesConnectedAccountReauthorizationNeeded
  • generated: Add new models and enums
  • New Vault-related models: CreateDataKeyRequest, CreateDataKeyResponse, CreateObjectRequest, DecryptRequest, DecryptResponse, DeleteObjectResponse, RekeyRequest, UpdateObjectRequest
  • New Vault-related models: Object, ObjectMetadata, ObjectSummary, ObjectVersion, ObjectWithoutValue, VersionListResponse, ListMetadata
  • New general models: Actor, ErrorResponse
  • New Connect models: ConnectApplicationM2M, ConnectApplicationOAuth, ConnectApplicationOAuthRedirectUris
  • New enum: PipeConnectedAccountState
  • New enum: SortOrder
  • New event models: PipeConnectedAccount, PipesConnectedAccountConnected, PipesConnectedAccountDisconnected, PipesConnectedAccountReauthorizationNeeded
  • Updated WorkOSEvent to include new Pipes webhook event types
May 11, 2026

v5.1.0

May 11, 2026

v5.0.0...v5.1.0" rel="noreferrer" target="_blank">5.1.0 (2026-05-11)

Features

Bug Fixes

May 6, 2026

v5.0.0

May 6, 2026

⚠ BREAKING CHANGES

  • Release the next major SDK version (https://github.com/workos/workos-kotlin/issues/357" rel="noreferrer" target="_blank">#357)
  • Upgrade to Java 17 and migrate any Fuel-based HTTP customization to OkHttpClient
  • Recreate WorkOS clients with constructor-based configuration instead of mutating apiHostname, https, or port
  • Update service accessors and method names across the SDK, including renamed services such as PortalApi -> AdminPortal, MfaApi -> MultiFactorAuth, and FgaApi -> Authorization
  • Replace per-service model, type, and builder imports with the consolidated shared packages and newer flat method arguments or option classes
  • Adopt the new pagination, webhook verification, and request handling patterns used across v5
  • Review any existing FGA integrations closely, since the v5 Authorization API is a redesign rather than a direct rename

Features

Please read the v5 migration guide before upgrading: https://github.com/workos/workos-kotlin/blob/v5.0.0/docs/V5_MIGRATION_GUIDE.md

Full Changelog: v4.25.0...v5.0.0

May 1, 2026

v4.25.0

May 1, 2026

v4.24.0...v4.25.0" rel="noreferrer" target="_blank">4.25.0 (2026-04-30)

Features

April 30, 2026

v4.24.0

April 30, 2026

v4.23.0...v4.24.0" rel="noreferrer" target="_blank">4.24.0 (2026-04-30)

Features

Bug Fixes

April 23, 2026

v4.23.0

April 23, 2026

workos-v4.22.0...workos-v4.23.0" rel="noreferrer" target="_blank">4.23.0 (2026-04-23)

Features

Bug Fixes

April 8, 2026

workos: v4.22.0

April 8, 2026

workos-v4.21.0...workos-v4.22.0" rel="noreferrer" target="_blank">4.22.0 (2026-04-08)

Features

Bug Fixes

March 26, 2026

workos: v4.21.0

March 26, 2026

workos-v4.20.0...workos-v4.21.0" rel="noreferrer" target="_blank">4.21.0 (2026-03-26)

Features

Bug Fixes

March 24, 2026

workos: v4.20.0

March 24, 2026

workos-v4.19.1...workos-v4.20.0" rel="noreferrer" target="_blank">4.20.0 (2026-03-24)

Features

Bug Fixes

March 4, 2026

workos: v4.19.1

March 4, 2026

workos-v4.19.0...workos-v4.19.1" rel="noreferrer" target="_blank">4.19.1 (2026-03-04)

Bug Fixes

February 26, 2026

workos: v4.19.0

February 26, 2026

workos-v4.18.1...workos-v4.19.0" rel="noreferrer" target="_blank">4.19.0 (2026-02-26)

Features

Bug Fixes

December 3, 2025

v4.18.1

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

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

Full Changelog: v4.11.0...v4.12.0" rel="noreferrer" target="_blank">v4.11.0...v4.12.0

April 10, 2025

v4.11.0

April 10, 2025

What's Changed

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

March 28, 2025

v4.10.0

March 28, 2025

What's Changed

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

February 21, 2025

v4.9.0

February 21, 2025

What's Changed

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

January 15, 2025

v4.8.0

January 15, 2025

Added

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

January 6, 2025

v4.7.0

January 6, 2025

Added

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

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