scim2-models

Pydantic models for the SCIM 2.0 schemas and protocol. It parses and produces SCIM payloads as native Python objects, and serves as a basis for SCIM servers and clients.

Features

Models for the resources and messages of RFC 7643 and RFC 7644: User, Group, EnterpriseUser, Schema, ResourceType, ServiceProviderConfig, ListResponse, SearchRequest, PatchOp and Error
Pydantic 2 models, with validation, serialization and IDE completion
Validation and serialization per HTTP operation, driven by the SCIM attribute characteristics required, mutability, returned and uniqueness
SCIM filters and paths: parsing, validation against a model, and evaluation on resources
PATCH operations applied to a resource, with the SCIM path grammar
Schema extensions, and conversion between SCIM schemas and Python models
Cursor-based pagination of RFC 9865
SCIM exceptions, convertible to Error responses

Standards

scim2-models implements:

RFC7643 (core schemas)
RFC7644 (protocol)
RFC9865 (cursor-based pagination)

It does not implement the other SCIM RFCs (yet):

RFC9944 (device schema extensions).
RFC9967 (security event tokens).

Example

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": "bjensen@example.com",
    "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 == "bjensen@example.com"
assert user.meta.created == datetime.datetime(
    2010, 1, 23, 4, 56, 22, tzinfo=datetime.timezone.utc
)

Installation

pip install scim2-models

Documentation

Overview tours the models and the operations used by SCIM clients and servers.
How-to guides cover focused tasks.
Explanation covers the SCIM rules and the choices behind them.
Integrations build a SCIM server with Flask, Django, FastAPI or SQLAlchemy.
Reference lists the public API.

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.

Getting help

Questions and bug reports go to the issue tracker.

Contributing

The contribution page describes how to run the tests, the style checks and the documentation build.

License

scim2-models is released under the Apache-2.0 license.

scim2-models belongs in a collection of SCIM tools developed by Yaal Coop, with scim2-client, scim2-tester and scim2-cli. It started as a fork of pydantic-scim, to bring support for Pydantic 2.

Metadata

Release files for scim2-models 0.10.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for scim2-models 0.10.4
File	Size	Uploaded
scim2_models-0.10.4.tar.gz	103.0 kB	Oct 6, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for scim2-models 0.10.4
File	Interpreter	ABI	Platform	Reset
scim2_models-0.10.4-py3-none-any.whl 125.6 kB Oct 6, 2026	Python 3	none	any	Details

Total release size: 228.7 kB

Release files / scim2_models-0.10.4.tar.gz

Download URL	scim2_models-0.10.4.tar.gz
Size	103.0 kB
Tags	Source
SHA-256 checksum How to use checksums	`6847538e538959a5ca7648e406bb8da9bb5c0283716d8baf849c627c915cf83d`
BLAKE2b-256 checksum How to use checksums	`e76bc0cf34e21be14ec5c6aa9bd848c234b8daa87ee11ccd4f3e5f93abeaf2d1`
Upload date	Oct 6, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/python-scim/scim2-models
Publishing commit: github.com/python-scim/scim2-models/tree/23315d324db7a527eb6a703ba6eae2feef42c85e

Workflow

Publishing configuration: github.com/python-scim/scim2-models/blob/23315d324db7a527eb6a703ba6eae2feef42c85e/.github/workflows/release.yml
Publishing logs: github.com/python-scim/scim2-models/actions/runs/37429629271/attempts/1

Artifact

Subject: scim2_models-0.10.4.tar.gz
SHA-256 checksum: 6847538e538959a5ca7648e406bb8da9bb5c0283716d8baf849c627c915cf83d Verifying attestations

Release files / scim2_models-0.10.4-py3-none-any.whl

Download URL	scim2_models-0.10.4-py3-none-any.whl
Size	125.6 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`de097296e955c7ea515fd84e7cf265bcbc27791aeec9cfb1af6e6bcb5be8a8cb`
BLAKE2b-256 checksum How to use checksums	`3c24721cf4c26290cd0429e8e1dbb48908093729b967ae5b9e26a9057d1c5649`
Upload date	Oct 6, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/python-scim/scim2-models
Publishing commit: github.com/python-scim/scim2-models/tree/23315d324db7a527eb6a703ba6eae2feef42c85e

Workflow

Publishing configuration: github.com/python-scim/scim2-models/blob/23315d324db7a527eb6a703ba6eae2feef42c85e/.github/workflows/release.yml
Publishing logs: github.com/python-scim/scim2-models/actions/runs/37429629271/attempts/1

Artifact

Subject: scim2_models-0.10.4-py3-none-any.whl
SHA-256 checksum: de097296e955c7ea515fd84e7cf265bcbc27791aeec9cfb1af6e6bcb5be8a8cb Verifying attestations