-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.
Features
UserRoleAssignmentSourcesource to UserRoleAssignmentUserRoleAssignmentSourceTypeUserManagementAuthentication.authorize.max_ageGET /user_management/cors_originsGET /user_management/redirect_urisFixes
Features
DataIntegrationCredentialsResponseDataIntegrationCredentialsResponseCredentialDataIntegrationsUpsertApiKeyRequestDataIntegrationsVendCredentialsRequestDataIntegrationCredentialsResponseErrorPUT /data-integrations/{slug}/api-keyPOST /data-integrations/{slug}/credentials⚠️ Breaking
SessionReauthenticatedSessionReauthenticatedDataSessionReauthenticatedDataImpersonatorSessionReauthenticatedDataAuthMethodSessionReauthenticatedDataStatusFeatures
agent.registration.created to CreateWebhookEndpointEventsagent.registration.claim.attempt.created to CreateWebhookEndpointEventsagent.registration.claim.completed to CreateWebhookEndpointEventsagent.registration.credential.issued to CreateWebhookEndpointEventsagent.registration.organization.switched to CreateWebhookEndpointEventsauthentication.reauthentication_succeeded to CreateWebhookEndpointEventsagent.registration.created to UpdateWebhookEndpointEventsagent.registration.claim.attempt.created to UpdateWebhookEndpointEventsagent.registration.claim.completed to UpdateWebhookEndpointEventsagent.registration.credential.issued to UpdateWebhookEndpointEventsagent.registration.organization.switched to UpdateWebhookEndpointEventsauthentication.reauthentication_succeeded to UpdateWebhookEndpointEventssession.reauthenticated to CreateWebhookEndpointEventssession.reauthenticated to UpdateWebhookEndpointEventspipes.connected_account.connection_failed to CreateWebhookEndpointEventspipes.connected_account.connection_failed to UpdateWebhookEndpointEventsUserRoleAssignmentSourcesource to UserRoleAssignmentUserRoleAssignmentSourceTypeUserManagementAuthentication.authorize.max_ageGET /user_management/cors_originsGET /user_management/redirect_urisAuditLogExportCreation.range_startAuditLogExportCreation.range_endexpired to AuditLogExportStateFixes
intent_options from GenerateLinksession.reauthenticated from CreateWebhookEndpointEventssession.reauthenticated from UpdateWebhookEndpointEventsFeatures
DataIntegrationCredentialsDtoCustomProviderDefinitionCreateDataIntegrationUpdateCustomProviderDefinitionUpdateDataIntegrationDataIntegrationDataIntegrationListDataIntegrationListListMetadataDataIntegrationCredentialDataIntegrationCustomProviderDataIntegrationCredentialsTypeCustomProviderDefinitionAuthenticateViaUpdateCustomProviderDefinitionAuthenticateViaDataIntegrationStateDataIntegrationCredentialTypeDataIntegrationCustomProviderAuthenticateViaGET /data-integrationsPOST /data-integrationsGET /data-integrations/{slug}PUT /data-integrations/{slug}DELETE /data-integrations/{slug}POST /user_management/users/{user_id}/connected_accounts/{slug}PUT /user_management/users/{user_id}/connected_accounts/{slug}Features
SendRadarSmsChallengeSendRadarSmsChallengeResponseUrnWorkosOAuthGrantTypeRadarEmailChallengeCodeSessionAuthenticateRequestUrnWorkosOAuthGrantTypeRadarSmsChallengeCodeSessionAuthenticateRequestMagicAuthSendMagicAuthCodeAndReturnResponseUserCreateResponseip_address to CreateMagicCodeAndReturnuser_agent to CreateMagicCodeAndReturnradar_auth_attempt_id to CreateMagicCodeAndReturnsignals_id to CreateMagicCodeAndReturnip_address to CreateUseruser_agent to CreateUsersignals_id to CreateUsersignals_id to AuthorizationCodeSessionAuthenticateRequestsignals_id to PasswordSessionAuthenticateRequestradar_auth_attempt_id to PasswordSessionAuthenticateRequestradar_auth_attempt_id to UrnWorkosOAuthGrantTypeMagicAuthCodeSessionAuthenticateRequestPOST /user_management/radar_challengessignals_id to RadarStandaloneAssessRequestFixes
UserManagementAuthentication.authenticateUserManagementUsers.create from User to UserCreateResponseUserManagementMagicAuth.sendMagicAuthCodeAndReturn from MagicAuth to MagicAuthSendMagicAuthCodeAndReturnResponseFixes
roles to organization membership models⚠️ Breaking
UserManagementOrganizationMembership.list from UserOrganizationMembership to UserOrganizationMembershipListPipes.createDataIntegrationToken was renamed to Pipes.getAccessTokenUserManagementInvitations.list from UserInvite to UserInviteListFeatures
ReplaceGroupRoleAssignmentEntryReplaceGroupRoleAssignmentsDeleteGroupRoleAssignmentsByCriteriaPOST /authorization/groups/{group_id}/role_assignmentsPUT /authorization/groups/{group_id}/role_assignmentsDELETE /authorization/groups/{group_id}/role_assignmentsGET /authorization/groups/{group_id}/role_assignments/{role_assignment_id}DELETE /authorization/groups/{group_id}/role_assignments/{role_assignment_id}ClientApiTokenClientApiTokenResponseClientauth_method to ConnectedAccountapi_key_last_4 to ConnectedAccountConnectedAccountAuthMethodCreateGroupRoleAssignmentGroupRoleAssignmentGroupRoleAssignmentListGroupRoleAssignmentResourceUserOrganizationMembershipListUserOrganizationMembershipListListMetadataDataIntegrationCredentialsDataIntegrationConfigurationResponseDataIntegrationConfigurationListResponseConfigureDataIntegrationBodyauth_methods to DataIntegrationsListResponseDataauth_method to DataIntegrationsListResponseDataConnectedAccountapi_key_last_4 to DataIntegrationsListResponseDataConnectedAccountDataIntegrationCredentialsCredentialsTypeDataIntegrationsListResponseDataAuthMethodsDataIntegrationsListResponseDataConnectedAccountAuthMethodPipesProviderUserInviteListUserInviteListListMetadataAuthorizationCodeSessionAuthenticateRequest.client_secret optionalRefreshTokenSessionAuthenticateRequest.client_secret optionalwidgets:pipes:manage to WidgetSessionTokenScopesFeatures
ExpireApiKeyApiKeyUpdatedApiKeyUpdatedDataApiKeyUpdatedDataOwnerUserApiKeyUpdatedDataOwnerApiKeyUpdatedDataPreviousAttributePOST /api_keys/{id}/expireSnowflake to AuditLogConfigurationLogStreamTypename to UserObjectDsyncTokenCreatedDsyncTokenCreatedDataDsyncTokenRevokedDsyncTokenRevokedDataname to user management modelsapi_key.updated to CreateWebhookEndpointEventsapi_key.updated to UpdateWebhookEndpointEvents⚠️ Breaking
WorkOS.vaultlistObjects → listKv, createObject → createKv, readObject/readObjectByName → getKv/getName, getObjectMetadata → listKvMetadata, updateObject → updateKv, deleteObject → deleteKv, listObjectVersions → listKvVersions, decryptDataKey → createDecryptcreateRekeyVault.kt: DataKey, DataKeyPair, VaultObject, ObjectDigest, ObjectUpdateBy, ObjectMetadata, ObjectVersion, and KeyContext type alias — replaced by generated models in com.workos.models.*encrypt and decrypt helper methods are preservedUserManagement: listOrganizationMemberships, createOrganizationMembership, getOrganizationMembership, updateOrganizationMembership, deleteOrganizationMembership, deactivateOrganizationMembership, reactivateOrganizationMembershipOrganizationMembershipService as list, create, get, update, delete, deactivate, reactivateCreateUserRole class from UserManagement (now in OrganizationMembershipService)UserManagementOrganizationMembershipGroups class and its packageWorkOS.userManagementOrganizationMembershipGroups to WorkOS.organizationMembershipsearch parameter from listResources method and related variantssearch parameter from listResourcesById, listResourcesByExternalId, and their suspend variantslistRoleAssignments: resourceId, resourceExternalId, resourceTypeSluglistRoleAssignmentsForResourceByExternalId: roleSluglistRoleAssignmentsForResource: roleSlugdeviceFingerprint parameter from Radar.createAttempt and createAttemptSuspendbotScore parameter from Radar.createAttempt and createAttemptSuspendRadarStandaloneAssessRequest model to remove device_fingerprint and bot_score fieldsLogin, Signup, SignUp2, SignIn2, SignIn3, SignUp3SignUp value from 'sign up' to 'sign-up'SignIn value from 'sign in' to 'sign-in'CredentialStuffing enum valueIpSignUpRateLimit enum valueAuditLogActionJson to AuditLogActionAuditLogExportJson to AuditLogExportAuditLogsRetentionJson to AuditLogsRetentionAuditLogSchemaJson; its fields (version, createdAt, objectType) were absorbed into AuditLogSchemaAuditLogSchemaJsonActor to AuditLogSchemaActorInputAuditLogSchemaJsonTarget to AuditLogSchemaTargetInputAuditLogSchemaInput model for create/update operationsAuditLogs.createSchema parameter types from AuditLogSchemaTarget/AuditLogSchemaActor to AuditLogSchemaTargetInput/AuditLogSchemaActorInputAuditLogs serviceWebhookEndpointJson to WebhookEndpointWebhookEndpointJsonStatus to WebhookEndpointStatusUpdateWebhookEndpointStatus to alias the renamed status enumstatus in updateEndpoint methodApplicationCredentialsListItem.last_used_at field type from String? to OffsetDateTime?NewConnectApplicationSecret.last_used_at field type from String? to OffsetDateTime?FlagRuleUpdatedContextConfiguredTargetOrganization to be an alias for ActorFlagRuleUpdatedContextPreviousAttributeContextConfiguredTargetOrganization to be an alias for ActorUserManagementAuthenticationScreenHint to be an alias for RadarStandaloneAssessRequestActionFeatures
OrganizationMembershipService providing organization membership managementlist, create, get, update, delete, deactivate, reactivate operations for membershipslistGroups operation to list groups for a membershipWorkOS.vault accessor and new operationsWorkOS.vault (previously not exposed on the WorkOS class)createDataKey, createDecrypt, createRekeylistKv, createKv, getName, getKv, updateKv, deleteKv, listKvMetadata, listKvVersionsexpires_at field to ApiKey, OrganizationApiKey, OrganizationApiKeyWithValue, UserApiKey, UserApiKeyWithValue modelsexpires_at optional parameter to createOrganizationApiKey method in ApiKeys serviceexpires_at optional parameter to createApiKey method in UserManagement serviceexpires_at field to request models: CreateOrganizationApiKey, CreateUserApiKeyexpires_at field to event data models: ApiKeyCreatedData, ApiKeyRevokedDataPIPES_CONNECTED_ACCOUNT_CONNECTED, PIPES_CONNECTED_ACCOUNT_DISCONNECTED, PIPES_CONNECTED_ACCOUNT_REAUTHORIZATION_NEEDEDCreateWebhookEndpointEvents and UpdateWebhookEndpointEvents enumsPipesConnectedAccountConnected, PipesConnectedAccountDisconnected, PipesConnectedAccountReauthorizationNeededCreateDataKeyRequest, CreateDataKeyResponse, CreateObjectRequest, DecryptRequest, DecryptResponse, DeleteObjectResponse, RekeyRequest, UpdateObjectRequestObject, ObjectMetadata, ObjectSummary, ObjectVersion, ObjectWithoutValue, VersionListResponse, ListMetadataActor, ErrorResponseConnectApplicationM2M, ConnectApplicationOAuth, ConnectApplicationOAuthRedirectUrisPipeConnectedAccountStateSortOrderPipeConnectedAccount, PipesConnectedAccountConnected, PipesConnectedAccountDisconnected, PipesConnectedAccountReauthorizationNeededWorkOSEvent to include new Pipes webhook event typesOkHttpClientWorkOS clients with constructor-based configuration instead of mutating apiHostname, https, or portPortalApi -> AdminPortal, MfaApi -> MultiFactorAuth, and FgaApi -> AuthorizationWebhook helper while keeping webhook endpoint management on the Webhooks servicePlease 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
user to organization membership response (https://github.com/workos/workos-kotlin/issues/369" rel="noreferrer" target="_blank">#369) (https://github.com/workos/workos-kotlin/commit/de6e1c4f19410afa207aefeec29333db746a3b04" rel="noreferrer" target="_blank">de6e1c4)roles property to directory user and SSO profile by @kendallstrautman in #302Full Changelog: v4.17.0...v4.18.1
In this version, the package semver was not updated properly and still references v4.17.0
roles property to directory user and SSO profile by @kendallstrautman in #302Full Changelog: v4.17.0...v4.18.0
Full Changelog: v4.16.0...v4.17.0
Full Changelog: v4.15.0...v4.16.0
email to UpdateUserOptions (https://github.com/workos/workos-kotlin/pull/281)Full Changelog: v4.13.0...v4.14.0
Full Changelog: v4.12.0...v4.13.0
customAttributes field to SSO Profile (https://github.com/workos/workos-kotlin/pull/275" rel="noreferrer" target="_blank">#275)Full Changelog: v4.11.0...v4.12.0" rel="noreferrer" target="_blank">v4.11.0...v4.12.0
password_reset.succeeded event type (https://github.com/workos/workos-kotlin/pull/273)Full Changelog: v4.10.0...v4.11.0
email standard attribute to DirectoryUser (https://github.com/workos/workos-kotlin/pull/270" rel="noreferrer" target="_blank">#270)emails, job_title, and username standard attributes as deprecated. Enable the equivalent auto-mapped custom attributes instead (https://github.com/workos/workos-kotlin/pull/270" rel="noreferrer" target="_blank">#270)Full Changelog: v4.9.0...v4.10.0
state, verificationStrategy, and verificationToken to OrganizationDomain (https://github.com/workos/workos-kotlin/pull/266)lastSignInAt to User (https://github.com/workos/workos-kotlin/pull/268)Full Changelog: v4.8.0...v4.9.0
returnTo parameter to getLogoutUrl (https://github.com/workos/workos-kotlin/pull/264" rel="noreferrer" target="_blank">#264)Full Changelog: v4.7.0...v4.8.0
Full Changelog: v4.6.1...v4.7.0
role attribute optional on directorysync.models.User by @jonatascastro12 in #259Full Changelog: v4.6.0...v4.6.1