Skip to content

Releases: workos/workos-php

v7.1.0

17 Jun 01:44
10c046e

Choose a tag to compare

Miscellaneous Chores

  • deps: update github actions non-major (#398) (79fc78c)
  • #397 feat(generated)!: regenerate from spec (5 changes)

    ⚠️ Breaking

    • api_keys:
      • Made expires_at required in API key models
    • directory_sync:
      • Removed model DsyncDeactivated
      • Removed model DsyncDeactivatedData
      • Removed model DsyncDeactivatedDataDomain
      • Removed enum DsyncDeactivatedDataType
      • Removed enum DsyncDeactivatedDataState
    • radar:
      • Removed domain_sign_up_rate_limit from RadarStandaloneResponseControl
    • user_management:
      • Removed return_to from RevokeSession

    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

v7.0.1

28 May 15:02
8b0f8b9

Choose a tag to compare

Bug Fixes

  • renamed misleading Object to VaultObject (c7cef60)
  • renovate: explicitly enable minor and patch updates (#393) (e1705f1)
  • sdk: omit defaulted screen_hint from auth URLs (#396) (d583c7c)

v7.0.0

26 May 19:28
b316e2a

Choose a tag to compare

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, and reactivateOrganizationMembership methods
      • These methods have been moved to the new OrganizationMembershipService
      • Change to getAuthorizationUrl() parameter screenHint from UserManagementAuthenticationScreenHint to RadarStandaloneAssessRequestAction type
      • Removed UserManagementAuthenticationScreenHint enum
    • user_management: Remove UserManagementOrganizationMembershipGroups service
      • Removed $workos->userManagementOrganizationMembershipGroups() accessor
      • listOrganizationMembershipGroups() has been moved to the new OrganizationMembershipService
    • radar: Remove device fingerprint and bot score from RadarStandaloneAssessRequest
      • Removed deviceFingerprint parameter from Radar.createAttempt() method
      • Removed botScore parameter from Radar.createAttempt() method
      • Removed deviceFingerprint and botScore fields from RadarStandaloneAssessRequest model
      • Removed deprecated enum values from RadarStandaloneAssessRequestAction: Login, Signup, SignUp2, SignUp3, SignIn2, SignIn3
      • Changed enum values in RadarStandaloneAssessRequestAction: SignUp from 'sign up' to 'sign-up', SignIn from 'sign in' to 'sign-in'
      • Removed enum values from RadarStandaloneResponseControl: CredentialStuffing, IpSignUpRateLimit
    • radar: Rename Radar list enums
      • Renamed RadarAction to RadarListAction
      • Renamed RadarType to RadarListType
    • audit_logs: Rename audit log models for consistency
      • Renamed AuditLogActionJson to AuditLogAction
      • Renamed AuditLogExportJson to AuditLogExport
      • Renamed AuditLogExportJsonState to AuditLogExportState
      • Renamed AuditLogSchemaJson to AuditLogSchema
      • Renamed AuditLogSchemaJsonActor to AuditLogSchemaActorInput
      • Renamed AuditLogSchemaJsonTarget to AuditLogSchemaTargetInput
      • Renamed AuditLogsRetentionJson to AuditLogsRetention
      • createSchema() method parameter types changed: AuditLogSchemaActorAuditLogSchemaActorInput, AuditLogSchemaTargetAuditLogSchemaTargetInput
    • webhooks: Rename webhook endpoint models and update status field type
      • Renamed WebhookEndpointJson to WebhookEndpoint
      • Renamed WebhookEndpointJsonStatus to WebhookEndpointStatus
      • Changed UpdateWebhookEndpoint.status field type from WebhookEndpointJsonStatus to WebhookEndpointStatus
      • Updated webhook event enums: added PIPES_CONNECTED_ACCOUNT_CONNECTED, PIPES_CONNECTED_ACCOUNT_DISCONNECTED, PIPES_CONNECTED_ACCOUNT_REAUTHORIZATION_NEEDED events
    • authorization: Update Authorization API with new filters and remove search parameter
      • Added resourceId, resourceExternalId, resourceTypeSlug filter parameters to listRoleAssignments()
      • Added roleSlug filter parameter to listRoleAssignmentsForResourceByExternalId() and listRoleAssignmentsForResource()
      • Removed search parameter from listResources() method
    • vault: Replace hand-maintained WorkOS\Vault class with generated WorkOS\Service\Vault
      • The old WorkOS\Vault class (lib/Vault.php) with client-side encrypt/decrypt helpers has been removed
      • $workos->vault() now returns WorkOS\Service\Vault with a different API surface
      • New generated methods: createDataKey(), createDecrypt(), createRekey(), listKv(), createKv(), getName(), getKv(), updateKv(), deleteKv(), listKvMetadata(), listKvVersions()

    Features

    • organization_membership: Introduce OrganizationMembershipService with membership and group operations
      • New service OrganizationMembershipService with methods: listOrganizationMemberships(), createOrganizationMembership(), getOrganizationMembership(), updateOrganizationMembership(), deleteOrganizationMembership(), deactivateOrganizationMembership(), reactivateOrganizationMembership(), and listOrganizationMembershipGroups()
      • Accessible via $workos->organizationMembership()
      • Replaces functionality previously in UserManagement and UserManagementOrganizationMembershipGroups services
    • vault: Add new Vault service for encrypted key-value storage
      • New Vault service with methods: createDataKey(), createDecrypt(), createRekey(), listKv(), createKv(), getName(), getKv(), updateKv(), deleteKv(), listKvMetadata(), and listKvVersions()
      • Support for encrypted object storage and management with key rotation
      • New models: CreateDataKeyResponse, DecryptResponse, ObjectMetadata, ObjectModel, ObjectSummary, ObjectWithoutValue, ObjectVersion, VersionListResponse
      • New enum: VaultOrder for sort direction
      • Accessible via $workos->vault()
    • 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 field to ApiKeyCreatedData and ApiKeyRevokedData event data models
      • Added optional expiresAt parameter to createOrganizationApiKey() and createUserApiKey() methods
      • Support for setting API key expiration timestamps
    • applications: Update ApplicationCredentialsListItem and NewConnectApplicationSecret field types
      • Changed ApplicationCredentialsListItem.lastUsedAt field type from ?string to ?\DateTimeImmutable
      • Changed NewConnectApplicationSecret.lastUsedAt field type from ?string to ?\DateTimeImmutable
    • pipes: Add connected account event models and related types
      • New models for pipe events: PipeConnectedAccount, PipesConnectedAccountConnected, PipesConnectedAccountDisconnected, PipesConnectedAccountReauthorizationNeeded
      • New enum: PipeConnectedAccountState with values connected and needs_reauthorization
      • Support for monitoring data integration connection status changes

v6.0.2

11 May 16:52
c686634

Choose a tag to compare

6.0.2 (2026-05-11)

Bug Fixes

  • harden JWT signature verification and URL path encoding (#386) (aa64119)

v6.0.1

07 May 19:06
2f2555a

Choose a tag to compare

6.0.1 (2026-05-07)

Bug Fixes

  • Preserve full error response body on ApiException (#385) (57052ab)

Miscellaneous Chores

  • release: include v prefix in tags (5517b8b)

v6.0.0

07 May 18:45
c9b487f

Choose a tag to compare

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)

Bug Fixes

  • ci: install composer deps before building docs (8f439e3)
  • events: Add admin_portal to actor source enum (1bb2fe4)

v5.2.1

28 Apr 15:53
8757177

Choose a tag to compare

5.2.1 (2026-04-28)

Bug Fixes

  • generated: Add default values to optional object fields (#376) (1597af6)

v5.2.0

27 Apr 21:19
8cc1dfe

Choose a tag to compare

5.2.0 (2026-04-27)

Features

  • Add script/setup for pre-generation dependency installation (edc2543)
  • surface error metadata from API responses (#369) (ece118b)

Bug Fixes

  • generated: update generated SDK from spec changes (#372) (0ee912a)

v5.1.0

20 Apr 20:58
c7836c8

Choose a tag to compare

5.1.0 (2026-04-20)

Features

  • add group, pipes, and authorization additive API support (#367) (c90a5d6)

Bug Fixes

  • redesign authorization resource targeting and default order handling (b435ced)
  • Remove extractVersion from matchUpdateTypes rules (#365) (f4ad142)
  • type tweaks (780ee85)

Miscellaneous Chores

  • deps: update minor and patch updates (#361) (7e439f7)

v5.0.3

14 Apr 19:57
deafdb9

Choose a tag to compare

5.0.3 (2026-04-14)

Bug Fixes

  • build redirect endpoint URLs locally instead of making HTTP requests (#358) (eae3949)
  • docs: add [@throws](https://github.com/throws) to PHPDoc when appropriate (#360) (ed68872)