WorkOS Docs Homepage
SDKs
API referenceDashboardSign In
SDKs

PHP SDK

github.com
workos/workos-php
39 Stars
19 Forks
48 Contributors
github.com
Official PHP SDK for interacting with the WorkOS API.

Installation

Command Line
PHP

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 the beta versions, refer to the README in the GitHub repository.

Releases

April 13, 2026

v5.0.1

Latest
April 13, 2026

5.0.1 (2026-04-13)

Bug Fixes

  • add default User-Agent header and optional override (#352) (8e202db)
  • one more regen (44906fd)
April 13, 2026

v5.0.0

April 13, 2026

5.0.0 (2026-04-13)

Top-Level Notices

  • v5 is a major SDK redesign centered on an instantiated WorkOS client with service accessors like $workos->sso(), $workos->userManagement(), and $workos->authorization(). Direct use of many legacy top-level service classes and transport internals has been removed or renamed.
  • The minimum runtime is now PHP 8.2. The SDK now depends on guzzlehttp/guzzle:^7, paragonie/halite:^5.1, and ext-curl:^8.2.
  • Responses and resources are now typed, generated models, pagination now uses PaginatedResponse, and named arguments are strongly recommended because many method signatures changed in v5.
  • The v5 release also expands and reorganizes the SDK surface across areas like Authorization, Audit Logs, Feature Flags, Organization Domains, Connect, Events, Pipes, Radar, API Keys, Session Manager, PKCE, Webhooks, and Vault helpers.

Migration Guide

  • For upgrade steps, renamed APIs, and side-by-side examples for moving from v4 to v5, see V5_MIGRATION_GUIDE.

Miscellaneous Chores

  • deps: update actions/create-github-app-token action to v3 (#345) (0259ffb)
  • deps: update amannn/action-semantic-pull-request action to v6 (#346) (4cf01c0)
March 9, 2026

v4.32.0

March 9, 2026

4.32.0 (2026-03-09)

Features

Bug Fixes

  • listEnvironmentRoles should not use PaginatedResource (#341) (52f0602)
March 6, 2026

v4.31.0

March 6, 2026

4.31.0 (2026-03-06)

Features

  • Add directoryManaged to OrganizationMembership (#334) (1451af1)
  • Add RBAC environment roles API support (#338) (31fb41d)
  • Add RBAC permissions API support (#337) (dd7dca2)
  • api: Return state field for directory users (#27) (250887e)
  • Introduce a dedicated PaginatedResource object (#316) (a3ccfde)
  • workos-php: Add connection to getAuthorizationUrl (#29) (ade7019)

Bug Fixes

Miscellaneous Chores

February 17, 2026

4.30.1

February 17, 2026

What's Changed

  • Add custom_attributes field to OrganizationMembership by @ajworkos in #318
  • Configure Renovate by @renovate[bot] in #319
  • Update peter-evans/create-pull-request action to v8 by @renovate[bot] in #327
  • fix revokeSession api call format by @kkoch986 in #328
  • Bump version to 4.30.1 by @workos-sdk-automation[bot] in #329

New Contributors

  • @ajworkos made their first contribution in #318
  • @renovate[bot] made their first contribution in #319
  • @kkoch986 made their first contribution in #328

Full Changelog: 4.30.0...4.30.1

January 21, 2026

4.30.0

January 21, 2026

What's Changed

  • Add context7.json to repo by @nicknisi in #314
  • Implement Authkit Sessions by @birdcar in #315
  • Bump version to 4.30.0 by @workos-sdk-automation[bot] in #317

New Contributors

  • @birdcar made their first contribution in #315
  • @workos-sdk-automation[bot] made their first contribution in #317

Full Changelog: v4.29.0...4.30.0

December 3, 2025

v4.29.0

December 3, 2025

What's Changed

  • Add Organization Feature Flags & Vault Support by @blobaugh in #299
  • Fixed deprecation notices in tests by @blobaugh in #300
  • Fix PHP 8.4 deprecation: Add explicit nullable type hints by @blobaugh in #309
  • Fix incomplete Portal intent documentation and add validation by @blobaugh in #310
  • Add roles to directory user and SSO profile by @kendallstrautman in #311
  • Fix test assertion by @kendallstrautman in #313
  • Bump version v4.29.0 by @kendallstrautman in #312

Full Changelog: v4.28.0...v4.29.0

November 21, 2025

v4.28.0

November 21, 2025

What's Changed

  • Added support for schema creation and existance checking by @blobaugh in #301
  • Add ability to resend invitation by @antn in #307

New Contributors

  • @blobaugh made their first contribution in #301
  • @antn made their first contribution in #307

Full Changelog: v4.27.0...v4.28.0

September 24, 2025

v4.27.0

September 24, 2025

What's Changed

  • Fix small bug in DirectorySync by @gcarvelli in #291
  • Add getEnvVariable utility method to fix Laravel config caching issue by @nicknisi in #293
  • Adds multiple roles support to OrganizationMembership Create and Update by @csrbarber in #302
  • Version bump to 4.27.0 by @csrbarber in #304

New Contributors

  • @csrbarber made their first contribution in #302

Full Changelog: v4.26.0...v4.27.0

June 23, 2025

v4.26.0

June 23, 2025

What's Changed

  • Added support for custom scopes (#289)

Full Changelog: v4.25.0...v4.26.0

June 17, 2025

v4.25.0

June 17, 2025

What's Changed

  • Add permissions attribute to Role by @MrCrayfish in #287

New Contributors

  • @MrCrayfish made their first contribution in #287

Full Changelog: v4.24.0...v4.25.0

May 22, 2025

v4.24.0

May 22, 2025

What's Changed

  • Fixes $roleSlug behavior on updateOrganizationMembership (no longer required) (#278)
  • Adds $roleSlug to createOrganizationMembership (#278)
  • Adds $email to updateUser (#285)
April 25, 2025

v4.23.0

April 25, 2025

What's Changed

  • Structured responses to webhook events by @bradenkeith in #265
  • IDE & Typehint improvements by @bradenkeith in #264
  • Pin third-party actions to currently used SHA by @nickcollisson-workos in #275
  • Add customAttributes field to SSO Profile by @mattgd in #276

New Contributors

  • @bradenkeith made their first contribution in #265
  • @nickcollisson-workos made their first contribution in #275

Full Changelog: v4.22.0...v4.23.0

March 21, 2025

v4.22.0

March 21, 2025

What's Changed

  • Add metadata support (#268)
  • Add external_id support for organizations (#270)
  • Add external_id support for users (#267)
  • Add email standard attribute to DirectoryUser (#261)
  • Mark emails, job_title, and username standard attributes as deprecated. Enable the equivalent auto-mapped custom attributes instead (#261)

New Contributors

  • @ericroberts made their first contribution in #268
  • @pepeloper made their first contribution in #267

Full Changelog: v4.21.0...v4.22.0

March 14, 2025

v4.21.0

March 14, 2025

What's Changed

  • Improve PHPdoc types by @GromNaN in #260
  • Make workos-php compatible with PHP 7.3 by @yottalogical in #263
  • v4.21.0 by @nicknisi in #266

New Contributors

  • @GromNaN made their first contribution in #260
  • @yottalogical made their first contribution in #263

Full Changelog: v4.20.0...v4.21.0

February 21, 2025

v4.20.0

February 21, 2025

What's Changed

  • add update organization membership by @jameslcarpino in #256

New Contributors

  • @jameslcarpino made their first contribution in #256
  • @nicknisi made their first contribution in #259

Full Changelog: v4.19.0...v4.20.0

February 20, 2025

v4.19.0

February 20, 2025

What's Changed

  • added lastSignInAt to user (#257)

Full Changelog: v4.18.0...v4.19.0

January 14, 2025

v4.18.0

January 14, 2025

Added

  • Add return_to option to getLogoutUrl (#254)

Full Changelog: v4.17.0...v4.18.0

December 27, 2024

v4.17.0

December 27, 2024

Added

  • Add GET /organization/:orgId/roles support (#252)

Full Changelog: v4.16.0...v4.17.0

December 6, 2024

v4.16.0

December 6, 2024

What's Changed

  • Add stripeCustomerId Parameter to Organization Methods by @Hannes-Kruger in #250

New Contributors

  • @Hannes-Kruger made their first contribution in #250

Full Changelog: v4.15.0...v4.16.0

November 15, 2024

v4.15.0

November 15, 2024

What's Changed

  • Add widgets get token API support (#248)

Full Changelog: v4.14.0...v4.15.0

October 21, 2024

v4.14.0

October 21, 2024

What's Changed

  • Add role to profile by @kendallstrautman in #246

Full Changelog: v4.13.0...v4.14.0

August 7, 2024

v4.13.0

August 7, 2024

Added

  • Added a new organizationId parameter to the authenticateWithRefreshToken method (#244)
July 18, 2024

v4.12.0

July 18, 2024

What's Changed

  • Add Apple and GitHub OAuth support by @gcarvelli in #238

Full Changelog: v4.11.1...v4.12.0

July 11, 2024

v4.11.1

July 11, 2024

What's Changed

  • Fixes a bug with leading slashes from various UM functions by @sheldonvaughn in #241

Full Changelog: v4.11.0...v4.11.1

June 24, 2024

v4.11.0

June 24, 2024

Deprecated

  • Marked $allowProfilesOutsideOrganization option parameter as deprecated (#239)
June 4, 2024

v4.10.0

June 4, 2024

Added

  • Added a method to find an invitation using the token (#236)
May 24, 2024

v4.9.0

May 24, 2024

Added

  • Added inviterUserID to invitation object returned by API (#234)
  • Added new endpoints to the User Management API to support sending your own emails: getEmailVerification, getPasswordReset, and createPasswordReset (#234)
  • Deprecation notice for the sendPasswordResetEmail method in favor of createPasswordReset (#234)
May 22, 2024

v4.8.1

May 22, 2024

What's Changed

  • Fix bug with URL parsing by @PaulAsjes in #233

Full Changelog: v4.8.0...v4.8.1

May 17, 2024

v4.8.0

May 17, 2024

What's Changed

  • Add organization membership deactivate and reactivate API methods by @mattgd in #227
  • Add logout url method by @PaulAsjes in #231

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