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

March 21, 2025

v4.22.0

Latest
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 https://github.com/workos/workos-php/pull/268
  • @pepeloper made their first contribution in https://github.com/workos/workos-php/pull/267

Full Changelog: https://github.com/workos/workos-php/compare/v4.21.0...v4.22.0

March 14, 2025

v4.21.0

March 14, 2025

What's Changed

  • Improve PHPdoc types by @GromNaN in https://github.com/workos/workos-php/pull/260
  • Make workos-php compatible with PHP 7.3 by @yottalogical in https://github.com/workos/workos-php/pull/263
  • v4.21.0 by @nicknisi in https://github.com/workos/workos-php/pull/266

New Contributors

  • @GromNaN made their first contribution in https://github.com/workos/workos-php/pull/260
  • @yottalogical made their first contribution in https://github.com/workos/workos-php/pull/263

Full Changelog: https://github.com/workos/workos-php/compare/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 https://github.com/workos/workos-php/pull/256

New Contributors

  • @jameslcarpino made their first contribution in https://github.com/workos/workos-php/pull/256
  • @nicknisi made their first contribution in https://github.com/workos/workos-php/pull/259

Full Changelog: https://github.com/workos/workos-php/compare/v4.19.0...v4.20.0

February 20, 2025

v4.19.0

February 20, 2025

What's Changed

  • added lastSignInAt to user (https://github.com/workos/workos-php/pull/257)

Full Changelog: https://github.com/workos/workos-php/compare/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: https://github.com/workos/workos-php/compare/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: https://github.com/workos/workos-php/compare/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 https://github.com/workos/workos-php/pull/250

New Contributors

  • @Hannes-Kruger made their first contribution in https://github.com/workos/workos-php/pull/250

Full Changelog: https://github.com/workos/workos-php/compare/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: https://github.com/workos/workos-php/compare/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 https://github.com/workos/workos-php/pull/246

Full Changelog: https://github.com/workos/workos-php/compare/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 https://github.com/workos/workos-php/pull/238

Full Changelog: https://github.com/workos/workos-php/compare/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 https://github.com/workos/workos-php/pull/241

Full Changelog: https://github.com/workos/workos-php/compare/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 https://github.com/workos/workos-php/pull/233

Full Changelog: https://github.com/workos/workos-php/compare/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 https://github.com/workos/workos-php/pull/227
  • Add logout url method by @PaulAsjes in https://github.com/workos/workos-php/pull/231

Full Changelog: https://github.com/workos/workos-php/compare/v4.7.0...v4.8.0

May 14, 2024

v4.7.0

May 14, 2024

What's Changed

  • Auth with refresh token and fix some tests by @PaulAsjes in https://github.com/workos/workos-php/pull/229
  • Properly check if a value exists within a BaseWorkOSResource by @abellion in https://github.com/workos/workos-php/pull/226

New Contributors

  • @PaulAsjes made their first contribution in https://github.com/workos/workos-php/pull/229
  • @abellion made their first contribution in https://github.com/workos/workos-php/pull/226

Full Changelog: https://github.com/workos/workos-php/compare/v4.6.0...v4.7.0

May 3, 2024

v4.6.0

May 3, 2024

Added

  • Added acceptInvitationUrl to invitation object returned by API (#224)
  • Added new endpoints for the Magic Auth API: getMagicAuth and createMagicAuth (#224)
  • Deprecation notice for sendMagicAuthCode method in favor of createMagicAuth (#224)
May 2, 2024

v4.5.0

May 2, 2024

Added

  • Add domain_data to Organizations Create and Update methods to replace the now deprecated domains parameter (#221)
  • Add status to organization membership (#212)
  • Add screen hint to getAuthorizationUrl (#216)
April 9, 2024

v4.4.0

April 9, 2024

What's Changed

  • Clean up CI scripts: https://github.com/workos/workos-php/pull/217
  • Add 'password_hash' and 'password_hash_type' to User creation: https://github.com/workos/workos-php/pull/218
  • Add role_slug to send invitation API: https://github.com/workos/workos-php/pull/220

Full Changelog: https://github.com/workos/workos-php/compare/v4.3.0...v4.4.0

March 20, 2024

v4.3.0

March 20, 2024

Added

  • Added impersonator attribute to AuthenticationResponse (#213)
February 7, 2024

v4.2.0

February 7, 2024

Added

  • Add profile_picture_url attribute to the user object by @hadihallak in https://github.com/workos/workos-php/pull/210

Full Changelog: https://github.com/workos/workos-php/compare/v4.1.0...v4.2.0

December 14, 2023

v4.1.0

December 14, 2023

Added

November 22, 2023

v4.0.0

November 22, 2023

Removed

  • [Breaking Change] Removed deprecated Audit Trail module (#198)
  • [Breaking Change] Removed beta version of the User Management module. Stable User Management release coming soon! (#198)
September 20, 2023

v3.4.0

September 20, 2023

What's Changed

  • Add .gitattributes file by @sheldonvaughn in https://github.com/workos/workos-php/pull/176
May 4, 2023

v3.3.0

May 4, 2023

What's Changed

  • Remove illuminate/support dependency to allow Laravel 10 by @sheldonvaughn in https://github.com/workos/workos-php/pull/147
  • Add actorNames and actorIds to createExport by @robframpton in https://github.com/workos/workos-php/pull/146

Full Changelog: https://github.com/workos/workos-php/compare/v3.2.0...v3.3.0

April 13, 2023

v3.2.0

April 13, 2023

What's Changed

  • Fix team name in CODEOWNERS by @willmanduffy in https://github.com/workos/workos-php/pull/143
  • Add throws tag to every methods by @VincentLanglet in https://github.com/workos/workos-php/pull/142
  • Bump Version to 3.2.0 by @sheldonvaughn in https://github.com/workos/workos-php/pull/144

Full Changelog: https://github.com/workos/workos-php/compare/v3.1.1...v3.2.0

March 30, 2023

v3.1.1

March 30, 2023

What's Changed

  • Fix ConnectionType usage by replacing all null|ConnectionType variable types with null|string in phpdoc(s) by @VincentLanglet in https://github.com/workos/workos-php/pull/140
March 7, 2023

v3.1.0

March 7, 2023

Added

  • Added groups attribute to SSO user profile. This feature is in beta, please reach out to support@workos.com to access this feature. (#137)