SCIMMY: Class - SCIMMY.Resources.Group

Class: SCIMMY .Resources.Group

SCIM Group Resource

Summary:

Handles read/write/patch/dispose operations for SCIM Group resources with specified ingress/egress/degress methods.

Formats SCIM Group resources for transmission/consumption using the SCIMMY.Schemas.Group schema class.

Usage

Instantiate a new SCIM Group resource and parse any supplied parameters

                    
                        new SCIMMY.Resources.Group(idopt, configopt)

Extends:: SCIMMY.Types.Resource
Source:: src/lib/resources/group.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/group.js, line 14

(static) schema: SCIMMY.Types.Schema

Retrieves a resource's core schema

Type:: {SCIMMY.Types.Schema}
Implements:: SCIMMY.Types.Resource.schema
Source:: src/lib/resources/group.js, line 29

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/group.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) ingress(handler) → {SCIMMY.Types.Resource}

Sets the method to be called to consume a resource on create

Implements:: SCIMMY.Types.Resource.ingress
Source:: src/lib/resources/group.js, line 36

Parameters:

Name	Type	Description
`handler`	~IngressHandler	function to invoke to consume a resource on create

Returns:

this resource type class for chaining

Type:

{SCIMMY.Types.Resource}

(static) egress(handler) → {SCIMMY.Types.Resource}

Sets the method to be called to retrieve a resource on read

Implements:: SCIMMY.Types.Resource.egress
Source:: src/lib/resources/group.js, line 44

Parameters:

Name	Type	Description
`handler`	~EgressHandler	function to invoke to retrieve a resource on read

Returns:

this resource type class for chaining

Type:

{SCIMMY.Types.Resource}

(static) degress(handler) → {SCIMMY.Types.Resource}

Sets the method to be called to dispose of a resource on delete

Implements:: SCIMMY.Types.Resource.degress
Source:: src/lib/resources/group.js, line 52

Parameters:

Name	Type	Description
`handler`	~DegressHandler	function to invoke to dispose of a resource on delete

Returns:

this resource type class for chaining

Type:

{SCIMMY.Types.Resource}

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

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/group.js, line 75

Parameters:

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

Returns:

Type:

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

Examples:

// Retrieve group with ID "1234"
await (new SCIMMY.Resources.Group("1234")).read();

// Retrieve groups with a group name starting with "A"
await (new SCIMMY.Resources.Group({filter: 'displayName -sw "A"'})).read();

(async) write(instance, ctxopt) → {SCIMMY.Schemas.Group}

Calls resource's ingress method for consumption after unwrapping the SCIM resource

Implements:: SCIMMY.Types.Resource#write
Source:: src/lib/resources/group.js, line 100

Parameters:

Name	Type	Description
`instance`	Object	the raw resource type instance for consumption by ingress method
`ctxopt`	*	any additional context information to pass to the ingress handler

Returns:

Type:

{SCIMMY.Schemas.Group}

Examples:

// Create a new group with displayName "A Group"
await (new SCIMMY.Resources.Group()).write({displayName: "A Group"});

// Set members attribute for group with ID "1234"
await (new SCIMMY.Resources.Group("1234")).write({members: [{value: "5678"}]});

(async) patch(message, ctxopt) → {SCIMMY.Schemas.Group}

Retrieves resources via egress method, and applies specified patch operations. Emits patched resources for consumption with resource's ingress method.

See:: SCIMMY.Messages.PatchOp
Implements:: SCIMMY.Types.Resource#patch
Source:: src/lib/resources/group.js, line 126

Parameters:

Name	Type	Description
`message`	Object	the PatchOp message to apply to the received resource
`ctxopt`	*	any additional context information to pass to the ingress/egress handlers

Returns:

Type:

{SCIMMY.Schemas.Group}

Examples:

// Add member to group with ID "1234" with a patch operation (see SCIMMY.Messages.PatchOp)
await (new SCIMMY.Resources.Group("1234")).patch({Operations: [{op: "add", path: "members", value: {value: "5678"}}]});

(async) dispose(ctxopt)

Calls resource's degress method for disposal of the SCIM resource

Implements:: SCIMMY.Types.Resource#dispose
Source:: src/lib/resources/group.js, line 150

Parameters:

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

Examples:

// Delete group with ID "1234"
await (new SCIMMY.Resources.Group("1234")).dispose();