README

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

Documentation

See the API Reference for Laravel usage examples.

Installation

To install via composer, run the following:

composer require workos/workos-php-laravel

Configuration

Create a WorkOS configuration file by running the following:

php artisan vendor:publish --provider="WorkOS\Laravel\WorkOSServiceProvider"

The package will need to be configured with your api key and project id. By default, the package will look 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.

Beta Releases

WorkOS has features in Beta that can be accessed via Beta releases. We would love for you to try these and share feedback with us before these features reach general availability (GA). To install a Beta version, please follow the installation steps above using the Beta release version.

Note: there can be breaking changes between Beta versions. Therefore, we recommend pinning the package version to a specific version. This way you can install the same version each time without breaking changes unless you are intentionally looking for the latest Beta version.

We highly recommend keeping an eye on when the Beta feature you are interested in goes from Beta to stable so that you can move to using the stable version.

More Information

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