arietimmerman/laravel-scim-server

Laravel Package for creating a SCIM server

, _(*1)

, _(*2)

SCIM 2.0 Server implementation for Laravel

Add SCIM 2.0 Server capabilities to your Laravel application with ease. This package requires minimal configuration to get started with basic functionalities., _(*3)

This implementation is used by The SCIM Playground and is therefore one of the most widely tested SCIM servers available., _(*4)

Installation

Simply run:, _(*5)

composer require arietimmerman/laravel-scim-server

And optionally, _(*6)

php artisan vendor:publish --tag=laravel-scim

Routes

Configuration

The configuration is retrieved from SCIMConfig::class., _(*7)

Extend this class and register your extension in app/Providers/AppServiceProvider.php like this., _(*8)

~~~.php $this->app->singleton('ArieTimmerman\Laravel\SCIMServer\SCIMConfig', YourCustomSCIMConfig::class);, _(*9)

## An example override

Here's one way to override the default configuration without copying too much of the SCIMConfig file into your app.
~~~.php
<?php

class YourCustomSCIMConfig extends \ArieTimmerman\Laravel\SCIMServer\SCIMConfig
{
    public function getUserConfig()
    {
        $config = parent::getUserConfig();

        // Modify the $config variable however you need...

        return $config;
    }
}

Security & App Integration

By default, this package does no security checks on its own. This can be dangerous, in that a functioning SCIM Server can view, add, update, delete, or list users. You are welcome to implement your own security checks at the middleware layer, or somehow/somewhere else that makes sense for your application. But make sure to do something., _(*10)

If you want to integrate into already existing middleware, you'll want to take the following steps -, _(*11)

Turn off automatic publishing of routes

Modify config/scim.php like this:, _(*12)

<?php
return [
    "publish_routes" => false
];

Next, explicitly publish your routes with your choice of middleware

In either your RouteServiceProvider, or in a particular route file, add the following:, _(*13)

use ArieTimmerman\Laravel\SCIMServer\RouteProvider as SCIMServerRouteProvider;

SCIMServerRouteProvider::publicRoutes(); // Make sure to add public routes *first*


Route::middleware('auth:api')->group(function () { // or any other middleware you choose
    SCIMServerRouteProvider::routes(
        [
            'public_routes' => false // but do not hide public routes (metadata) behind authentication
        ]
    );

    SCIMServerRouteProvider::meRoutes();
});

Test server

docker-compose up

Now visit http://localhost:18123/scim/v2/Users., _(*14)