Namespace: SCIMMY.Types
Namespace - SCIMMY.Types
Description
SCIMMY provides a singleton class, SCIMMY.Types, that exposes the building blocks used to create SCIM schemas and resource types, and handle SCIM schema and protocol errors.
These can be used to construct custom resource types and handle errors encountered when invoking supplied read/write/delete handlers of built-in resources.
Usage
- Kind:
- singleton
- Source:
- src/lib/types.js, line 8
Classes
-
- Defines a SCIM schema attribute, and is used to ensure a given resource's value conforms to the attribute definition.
-
- Defines an underlying SCIM schema definition, containing the schema's URN namespace, friendly name, description, and collection of attributes that make up the schema.
- Provides a way to ensure all properties of a resource conform to their attribute definitions, as well as enabling JSON expression of schemas for consumption by other SCIM clients or service providers.
-
- Extends the native Error class and provides a way to express errors caused by SCIM protocol, schema conformity, filter expression, or other exceptions with details required by the SCIM protocol in RFC7644ยง3.12.
-
- Parses SCIM filter expressions into object representations of the filter expression.
-
- Extendable class representing a SCIM Resource Type, which acts as an interface between a SCIM resource type schema, and an app's internal data model.
- Handles incoming requests to read/write/delete a resource, parses any attribute, filter, and sort parameters of a request, and formats responses for consumption by other SCIM clients and service providers.
-
- Extendable class which provides the ability to construct resource instances with automated validation of conformity to a resource's schema definition.
- Once instantiated, any modifications will also be validated against the attached schema definition's matching attribute configuration (e.g. for mutability or canonical values).