v7.0.0
·
39 commits
to main
since this release
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