SCIMMY: Class - SCIMMY.Resources.Schema

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 12

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


    ~ListConstraints

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

(static) endpoint: String

Retrieves a resource's endpoint relative to the service provider's base URL

Type:: {String}
Implements:: SCIMMY.Types.Resource.endpoint
Source:: src/lib/resources/schema.js, line 14

Methods

(static) basepath(pathopt) → {SCIMMY.Resources.Schema|String}

Sets or retrieves the base path for resolution of a resource's location

Implements:: SCIMMY.Types.Resource.basepath
Source:: src/lib/resources/schema.js, line 21

Parameters:

Name	Type	Description
`pathopt`	`String`	the path to use as the base of a resource's location

Returns:

this resource type class for chaining if path is a string, or the resource's basepath

Type:

{SCIMMY.Resources.Schema|String}

(static) extend() » TypeError

Overrides:: SCIMMY.Types.Resource.extend
Source:: src/lib/resources/schema.js, line 32
Throws:: {TypeError}
SCIM 'Schema' resource does not support extension

(async) read(ctxopt) → {SCIMMY.Messages.ListResponse|~SchemaDescription}

Calls resource's egress method for data retrieval. Wraps the results in valid SCIM list response or single resource syntax.

Implements:: SCIMMY.Types.Resource#read
Source:: src/lib/resources/schema.js, line 49

Parameters:

Name	Type	Description
`ctxopt`	`*`	any additional context information to pass to the egress handler

Returns:

the specifically requested resource instance, if an ID was supplied to resource constructor, or collection of resources matching instance's configured filter.

Type:

{SCIMMY.Messages.ListResponse|~SchemaDescription}