SCIMMY: Class - SCIMMY.Resources.ResourceType

Class: SCIMMY .Resources.ResourceType

SCIM ResourceType Resource

Summary:

Formats SCIM Resource Type implementations declared in SCIMMY.Resources for transmission/consumption according to the ResourceType schema set out in RFC7643§6.

Usage

Instantiate a new SCIM ResourceType resource and parse any supplied parameters

                    
                        new SCIMMY.Resources.ResourceType(idopt, configopt)

Extends:: SCIMMY.Types.Resource
Source:: src/lib/resources/resourcetype.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

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

(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/resourcetype.js, line 14

Methods

(static) basepath(pathopt) → {SCIMMY.Types.Resource, String}

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

Implements:: SCIMMY.Types.Resource.basepath
Source:: src/lib/resources/resourcetype.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.Types.Resource|String}

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

Implements:: SCIMMY.Types.Resource.extend
Source:: src/lib/resources/resourcetype.js, line 32
Throws:: {TypeError}
SCIM 'ResourceType' 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}

(async) read(ctxopt) → {SCIMMY.Messages.ListResponse, SCIMMY.Schemas.ResourceType}

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/resourcetype.js, line 52

Parameters:

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

Returns:

Type:

{SCIMMY.Messages.ListResponse|SCIMMY.Schemas.ResourceType}