> For the complete documentation index, see [llms.txt](https://docs.opensoutheners.com/home/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.opensoutheners.com/home/laravel-scim/installation.md).

# Installation

## Requirements

* PHP 8.2+
* Laravel 11 or 12

## Install via Composer

```bash
composer require open-southeners/laravel-scim
```

The package auto-discovers its service provider. No manual registration needed.

## Publish the config

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

This creates `config/scim.php` where you can configure middleware, filtering limits, and more.

## Database setup

SCIM resources map to your existing Eloquent models. The only addition most apps need is an `external_id` column on tables that will be provisioned:

```bash
php artisan make:migration add_external_id_to_users_table
```

```php
public function up(): void
{
    Schema::table('users', function (Blueprint $table) {
        $table->ulid('external_id')->nullable()->index();
    });
}
```

The `externalId` is how identity providers track their own identifier for a resource in your system. Add it to your model's `$fillable` array:

```php
protected $fillable = [
    'name',
    'email',
    'password',
    'external_id',
];
```

{% hint style="info" %}
If your column is named something other than `external_id`, set `external_id_column` in your config. See [Configuration](/home/laravel-scim/configuration.md).
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.opensoutheners.com/home/laravel-scim/installation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.