Releases: workos/workos-php
Release list
v8.1.0
-
#416 fix(generated): regenerate from spec
Features
- user_management:
- Added model
UserRoleAssignmentSource - Added
sourcetoUserRoleAssignment - Added enum
UserRoleAssignmentSourceType - Added parameter
UserManagementAuthentication.authorize.max_age - Added endpoint
GET /user_management/cors_origins - Added endpoint
GET /user_management/redirect_uris
- Added model
Fixes
- Restore mistakenly removed CreateMagicAuth logic from previous release
- user_management:
v8.0.0
-
#409 fix(generated): regenerate from spec
Features
- pipes:
- Added model
DataIntegrationCredentialsResponse - Added model
DataIntegrationCredentialsResponseCredential - Added model
DataIntegrationsUpsertApiKeyRequest - Added model
DataIntegrationsVendCredentialsRequest - Added enum
DataIntegrationCredentialsResponseError - Added endpoint
PUT /data-integrations/{slug}/api-key - Added endpoint
POST /data-integrations/{slug}/credentials
- Added model
- pipes:
-
#411 feat(generated)!: regenerate from spec (1 change)
⚠️ Breaking- user_management:
- Removed model
SessionReauthenticated - Removed model
SessionReauthenticatedData - Removed model
SessionReauthenticatedDataImpersonator - Removed enum
SessionReauthenticatedDataAuthMethod - Removed enum
SessionReauthenticatedDataStatus
- Removed model
Features
- webhooks:
- Added
agent.registration.createdtoCreateWebhookEndpointEvents - Added
agent.registration.claim.attempt.createdtoCreateWebhookEndpointEvents - Added
agent.registration.claim.completedtoCreateWebhookEndpointEvents - Added
agent.registration.credential.issuedtoCreateWebhookEndpointEvents - Added
agent.registration.organization.switchedtoCreateWebhookEndpointEvents - Added
authentication.reauthentication_succeededtoCreateWebhookEndpointEvents - Added
agent.registration.createdtoUpdateWebhookEndpointEvents - Added
agent.registration.claim.attempt.createdtoUpdateWebhookEndpointEvents - Added
agent.registration.claim.completedtoUpdateWebhookEndpointEvents - Added
agent.registration.credential.issuedtoUpdateWebhookEndpointEvents - Added
agent.registration.organization.switchedtoUpdateWebhookEndpointEvents - Added
authentication.reauthentication_succeededtoUpdateWebhookEndpointEvents
- Added
- webhooks:
- Added
session.reauthenticatedtoCreateWebhookEndpointEvents - Added
session.reauthenticatedtoUpdateWebhookEndpointEvents
- Added
- webhooks:
- Added
pipes.connected_account.connection_failedtoCreateWebhookEndpointEvents - Added
pipes.connected_account.connection_failedtoUpdateWebhookEndpointEvents
- Added
- user_management:
- Added model
UserRoleAssignmentSource - Added
sourcetoUserRoleAssignment - Added enum
UserRoleAssignmentSourceType - Added parameter
UserManagementAuthentication.authorize.max_age - Added endpoint
GET /user_management/cors_origins - Added endpoint
GET /user_management/redirect_uris
- Added model
- audit_logs:
- Changed the format of
AuditLogExportCreation.range_start - Changed the format of
AuditLogExportCreation.range_end
- Changed the format of
- audit_logs:
- Added
expiredtoAuditLogExportState
- Added
Fixes
- admin_portal:
- Removed
intent_optionsfromGenerateLink
- Removed
- webhooks:
- Removed
session.reauthenticatedfromCreateWebhookEndpointEvents - Removed
session.reauthenticatedfromUpdateWebhookEndpointEvents
- Removed
- user_management:
-
#413 feat(generated): regenerate from spec (1 change)
Features
- pipes:
- Added model
DataIntegrationCredentialsDto - Added model
CustomProviderDefinition - Added model
CreateDataIntegration - Added model
UpdateCustomProviderDefinition - Added model
UpdateDataIntegration - Added model
DataIntegration - Added model
DataIntegrationList - Added model
DataIntegrationListListMetadata - Added model
DataIntegrationCredential - Added model
DataIntegrationCustomProvider - Added enum
DataIntegrationCredentialsType - Added enum
CustomProviderDefinitionAuthenticateVia - Added enum
UpdateCustomProviderDefinitionAuthenticateVia - Added enum
DataIntegrationState - Added enum
DataIntegrationCredentialType - Added enum
DataIntegrationCustomProviderAuthenticateVia - Added endpoint
GET /data-integrations - Added endpoint
POST /data-integrations - Added endpoint
GET /data-integrations/{slug} - Added endpoint
PUT /data-integrations/{slug} - Added endpoint
DELETE /data-integrations/{slug} - Added endpoint
POST /user_management/users/{user_id}/connected_accounts/{slug} - Added endpoint
PUT /user_management/users/{user_id}/connected_accounts/{slug}
- Added model
- pipes:
-
#414 feat(generated): regenerate from spec (2 changes)
Features
- user_management:
- Added model
SendRadarSmsChallenge - Added model
SendRadarSmsChallengeResponse - Added model
UrnWorkosOAuthGrantTypeRadarEmailChallengeCodeSessionAuthenticateRequest - Added model
UrnWorkosOAuthGrantTypeRadarSmsChallengeCodeSessionAuthenticateRequest - Added model
MagicAuthSendMagicAuthCodeAndReturnResponse - Added model
UserCreateResponse - Added
ip_addresstoCreateMagicCodeAndReturn - Added
user_agenttoCreateMagicCodeAndReturn - Added
radar_auth_attempt_idtoCreateMagicCodeAndReturn - Added
signals_idtoCreateMagicCodeAndReturn - Added
ip_addresstoCreateUser - Added
user_agenttoCreateUser - Added
signals_idtoCreateUser - Added
signals_idtoAuthorizationCodeSessionAuthenticateRequest - Added
signals_idtoPasswordSessionAuthenticateRequest - Added
radar_auth_attempt_idtoPasswordSessionAuthenticateRequest - Added
radar_auth_attempt_idtoUrnWorkosOAuthGrantTypeMagicAuthCodeSessionAuthenticateRequest - Added endpoint
POST /user_management/radar_challenges
- Added model
- radar:
- Added
signals_idtoRadarStandaloneAssessRequest
- Added
Fixes
- user_management:
- Changed request body for
UserManagementAuthentication.authenticate - Changed response of
UserManagementUsers.createfromUsertoUserCreateResponse - Changed response of
UserManagementMagicAuth.sendMagicAuthCodeAndReturnfromMagicAuthtoMagicAuthSendMagicAuthCodeAndReturnResponse
- Changed request body for
- user_management:
v7.3.0
-
#405 fix(generated): regenerate from spec
Fixes
- organization_membership:
- Added
rolesto organization membership models
- Added
- organization_membership:
v7.2.0
Bug Fixes
Miscellaneous Chores
- commit publishing fixes (c7ba478)
-
#401 feat(generated)!: regenerate from spec (11 changes)
⚠️ Breaking- pipes:
- SDK surface change:
Pipes.createDataIntegrationTokenwas renamed toPipes.getAccessToken
- SDK surface change:
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}
- Added model
- client:
- Added model
ClientApiToken - Added model
ClientApiTokenResponse - Added service
Client
- Added model
- connect:
- Added
auth_methodtoConnectedAccount - Added
api_key_last_4toConnectedAccount - Added enum
ConnectedAccountAuthMethod
- Added
- groups:
- Added model
CreateGroupRoleAssignment - Added model
GroupRoleAssignment - Added model
GroupRoleAssignmentList - Added model
GroupRoleAssignmentResource
- Added model
- organization_membership:
- Added model
UserOrganizationMembershipList - Added model
UserOrganizationMembershipListListMetadata
- Added model
- pipes:
- Added model
DataIntegrationCredentials - Added model
DataIntegrationConfigurationResponse - Added model
DataIntegrationConfigurationListResponse - Added model
ConfigureDataIntegrationBody - Added
auth_methodstoDataIntegrationsListResponseData - Added
auth_methodtoDataIntegrationsListResponseDataConnectedAccount - Added
api_key_last_4toDataIntegrationsListResponseDataConnectedAccount - Added enum
DataIntegrationCredentialsCredentialsType - Added enum
DataIntegrationsListResponseDataAuthMethods - Added enum
DataIntegrationsListResponseDataConnectedAccountAuthMethod - Added service
PipesProvider
- Added model
- user_management:
- Added model
UserInviteList - Added model
UserInviteListListMetadata - Made
AuthorizationCodeSessionAuthenticateRequest.client_secretoptional - Made
RefreshTokenSessionAuthenticateRequest.client_secretoptional
- Added model
- widgets:
- Added
widgets:pipes:managetoWidgetSessionTokenScopes
- Added
Fixes
- organization_membership:
- Changed response of
UserManagementOrganizationMembership.listfromUserOrganizationMembershiptoUserOrganizationMembershipList
- Changed response of
- user_management:
- Changed response of
UserManagementInvitations.listfromUserInvitetoUserInviteList
- Changed response of
- pipes:
v7.1.0
Miscellaneous Chores
-
#397 feat(generated)!: regenerate from spec (5 changes)
⚠️ Breaking- api_keys:
- Made
expires_atrequired in API key models
- Made
- directory_sync:
- Removed model
DsyncDeactivated - Removed model
DsyncDeactivatedData - Removed model
DsyncDeactivatedDataDomain - Removed enum
DsyncDeactivatedDataType - Removed enum
DsyncDeactivatedDataState
- Removed model
- radar:
- Removed
domain_sign_up_rate_limitfromRadarStandaloneResponseControl
- Removed
- user_management:
- Removed
return_tofromRevokeSession
- Removed
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
- Added model
- audit_logs:
- Added
SnowflaketoAuditLogConfigurationLogStreamType
- Added
- connect:
- Added
nametoUserObject
- Added
- directory_sync:
- Added model
DsyncTokenCreated - Added model
DsyncTokenCreatedData - Added model
DsyncTokenRevoked - Added model
DsyncTokenRevokedData
- Added model
- user_management:
- Added
nameto user management models
- Added
- webhooks:
- Added
api_key.updatedtoCreateWebhookEndpointEvents - Added
api_key.updatedtoUpdateWebhookEndpointEvents
- Added
- api_keys:
v7.0.1
v7.0.0
Miscellaneous Chores
-
deps: update googleapis/release-please-action action to v5 (#389) (f973f21)
-
deps: update shivammathur/setup-php action to v2.37.0 (#388) (f9e113f)
-
use shared workos/renovate-config preset (99aad6c)
-
#392 feat(generated)!: regenerate from spec (10 changes)
⚠️ Breaking- user_management: Remove organization membership methods from UserManagement service
- Removed
listOrganizationMemberships,createOrganizationMembership,getOrganizationMembership,updateOrganizationMembership,deleteOrganizationMembership,deactivateOrganizationMembership, andreactivateOrganizationMembershipmethods - These methods have been moved to the new
OrganizationMembershipService - Change to
getAuthorizationUrl()parameterscreenHintfromUserManagementAuthenticationScreenHinttoRadarStandaloneAssessRequestActiontype - Removed
UserManagementAuthenticationScreenHintenum
- Removed
- user_management: Remove
UserManagementOrganizationMembershipGroupsservice- Removed
$workos->userManagementOrganizationMembershipGroups()accessor listOrganizationMembershipGroups()has been moved to the newOrganizationMembershipService
- Removed
- radar: Remove device fingerprint and bot score from RadarStandaloneAssessRequest
- Removed
deviceFingerprintparameter fromRadar.createAttempt()method - Removed
botScoreparameter fromRadar.createAttempt()method - Removed
deviceFingerprintandbotScorefields fromRadarStandaloneAssessRequestmodel - Removed deprecated enum values from
RadarStandaloneAssessRequestAction:Login,Signup,SignUp2,SignUp3,SignIn2,SignIn3 - Changed enum values in
RadarStandaloneAssessRequestAction:SignUpfrom 'sign up' to 'sign-up',SignInfrom 'sign in' to 'sign-in' - Removed enum values from
RadarStandaloneResponseControl:CredentialStuffing,IpSignUpRateLimit
- Removed
- radar: Rename Radar list enums
- Renamed
RadarActiontoRadarListAction - Renamed
RadarTypetoRadarListType
- Renamed
- audit_logs: Rename audit log models for consistency
- Renamed
AuditLogActionJsontoAuditLogAction - Renamed
AuditLogExportJsontoAuditLogExport - Renamed
AuditLogExportJsonStatetoAuditLogExportState - Renamed
AuditLogSchemaJsontoAuditLogSchema - Renamed
AuditLogSchemaJsonActortoAuditLogSchemaActorInput - Renamed
AuditLogSchemaJsonTargettoAuditLogSchemaTargetInput - Renamed
AuditLogsRetentionJsontoAuditLogsRetention createSchema()method parameter types changed:AuditLogSchemaActor→AuditLogSchemaActorInput,AuditLogSchemaTarget→AuditLogSchemaTargetInput
- Renamed
- webhooks: Rename webhook endpoint models and update status field type
- Renamed
WebhookEndpointJsontoWebhookEndpoint - Renamed
WebhookEndpointJsonStatustoWebhookEndpointStatus - Changed
UpdateWebhookEndpoint.statusfield type fromWebhookEndpointJsonStatustoWebhookEndpointStatus - Updated webhook event enums: added
PIPES_CONNECTED_ACCOUNT_CONNECTED,PIPES_CONNECTED_ACCOUNT_DISCONNECTED,PIPES_CONNECTED_ACCOUNT_REAUTHORIZATION_NEEDEDevents
- Renamed
- authorization: Update Authorization API with new filters and remove search parameter
- Added
resourceId,resourceExternalId,resourceTypeSlugfilter parameters tolistRoleAssignments() - Added
roleSlugfilter parameter tolistRoleAssignmentsForResourceByExternalId()andlistRoleAssignmentsForResource() - Removed
searchparameter fromlistResources()method
- Added
- vault: Replace hand-maintained
WorkOS\Vaultclass with generatedWorkOS\Service\Vault- The old
WorkOS\Vaultclass (lib/Vault.php) with client-side encrypt/decrypt helpers has been removed $workos->vault()now returnsWorkOS\Service\Vaultwith a different API surface- New generated methods:
createDataKey(),createDecrypt(),createRekey(),listKv(),createKv(),getName(),getKv(),updateKv(),deleteKv(),listKvMetadata(),listKvVersions()
- The old
Features
- organization_membership: Introduce OrganizationMembershipService with membership and group operations
- New service
OrganizationMembershipServicewith methods:listOrganizationMemberships(),createOrganizationMembership(),getOrganizationMembership(),updateOrganizationMembership(),deleteOrganizationMembership(),deactivateOrganizationMembership(),reactivateOrganizationMembership(), andlistOrganizationMembershipGroups() - Accessible via
$workos->organizationMembership() - Replaces functionality previously in
UserManagementandUserManagementOrganizationMembershipGroupsservices
- New service
- vault: Add new Vault service for encrypted key-value storage
- New
Vaultservice with methods:createDataKey(),createDecrypt(),createRekey(),listKv(),createKv(),getName(),getKv(),updateKv(),deleteKv(),listKvMetadata(), andlistKvVersions() - Support for encrypted object storage and management with key rotation
- New models:
CreateDataKeyResponse,DecryptResponse,ObjectMetadata,ObjectModel,ObjectSummary,ObjectWithoutValue,ObjectVersion,VersionListResponse - New enum:
VaultOrderfor sort direction - Accessible via
$workos->vault()
- New
- api_keys: Add expires_at field to API key models and creation methods
- Added
expires_atfield toApiKey,OrganizationApiKey,OrganizationApiKeyWithValue,UserApiKey,UserApiKeyWithValuemodels - Added
expires_atfield toApiKeyCreatedDataandApiKeyRevokedDataevent data models - Added optional
expiresAtparameter tocreateOrganizationApiKey()andcreateUserApiKey()methods - Support for setting API key expiration timestamps
- Added
- applications: Update ApplicationCredentialsListItem and NewConnectApplicationSecret field types
- Changed
ApplicationCredentialsListItem.lastUsedAtfield type from?stringto?\DateTimeImmutable - Changed
NewConnectApplicationSecret.lastUsedAtfield type from?stringto?\DateTimeImmutable
- Changed
- pipes: Add connected account event models and related types
- New models for pipe events:
PipeConnectedAccount,PipesConnectedAccountConnected,PipesConnectedAccountDisconnected,PipesConnectedAccountReauthorizationNeeded - New enum:
PipeConnectedAccountStatewith valuesconnectedandneeds_reauthorization - Support for monitoring data integration connection status changes
- New models for pipe events:
- user_management: Remove organization membership methods from UserManagement service
v6.0.2
v6.0.1
v6.0.0
6.0.0 (2026-05-06)
⚠ BREAKING CHANGES
- user_management: Add user API keys and update ordering enum
- api_keys: Restructure API key models and rename ordering enum
- vault: Rename BYOK key provider enum and add vault key deleted event
- authorization: Rename RoleAssignment to UserRoleAssignment
Features
- Add API docs generation and llms.txt index (#382) (ae03f03)
- api_keys: Restructure API key models and rename ordering enum (1bb2fe4)
- authorization: Rename EventsOrder to PaginationOrder (1bb2fe4)
- authorization: Rename RoleAssignment to UserRoleAssignment (1bb2fe4)
- directory_sync: Add name field to directory users (1bb2fe4)
- sso: Add full name support to user profiles (1bb2fe4)
- user_management: Add user API keys and update ordering enum (1bb2fe4)
- user_management: Add user context to organization memberships (1bb2fe4)
- vault: Rename BYOK key provider enum and add vault key deleted event (1bb2fe4)