Class: SCIMMY.Resources.ServiceProviderConfig

SCIM ServiceProviderConfig Resource

Summary:
  • Formats SCIM Service Provider Configuration set in SCIMMY.Config for transmission/consumption according to the Service Provider Configuration schema set out in RFC7643ยง5.

Usage

Instantiate a new SCIM ServiceProviderConfig resource and parse any supplied parameters

                    
                        new SCIMMY.Resources.ServiceProviderConfig(idopt, configopt)
                    
                
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

Throws:
{TypeError}

SCIM 'ServiceProviderConfig' 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}