protonlabs/scim-schema

SCIM schema library

v0.2 2023-10-30 10:35 UTC

Requires

• php: >=7.4

Requires (Dev)

• php-coveralls/php-coveralls: ^2.0
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^9.0|^10.0

MIT

• Milos Tomic

• scim
• RFC7643
• scim schema

README

SCIM schema PHP library with support for both v1 and v2.

This library is a fork of https://github.com/tmilos/scim-s to make it compatible with modern PHP

Note: This library is still work in progress, and you are welcome to help and contribute

It was made by the specs from SimpleCloud and by the example documents generated by PowerDMS/Owin.Scim

Do not miss SCIM Filter Parser !

Install

Install Scim Schema using composer:

composer require protonlabs/scim-schema

Usage

Schema

Build default schema:

$schemaBuilder = new SchemaBuilderV2(); // or SchemaBuilderV1

$groupSchema = $schemaBuilder->getGroup();
$userSchema  = $schemaBuilder->getUser();
$enterpriseUserSchema = $schemaBuilder->getEnterpriseUser();
$schemaSchema = $schemaBuilder->getSchema();
$serviceProviderConfigSchema = $schemaBuilder->getServiceProviderConfig();
$resourceTypeSchema = $schemaBuilder->getResourceType();

Or build your own custom schema:

$schema = new Schema();

$schema->setName('CustomSchema');

$schema->addAttribute(
    AttributeBuilder::create('name', ScimConstants::ATTRIBUTE_TYPE_STRING, 'Name of the object')
        ->setMutability(false)
        ->getAttribute()
);

And serialize the scim schema object

$schema = (new SchemaBuilderV2())->getUser();

$schema->serializeObject();

Schema validation

An object can be validated against a schema:

/** @var array $object */
$object = getTheObjectAsArray();

$validator = new SchemaValidator();
$objectSchema = getTheSchema();
$schemaExtensions = getSchemaExtensions();

$validationResult = $validator->validate(
    $object,
    $objectSchema,
    $schemaExtensions
);

if (!$validationResult->getErrors()) {
    // cool!
} else {
    print implode("\n", $validationResult->getErrorsAsStrings());
}