PHP SDK

Installation

Command Line

PHP

 composer require workos/workos-php

Releases

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

v4.3.0

March 20, 2024

Added

Added impersonator attribute to AuthenticationResponse (#213)

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

v4.1.0

December 14, 2023

Added

Added support for User Management APIs

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)

v3.4.0

September 20, 2023

What's Changed

Add .gitattributes file by @sheldonvaughn in https://github.com/workos/workos-php/pull/176

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

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

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

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)

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

v2.1.0

December 8, 2022

Added

Add log_streams Admin Portal intent (https://github.com/workos/workos-php/pull/131)

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.

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.

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)

v1.17.0

October 12, 2022

Added

Added job title attribute for directory users (#121)

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

v1.15.0

September 26, 2022

Added

Add support for Idempotency-Key on Create Organization method

Add support for primaryEmail function on DirectoryUser class

v1.14.0

September 16, 2022

Added

Added support for creating Admin Portal links for viewing Audit Logs (#114)

v1.13.0

September 6, 2022

Added

Added Client for AuditLogs features: createEvent, createExport, and getExport (#110)

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)

v1.11.0

June 21, 2022

Added

Added null coalesce operator for missing response mappings (#103)

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)

v1.9.0

April 13, 2022

Changed

Split AuthenticationChallenge Resource into AuthenticationChallengeTotp and AuthenticationChallengeSms

v1.8.0

March 30, 2022

Added

Added MFA API support (#87)

Fixed

Used list_metadata instead of ListMetadata (#81)

Changed

Updated various dependencies

v1.7.0

February 25, 2022

Deprecated

Removed environment_id from directory resource as it was no longer needed and sent within the API response

v1.6.0

January 5, 2022

Changed

Made domain, provider, and connection parameters nullable in the getAuthorizationUrl method for SSO

v1.5.1

December 17, 2021

Fixed

Fixed a bug in Webhooks::constructEvent that was returning an error when webhooks contained non UTF-8 characters

v1.5.0

December 16, 2021

Added

Added support for Organization parameter for GetAuthorizationURL function

Added support for domain_hint and login_hint parameters for GetAuthorizationURL function

v1.4.0

November 9, 2021

Added

Added GET Directory function

Added Webhook validation function