codebarista/laravel-workos

Authorize Laravel users with WorkOS.

1.0.0 2025-06-23 18:41 UTC

Requires

• php: ^8.3
• laravel/workos: ^0.2

Requires (Dev)

• laravel/pint: ^1.22
• orchestra/testbench: ^10.0
• pestphp/pest-plugin-laravel: ^3.0
• roave/security-advisories: dev-latest

MIT

• Ralf Langebrake

• laravel
• roles
• permissions
• workos
• entitlements

README

Roles, Permissions and Stripe Entitlements

1. Installation

 composer require codebarista/laravel-workos

2. Configuration

WorkOS

These variables should match the values provided to you in the WorkOS dashboard for your application:

WORKOS_REDIRECT_URL="${APP_URL}/authenticate"
WORKOS_CLIENT_ID=your-client-id
WORKOS_API_KEY=your-api-key

Routes

LARAVEL_WORKOS_ROUTES_AUTHENTICATE=authenticate
LARAVEL_WORKOS_REDIRECT_TO_ROUTE_NAME=dashboard
LARAVEL_WORKOS_ROUTES_LOGOUT=logout
LARAVEL_WORKOS_ROUTES_LOGIN=login

Publish config (optional)

 php artisan vendor:publish --tag="config" --provider="Codebarista\LaravelWorkos\LaravelWorkosServiceProvider"

3. Implementation

Add the HasRoles, HasPermissions and HasEntitlements traits as needed to the User class, or any other that uses authentication.

namespace App\Models;

use Codebarista\LaravelWorkos\Traits\HasEntitlements;
use Codebarista\LaravelWorkos\Traits\HasPermissions;
use Codebarista\LaravelWorkos\Traits\HasRoles;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable
{
    use HasEntitlements, HasPermissions, HasRoles;

    // ...
}

4. Usage

WorkOS Role & Permissions

// e.g. use in Laravel policies
class EntryPolicy
{
    public function viewAny(User $user): bool
    {
        return $user->hasPermissionTo('entries:view') // custom WorkOS permission
            || $user->hasRole('org-editor'); // custom WorkOS organization role
    }
    
    // ...
}

Stripe Product Entitlements

// e.g. use in Laravel gates
protected function gate(): void
{
    Gate::define('viewNova', static function (User $user) {
        return $user->hasEntitlementTo('access-dashboard'); // custom Stripe entitlement
    });
}

License

The MIT License (MIT). Please see License File for more information.