SCIMMY: Class - SCIMMY.Types.Schema

Class: SCIMMY .Types.Schema

SCIM Schema Type

Summary:

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).

Usage

Construct a resource instance after verifying schema compatibility

                    
                        new SCIMMY.Types.Schema(data, directionopt)

Source:: src/lib/types/schema.js, line 49

Parameters:

Name	Type	Default	Description
`data`	`Object`		the source data to feed through the schema definition
`directionopt`	`String`	`"both"`	whether the resource is inbound from a request or outbound for a response

Properties:

Name Type Description

id


    String

unique identifier for a SCIM resource as defined by the service provider


                        schemas


    String[]

namespace URIs of the SCIM schemas that define the attributes present in the current data structure


                        externalIdopt


    String

identifier for the resource as defined by the provisioning client


                        meta


    Object

a complex attribute containing resource metadata

Properties

Name	Type	Description
`resourceType`	`String`	name of the resource type of the resource
`createdopt`	`Date`	when the resource was added to the service provider
`lastModifiedopt`	`Date`	when this resource was last updated at the service provider
`location`	`String`	full, canonical URI of the resource being returned
`versionopt`	`String`	version of the resource being returned, if any

Members

(abstract, static) id: String

SCIM schema URN namespace

Type:: {String}
Source:: src/lib/types/schema.js, line 55

(abstract, static) definition: SCIMMY.Types.SchemaDefinition

Retrieves a schema's definition instance

Type:: {SCIMMY.Types.SchemaDefinition}
Source:: src/lib/types/schema.js, line 64

Methods

(static) extend(extension, requiredopt)

Extend a schema by mixing in other schemas or attributes

Source:: src/lib/types/schema.js, line 81

Parameters:

Name	Type	Default	Description
`extension`	`SCIMMY.Types.SchemaSCIMMY.Types.Attribute[]`		the schema extensions or collection of attributes to register
`requiredopt`	`Boolean`	`false`	if the extension is a schema, whether the extension is required

(static) truncate(attributes)

Remove an attribute, schema extension, or subAttribute from the schema's definition

Source:: src/lib/types/schema.js, line 93

Parameters:

Name	Type	Description
`attributes`	`SCIMMY.Types.SchemaStringSCIMMY.Types.AttributeString[]SCIMMY.Types.Attribute[]`	the child attributes to remove from the schema definition