Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/workos/workos-php-laravel
Official PHP Laravel SDK for interacting with the WorkOS API
https://github.com/workos/workos-php-laravel
adfs directory-sync gsuite-saml-apps laravel-sdk okta saml scim sso sso-authentication
Last synced: 2 days ago
JSON representation
Official PHP Laravel SDK for interacting with the WorkOS API
- Host: GitHub
- URL: https://github.com/workos/workos-php-laravel
- Owner: workos
- License: mit
- Created: 2020-04-07T15:00:30.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-22T16:25:34.000Z (4 months ago)
- Last Synced: 2025-01-31T14:55:43.453Z (6 days ago)
- Topics: adfs, directory-sync, gsuite-saml-apps, laravel-sdk, okta, saml, scim, sso, sso-authentication
- Language: PHP
- Homepage: https://workos.com/docs/sdk/laravel
- Size: 43.9 KB
- Stars: 17
- Watchers: 20
- Forks: 8
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# WorkOS PHP Laravel Library
The WorkOS library for Laravel provides convenient access to the WorkOS API from applications written in Laravel.
## Documentation
See the [API Reference](https://workos.com/docs/reference/client-libraries) for Laravel usage examples.
## Installation
To install via composer, run the following:
```bash
composer require workos/workos-php-laravel
```
For Laravel 5.0-5.4, add the WorkOS ServiceProvider in your `config/app.php`:
```php
"providers" => array(
// ...
WorkOS\Laravel\WorkOSServiceProvider::class
)
```
For Laravel 5.5 and up, 6.x and 7.x... you're all set!
## Configuration
Create a WorkOS configuration file by running the following:
```bash
php artisan vendor:publish --provider="WorkOS\Laravel\WorkOSServiceProvider"
```
The package will need to be configured with your [api key](https://dashboard.workos.com/api-keys) and [project id](https://dashboard.workos.com/sso/configuration).
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](https://semver.org/)) 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](#installation) 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](https://workos.com/docs/sso/guide)
* [Directory Sync Guide](https://workos.com/docs/directory-sync/guide)
* [Admin Portal Guide](https://workos.com/docs/admin-portal/guide)
* [Magic Link Guide](https://workos.com/docs/magic-link/guide)