scim2-client 0.7.5

Pythonically build SCIM requests and parse SCIM responses

scim2-client

A SCIM client Python library built upon scim2-models , that pythonically build requests and parse responses, following the RFC7643 and RFC7644 specifications. You can use whatever request engine you prefer to perform network requests, but scim2-client comes with httpx support.

It aims to be used in SCIM client applications, or in unit tests for SCIM server applications.

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

• CRUD Operations: create, query, replace, delete methods for SCIM resources
• PATCH Support: Partial resource modifications with add, remove and replace operations
• Server Discovery: Automatic retrieval of ServiceProviderConfig, ResourceTypes and Schemas
• Search & Filtering: Support for SCIM filters, sorting, pagination and attribute selection
• Sync & Async: Both synchronous and asynchronous clients available
• Multiple HTTP Engines: Built-in support for httpx (sync/async) and werkzeug (testing). Adaptable to any network engine.
• Request & Response Validation: Automatic payload validation against SCIM schemas
• Error Handling: Structured exceptions for network, request and response errors

Installation

pip install scim2-client[httpx]

Usage

Check the tutorial and the reference for more details.

Here is an example of usage:

import datetime
from httpx import Client
from scim2_client import SCIMResponseErrorObject
from scim2_client.engines.httpx import SyncSCIMClient

client = Client(base_url="https://auth.example/scim/v2", headers={"Authorization": "Bearer foobar"})
scim = SyncSCIMClient(client)
scim.discover()
User = scim.get_resource_model("User")

# Query resources
user = scim.query(User, "2819c223-7f76-453a-919d-413861904646")
assert user.user_name == "[e-mail]"
assert user.meta.last_modified == datetime.datetime(
    2024, 4, 13, 12, 0, 0, tzinfo=datetime.timezone.utc
)

# Update resources
user.display_name = "Babs Jensen"
user = scim.replace(user)
assert user.display_name == "Babs Jensen"
assert user.meta.last_modified == datetime.datetime(
    2024, 4, 13, 12, 0, 30, tzinfo=datetime.timezone.utc
)

# Create resources
user = User(user_name="[e-mail]")
try:
    scim.create(user)
except SCIMResponseErrorObject as exc:
    error = exc.to_error()
    assert error.detail == "One or more of the attribute values are already in use or are reserved."

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