SCIMMY 1.2.0

Class: SCIMMY.Resources.Schema

View Source on GitHub

Class: SCIMMY.Resources.Schema

SCIM Schema Resource

Summary:
  • Formats SCIM schema definition implementations declared in SCIMMY.Schemas for transmission/consumption according to the Schema Definition schema set out in RFC7643ยง7.

Usage

Instantiate a new SCIM Schema resource and parse any supplied parameters

                    
                        new SCIMMY.Resources.Schema(idopt, configopt)
Extends:
SCIMMY.Types.Resource
Source:
src/lib/resources/schema.js, line 11
Parameters:
Name Type Default Description
idopt String

the ID of the requested resource
configopt Object {}

the parameters of the resource instance request

Properties
Name Type Description
filteropt String

the filter to be applied on ingress/egress by implementing resource
excludedAttributesopt String

the comma-separated string list of attributes or filters to exclude on egress
attributesopt String

the comma-separated string list of attributes or filters to include on egress
sortByopt String

the attribute retrieved resources should be sorted by
sortOrderopt String

the direction retrieved resources should be sorted in
startIndexopt Number

offset index that retrieved resources should start from
countopt Number

maximum number of retrieved resources that should be returned in one operation
Properties:
Name Type Description
idopt String

ID of the resource instance being targeted
filteropt SCIMMY.Types.Filter

filter parsed from the supplied config
attributesopt SCIMMY.Types.Filter

attributes or excluded attributes parsed from the supplied config
constraintsopt Object

sort and pagination properties parsed from the supplied config

Properties
Name Type Description
sortByopt String

the attribute retrieved resources should be sorted by
sortOrderopt String

the direction retrieved resources should be sorted in
startIndexopt Number

offset index that retrieved resources should start from
countopt Number

maximum number of retrieved resources that should be returned in one operation

Members

Methods

(static) extend(extension, requiredopt) → {SCIMMY.Types.Resource, void}

Register an extension to the resource's core schema

Implements:
SCIMMY.Types.Resource.extend
Source:
src/lib/resources/schema.js, line 31
Throws:
{TypeError}

SCIM 'Schema' resource does not support extension

Parameters:
Name Type Description
extension SCIMMY.Types.Schema

the schema extension to register
requiredopt Boolean

whether the extension is required
Returns:

this resource type implementation for chaining

Type:
{SCIMMY.Types.Resource|void}