scim2-models 0.6.6

SCIM2 models serialization and validation with pydantic

scim2-models

Pydantic models for SCIM schemas defined in RFC7643 and RFC7644.

This library provides utilities to parse and produce SCIM2 payloads, and handle them with native Python objects. It aims to be used as a basis to build SCIM2 servers and clients.

What's SCIM anyway?

SCIM stands for System for Cross-domain Identity Management, and it is a provisioning protocol. Provisioning is the action of managing a set of resources across different services, usually users and groups. SCIM is often used between Identity Providers and applications in completion of standards like OAuth2 and OpenID Connect. It allows users and groups creations, modifications and deletions to be synchronized between applications.

Features

• SCIM Resources: Native Python classes for User, Group, EnterpriseUser, ServiceProviderConfig, ResourceType and Schema
• Pydantic Integration: Full Pydantic v2 support with validation, serialization and IDE autocompletion
• RFC Compliance: Implements RFC7643 (schema) and RFC7644 (protocol) specifications
• Attribute Metadata: Support for Mutability, Returned, Uniqueness and Required field annotations
• Context-Aware Validation: Automatic field inclusion/exclusion based on HTTP context (creation, query, replacement, etc.)
• Schema Extensions: Dynamic schema extensions and custom resource types, dynamic conversion between schemas and Python models.
• SCIM Messages: ListResponse, SearchRequest, PatchOp, and Error messages
• Error Handling: SCIM-compliant exceptions with automatic conversion to Error responses

Installation

pip install scim2-models

Usage

Check the tutorial and the reference for more details.

from scim2_models import User
import datetime

payload = {
    "schemas": ["urn:ietf:params:scim:schemas:core:2.0:User"],
    "id": "2819c223-7f76-453a-919d-413861904646",
    "userName": "[e-mail]",
    "meta": {
        "resourceType": "User",
        "created": "2010-01-23T04:56:22Z",
        "lastModified": "2011-05-13T04:42:34Z",
        "version": 'W\\/"3694e05e9dff590"',
        "location": "https://example.com/v2/Users/2819c223-7f76-453a-919d-413861904646",
    },
}

user = User.model_validate(payload)
assert user.user_name == "[e-mail]"
assert user.meta.created == datetime.datetime(
    2010, 1, 23, 4, 56, 22, tzinfo=datetime.timezone.utc
)

scim2-models belongs in a collection of SCIM tools developed by Yaal Coop, with scim2-client, scim2-tester and scim2-cli