scim2-models 0.6.1__tar.gz → 0.6.3__tar.gz

{scim2_models-0.6.1 → scim2_models-0.6.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: scim2-models
-Version: 0.6.1
+Version: 0.6.3
 Summary: SCIM2 models serialization and validation with pydantic
 Keywords: scim,scim2,provisioning,pydantic,rfc7643,rfc7644
 Author: Yaal Coop
@@ -240,6 +240,17 @@ Provisioning is the action of managing a set of resources across different servi
 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](https://datatracker.ietf.org/doc/html/rfc7643) (schema) and [RFC7644](https://datatracker.ietf.org/doc/html/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
 
 ```shell

{scim2_models-0.6.1 → scim2_models-0.6.3}/README.md

@@ -12,6 +12,17 @@ Provisioning is the action of managing a set of resources across different servi
 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](https://datatracker.ietf.org/doc/html/rfc7643) (schema) and [RFC7644](https://datatracker.ietf.org/doc/html/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
 
 ```shell

{scim2_models-0.6.1 → scim2_models-0.6.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "scim2-models"
-version = "0.6.1"
+version = "0.6.3"
 description = "SCIM2 models serialization and validation with pydantic"
 authors = [{name="Yaal Coop", email="contact@yaal.coop"}]
 license = {file = "LICENSE"}

{scim2_models-0.6.1 → scim2_models-0.6.3}/scim2_models/exceptions.py

@@ -52,6 +52,21 @@ class SCIMException(Exception):
             {"scim_type": self.scim_type, "status": self.status, **self.context},
         )
 
+    @classmethod
+    def from_error(cls, error: "Error") -> "SCIMException":
+        """Create an exception from a SCIM Error object.
+
+        :param error: The SCIM Error object to convert.
+        :return: The appropriate SCIMException subclass instance.
+        """
+        from .messages.error import Error
+
+        if not isinstance(error, Error):
+            raise TypeError(f"Expected Error, got {type(error).__name__}")
+
+        exception_class = _SCIM_TYPE_TO_EXCEPTION.get(error.scim_type or "", cls)
+        return exception_class(detail=error.detail)
+
 
 class InvalidFilterException(SCIMException):
     """The specified filter syntax was invalid.
@@ -263,3 +278,17 @@ class SensitiveException(SCIMException):
         "The specified request cannot be completed, due to the passing of sensitive "
         "information in a request URI"
     )
+
+
+_SCIM_TYPE_TO_EXCEPTION: dict[str, type[SCIMException]] = {
+    "invalidFilter": InvalidFilterException,
+    "tooMany": TooManyException,
+    "uniqueness": UniquenessException,
+    "mutability": MutabilityException,
+    "invalidSyntax": InvalidSyntaxException,
+    "invalidPath": InvalidPathException,
+    "noTarget": NoTargetException,
+    "invalidValue": InvalidValueException,
+    "invalidVers": InvalidVersionException,
+    "sensitive": SensitiveException,
+}

{scim2_models-0.6.1 → scim2_models-0.6.3}/scim2_models/path.py

@@ -9,6 +9,8 @@ from typing import NamedTuple
 from typing import TypeVar
 
 from pydantic import GetCoreSchemaHandler
+from pydantic import GetJsonSchemaHandler
+from pydantic.json_schema import JsonSchemaValue
 from pydantic_core import core_schema
 
 from .base import BaseModel
@@ -129,6 +131,14 @@ class Path(UserString, Generic[ResourceT]):
             serialization=core_schema.plain_serializer_function_ser_schema(str),
         )
 
+    @classmethod
+    def __get_pydantic_json_schema__(
+        cls,
+        _core_schema: core_schema.CoreSchema,
+        _handler: GetJsonSchemaHandler,
+    ) -> JsonSchemaValue:
+        return {"type": "string"}
+
     def __init__(self, path: "str | Path[Any]"):
         if isinstance(path, Path):
             path = str(path)

{scim2_models-0.6.1 → scim2_models-0.6.3}/scim2_models/reference.py

@@ -7,6 +7,8 @@ from typing import get_args
 from typing import get_origin
 
 from pydantic import GetCoreSchemaHandler
+from pydantic import GetJsonSchemaHandler
+from pydantic.json_schema import JsonSchemaValue
 from pydantic_core import Url
 from pydantic_core import ValidationError
 from pydantic_core import core_schema
@@ -112,6 +114,14 @@ class Reference(str, Generic[ReferenceTypes]):
             serialization=core_schema.plain_serializer_function_ser_schema(str),
         )
 
+    @classmethod
+    def __get_pydantic_json_schema__(
+        cls,
+        _core_schema: core_schema.CoreSchema,
+        _handler: GetJsonSchemaHandler,
+    ) -> JsonSchemaValue:
+        return {"type": "string", "format": "uri"}
+
     @classmethod
     def get_scim_reference_types(cls) -> list[str]:
         """Return referenceTypes for SCIM schema generation."""

{scim2_models-0.6.1 → scim2_models-0.6.3}/scim2_models/resources/enterprise_user.py

@@ -3,6 +3,7 @@ from typing import Annotated
 
 from pydantic import Field
 
+from ..annotations import CaseExact
 from ..annotations import Mutability
 from ..annotations import Required
 from ..attributes import ComplexAttribute
@@ -15,7 +16,7 @@ if TYPE_CHECKING:
 
 
 class Manager(ComplexAttribute):
-    value: Annotated[str | None, Required.true] = None
+    value: Annotated[str | None, Required.true, CaseExact.true] = None
     """The id of the SCIM resource representing the User's manager."""
 
     ref: Annotated[  # type: ignore[type-arg]

{scim2_models-0.6.1 → scim2_models-0.6.3}/scim2_models/resources/group.py

@@ -7,6 +7,7 @@ from typing import Union
 from pydantic import Field
 
 from ..annotations import Mutability
+from ..annotations import Required
 from ..attributes import ComplexAttribute
 from ..path import URN
 from ..reference import Reference
@@ -38,7 +39,7 @@ class GroupMember(ComplexAttribute):
 class Group(Resource[Any]):
     __schema__ = URN("urn:ietf:params:scim:schemas:core:2.0:Group")
 
-    display_name: str | None = None
+    display_name: Annotated[str | None, Required.true] = None
     """A human-readable name for the Group."""
 
     members: list[GroupMember] | None = None

{scim2_models-0.6.1 → scim2_models-0.6.3}/scim2_models/resources/resource.py

@@ -532,19 +532,21 @@ def _model_attribute_to_scim_attribute(
         else None
     )
 
-    return Attribute(
-        name=field_info.serialization_alias or attribute_name,
-        type=Attribute.Type(attribute_type),
-        multi_valued=model.get_field_multiplicity(attribute_name),
-        description=field_info.description,
-        canonical_values=field_info.examples,
-        required=model.get_field_annotation(attribute_name, Required),
-        case_exact=model.get_field_annotation(attribute_name, CaseExact),
-        mutability=model.get_field_annotation(attribute_name, Mutability),
-        returned=model.get_field_annotation(attribute_name, Returned),
-        uniqueness=model.get_field_annotation(attribute_name, Uniqueness),
-        sub_attributes=sub_attributes,
-        reference_types=root_type.get_scim_reference_types()  # type: ignore[attr-defined]
-        if attribute_type == Attribute.Type.reference
-        else None,
-    )
+    kwargs: dict[str, Any] = {
+        "name": field_info.serialization_alias or attribute_name,
+        "type": Attribute.Type(attribute_type),
+        "multi_valued": model.get_field_multiplicity(attribute_name),
+        "description": field_info.description,
+        "canonical_values": field_info.examples,
+        "required": model.get_field_annotation(attribute_name, Required),
+        "case_exact": model.get_field_annotation(attribute_name, CaseExact),
+        "mutability": model.get_field_annotation(attribute_name, Mutability),
+        "returned": model.get_field_annotation(attribute_name, Returned),
+        "sub_attributes": sub_attributes,
+    }
+    if attribute_type != Attribute.Type.complex:
+        kwargs["uniqueness"] = model.get_field_annotation(attribute_name, Uniqueness)
+    if attribute_type == Attribute.Type.reference:
+        kwargs["reference_types"] = root_type.get_scim_reference_types()  # type: ignore[attr-defined]
+
+    return Attribute(**kwargs)

{scim2_models-0.6.1 → scim2_models-0.6.3}/scim2_models/resources/resource_type.py

@@ -8,6 +8,7 @@ from ..annotations import CaseExact
 from ..annotations import Mutability
 from ..annotations import Required
 from ..annotations import Returned
+from ..annotations import Uniqueness
 from ..attributes import ComplexAttribute
 from ..path import URN
 from ..reference import URI
@@ -38,7 +39,13 @@ class SchemaExtension(ComplexAttribute):
 class ResourceType(Resource[Any]):
     __schema__ = URN("urn:ietf:params:scim:schemas:core:2.0:ResourceType")
 
-    name: Annotated[str | None, Mutability.read_only, Required.true] = None
+    name: Annotated[
+        str | None,
+        Mutability.read_only,
+        Required.true,
+        CaseExact.true,
+        Uniqueness.server,
+    ] = None
     """The resource type name.
 
     When applicable, service providers MUST specify the name, e.g.,
@@ -57,9 +64,9 @@ class ResourceType(Resource[Any]):
     This is often the same value as the "name" attribute.
     """
 
-    endpoint: Annotated[Reference[URI] | None, Mutability.read_only, Required.true] = (
-        None
-    )
+    endpoint: Annotated[
+        Reference[URI] | None, Mutability.read_only, Required.true, Uniqueness.server
+    ] = None
     """The resource type's HTTP-addressable endpoint relative to the Base URL,
     e.g., '/Users'."""
 

{scim2_models-0.6.1 → scim2_models-0.6.3}/scim2_models/resources/user.py

@@ -2,7 +2,6 @@ from enum import Enum
 from typing import TYPE_CHECKING
 from typing import Annotated
 from typing import ClassVar
-from typing import Union
 
 from pydantic import Base64Bytes
 from pydantic import EmailStr
@@ -180,7 +179,7 @@ class Address(ComplexAttribute):
 
     primary: bool | None = None
     """A Boolean value indicating the 'primary' or preferred attribute value
-    for this attribute, e.g., the preferred photo or thumbnail."""
+    for this attribute, e.g., the preferred address."""
 
 
 class Entitlement(ComplexAttribute):
@@ -202,8 +201,8 @@ class GroupMembership(ComplexAttribute):
     value: Annotated[str | None, Mutability.read_only] = None
     """The identifier of the User's group."""
 
-    ref: Annotated[  # type: ignore[type-arg]
-        Reference[Union["User", "Group"]] | None,
+    ref: Annotated[
+        Reference["Group"] | None,
         Mutability.read_only,
     ] = Field(None, serialization_alias="$ref")
     """The reference URI of a target resource, if the attribute is a