workos/workos-php

WorkOS PHP Library

v3.1.1 2023-03-30 14:57 UTC

Requires

• php: >=7.3.0
• ext-curl: *
• illuminate/support: ^5.0 || ^6.0 || ^7.0 || ^8.0 || ^9.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.15|^3.6
• phpunit/phpunit: ^5.7|^9.5.10

MIT

• WorkOS

README

The WorkOS library for PHP provides convenient access to the WorkOS API from applications written in PHP.

Documentation

See the API Reference for PHP usage examples.

Installation

To install via composer, run the following:

composer require workos/workos-php

Configuration

The package will need to be configured with your API Key and Client ID. By default, the packages looks for a WORKOS_API_KEY and WORKOS_CLIENT_ID environment variable.

SDK Versioning

For our SDKs WorkOS follows a Semantic Versioning (SemVer) process where all releases will have a version X.Y.Z (like 1.0.0) pattern wherein Z would be a bug fix (e.g., 1.0.1), Y would be a minor release (1.1.0) and X would be a major release (2.0.0). We permit any breaking changes to only be released in major versions and strongly recommend reading changelogs before making any major version upgrades.

More Information

• Single Sign-On Guide
• Directory Sync Guide
• Admin Portal Guide
• Magic Link Guide