Skip to main content

A validator for System for Cross domain Identity Management (SCIM) responses given predefine schemas

Project description

scimschema-logo

ScimSchema

https://github.com/GordonSo/scimschema/workflows/Upload%20Python%20Package/badge.svg

Validate JSon content given a predefined set of SCIM Schemas (in JSON representation format) as specified in SCIM (supporting Python 3+).

Example use case

  1. Install the library via pip:

pip install scimschema
  1. Specify any custom schemas in json format as per the rfc requirement: https://tools.ietf.org/html/rfc7643#section-2

  2. Put the json files under a Python package as per our examples here: https://github.com/GordonSo/scimschema/tree/master/tests/extension (also checkout our __init__() file which is handy for loading the json)

  3. Import the `validate` method from scimschema and pass in json response/request content and the extension schemas to assert its validness

To step through the above in working code, check out this test: test_scim_schema.py.

from scimschema import validate
from . import extension # <- this is the custom schemas define by your: see https://github.com/GordonSo/scimschema/tree/master/tests/extension for example

# A sample schema, like what we'd get from response.get(<scim entity url>).json()
content = {
    "schemas": ["urn:ietf:params:scim:schemas:core2:2.0:Group", "urn:huddle:params:scim:schemas:extension:2.0:SimpleAccount"],
    "id": "2819c223-7f76-453a-919d-413861904646",
    "externalId": 9,
    "meta": {
        "resourceType": "User",
        "created": "2011-08-01T18:29:49.793Z",
        "lastModified": "Invalid date",
        "location": "https://example.com/v2/Users/2819c223...",
        "version": "W\/\"f250dd84f0671c3\""
    }
}
validate(
    data=content,
    extension_schema_definitions=extension.schema
)

>>>    E   _scimschema._model.scim_exceptions.AggregatedScimMultValueAttributeValidationExceptions: Found 1 aggregated exceptions at Scim response:
>>>    E    ScimAttributeValueNotFoundException:
>>>    E             'Single-value attribute:ipRestrictionsEnabled' is required at the following location '['urn:huddle:params:scim:schemas:extension:2.0:Account', 'ipRestrictionsEnabled']' but found '{}'
>>>    !!!!!!!!!!!!!!!!!!! Interrupted: 1 errors during collection !!!!!!!!!!!!!!!!!!!

Features

Support for SCIM 2.0,
  • Validate SCIM Schema definition
    • Validate Model (schema) Id, Name, description, attributes

    • Validate Attribute (schema) Name, Type, Required, Canonical Values, Mutability, Returned, Uniqueness

  • Validate JSON Content against SCIM Schema
    • Validate significant value against Type (Binary, Boolean, Datetime, Decimal, Integer, Reference, String, Complex, MultiValued)

    • Characteristics Required, Canonical Values, Uniqueness

Upcoming features

  • Validate JSON Content for characteristics below:
    • Mutability, Returned

Running the Test Suite

The project requires poetry The project requires pytest to discover tests, and it complies to PEP 517 via Poetry (see pyproject.toml) Github Actions are to run on commit as part of CI and automatic deployments.

Creating new release

Update scimschema/VERSION and pyproject.toml Merge into release branch

Contributing

This project is powered by the QA department at Huddle

The source code is available on GitHub.

Get in touch, via GitHub or otherwise, contributors are also welcome!

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

scimschema-0.3.1.tar.gz (18.3 kB view details)

Uploaded Source

Built Distribution

scimschema-0.3.1-py3-none-any.whl (24.8 kB view details)

Uploaded Python 3

File details

Details for the file scimschema-0.3.1.tar.gz.

File metadata

  • Download URL: scimschema-0.3.1.tar.gz
  • Upload date:
  • Size: 18.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.9.5 Linux/5.8.0-1033-azure

File hashes

Hashes for scimschema-0.3.1.tar.gz
Algorithm Hash digest
SHA256 4a925b3bbc151209421b598e31b5bc9b805f3a53bd34c75794fce4c54675203b
MD5 b4e9a6f96ae8f741fc9e74c28c2296fe
BLAKE2b-256 8d0c77103c14a530d2be96e4f6e4695fa5fed72c1058fd975f6c78485cb4808f

See more details on using hashes here.

File details

Details for the file scimschema-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: scimschema-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 24.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.6 CPython/3.9.5 Linux/5.8.0-1033-azure

File hashes

Hashes for scimschema-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 27bdffe33eacb3c3568b2d1b4a6b5b3e5dca838c8212b89599f87bbcfe2fc911
MD5 2607b91448ed7fdd39f48dccb9da475d
BLAKE2b-256 a4e3f068211c8d180eccf7e495b9374c9a1cdf54759951aa26442949315e2876

See more details on using hashes here.

Supported by

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