DashboardSign In

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

June 4, 2024

v4.10.0

Latest
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)
February 2, 2023

v3.0.0

February 2, 2023

Breaking Changes

PHP 7.3.0 and above required

Other Changes

Updated syntax for PHP 8.2 compatibility re: https://wiki.php.net/rfc/deprecate_dollar_brace_string_interpolation

Added @property annotation to Profile and ProfileAndToken classes in order to have autocompletion from PHPStorm or for static analysis tools like PHPStan. This way, both understand the syntax

December 8, 2022

v2.1.0

December 8, 2022

Added

  • Add log_streams Admin Portal intent (https://github.com/workos/workos-php/pull/131)
November 17, 2022

v2.0.0

November 17, 2022

Breaking Changes

  • The Profile returned in SSO::getProfileAndToken will now return a profile array (https://workos.com/docs/reference/sso/profile) with values using camelCasing instead of snake_casing (#91) in line with PHP standards and the other workos-php functions.
November 10, 2022

v1.19.0

November 10, 2022

Changed

  • Remove default null value on domain parameter for getAuthorizationUrl function to resolve https://github.com/workos/workos-php/issues/124

Note: This release was mistakenly tagged v1.19.9. If you installed immediately you may see the version downgrade from v1.19.9 -> v1.19.0 on your next composer command.

October 18, 2022

v1.18.0

October 18, 2022

Added

  • Add success_url to generateLink (https://github.com/workos/workos-php/pull/125)
  • Add getFactor and deleteFactor methods to MFA class (https://github.com/workos/workos-php/pull/122)
October 12, 2022

v1.17.0

October 12, 2022

Added

  • Added job title attribute for directory users (#121)
September 26, 2022

v1.16.0

September 26, 2022

Changed

  • Improved error handling to return detailed error message from the API
  • Resolves https://github.com/workos/workos-php/issues/108
September 26, 2022

v1.15.0

September 26, 2022

Added

  • Add support for Idempotency-Key on Create Organization method
  • Add support for primaryEmail function on DirectoryUser class
September 16, 2022

v1.14.0

September 16, 2022

Added

  • Added support for creating Admin Portal links for viewing Audit Logs (#114)
September 6, 2022

v1.13.0

September 6, 2022

Added

  • Added Client for AuditLogs features: createEvent, createExport, and getExport (#110)
July 14, 2022

v1.12.0

July 14, 2022

Added

  • Added directory_id and organization_id to DirectoryGroup and DirectoryUser (#106)

Changed

  • Updated ChallengeFactor and VerifyChallenge endpoints (#105)
June 21, 2022

v1.11.0

June 21, 2022

Added

  • Added null coalesce operator for missing response mappings (#103)
June 7, 2022

v1.10.0

June 7, 2022

Changed

  • Removed environmentId fields (#95)
  • Added order param (#96)
  • Included organization_id in listConnections (#97)
  • Exposed expires_at in totp challenge responses (#101)