Skip to main content

SCIM2 models serialization and validation with pydantic

Project description

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.

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": "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
)

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

scim2_models-0.2.4.tar.gz (123.2 kB view details)

Uploaded Source

Built Distribution

scim2_models-0.2.4-py3-none-any.whl (38.7 kB view details)

Uploaded Python 3

File details

Details for the file scim2_models-0.2.4.tar.gz.

File metadata

  • Download URL: scim2_models-0.2.4.tar.gz
  • Upload date:
  • Size: 123.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.4.29

File hashes

Hashes for scim2_models-0.2.4.tar.gz
Algorithm Hash digest
SHA256 add396ff8b3675a1dcd4252fda5b19889125768ce18ff908004574af4bcc5ce1
MD5 b7c2ed7f562254afffdb74b55835e26d
BLAKE2b-256 0c3d66acc8dff5c90ce14edfa6c70ecc32206bd2266ce1874b2e51e0488eb525

See more details on using hashes here.

File details

Details for the file scim2_models-0.2.4-py3-none-any.whl.

File metadata

File hashes

Hashes for scim2_models-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1b8639983297bbed6ad6d04841a8e2c71278aed8a0fff064276b4c1f0d823818
MD5 8ff79a672e1df569a1d96ac5a75df913
BLAKE2b-256 93c9665340087a7ee5623e331043bc7f9c3485ebc5a8e525d8d446875e871e98

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page