Namespace: SCIMMY.Messages
Namespace - SCIMMY.Messages
Description
SCIMMY provides a singleton class, SCIMMY.Messages, that includes tools for constructing and
consuming SCIM-compliant data messages to be sent to, or received from, a SCIM service provider.
Usage
- Kind:
- singleton
- Source:
- src/lib/messages.js, line 8
Classes
-
- Parses BulkRequest messages, making sure "Operations" have been specified, and conform with the SCIM protocol.
- Provides a method to apply BulkRequest operations and return the results as a BulkResponse.
-
- Encapsulates bulk operation results as BulkResponse messages for consumption by a client.
- Provides a method to unwrap BulkResponse results into operation success status, and map newly created resource IDs to their BulkRequest bulkIds.
-
- Formats exceptions to conform to the HTTP Status and Error Response Handling section of the SCIM protocol, ensuring HTTP status codes and scimType error detail keyword pairs are valid.
- When used to parse service provider responses, throws a new instance of
SCIMMY.Types.Errorwith details sourced from the message.
-
- Formats supplied service provider resources as ListResponse messages, handling pagination and sort when required.
-
- Parses PatchOp messages, making sure all specified "Operations" are valid and conform with the SCIM protocol.
- Provides a method to atomically apply PatchOp operations to a resource instance, handling any exceptions that occur along the way.
-
- Encapsulates HTTP POST data as SCIM SearchRequest messages.
- Provides a method to perform the search request against the declared or specified resource types.