API.md

Table of Contents

• Constants.SCIM_BULK_REQUEST_MESSAGE_URN
• Constants.SCIM_BULK_RESPONSE_MESSAGE_URN
• Constants.SCIM_ERROR_MESSAGE_URN
• Constants.SCIM_LIST_RESPONSE_URN
• Constants.SCIM_MEDIA_TYPE
• Constants.SCIM_PATCH_MESSAGE_URN
• Constants.SCIM_SEARCH_REQUEST_URN
• Patch.addOperation
• Patch.patchRequest
• Patch.removeOperation
• Patch.replaceOperation
• Resource
  • get
  • id
  • meta
  • schemas
  • set
  • toJSON
  • fromJSON

Constants.SCIM_BULK_REQUEST_MESSAGE_URN

The SCIM 2 bulk request URN.

Constants.SCIM_BULK_RESPONSE_MESSAGE_URN

The SCIM 2 bulk response URN.

Constants.SCIM_ERROR_MESSAGE_URN

The SCIM 2 error message URN.

Constants.SCIM_LIST_RESPONSE_URN

The SCIM 2 list response URN.

Constants.SCIM_MEDIA_TYPE

The media type for SCIM 2 messages.

Constants.SCIM_PATCH_MESSAGE_URN

The SCIM 2 patch request URN.

Constants.SCIM_SEARCH_REQUEST_URN

The SCIM 2 search request URN.

Patch.addOperation

Create an 'add' patch operation.

Parameters

• path string A SCIM attribute path.
• value (string | number | boolean | Object) The value to add.

Returns Object An 'add' patch operation object.

Patch.patchRequest

Create a PATCH request from the provided patch operations.

Parameters

• operations Object One or more patch operations.

Returns string A PATCH request as a JSON string.

Patch.removeOperation

Create a 'remove' patch operation.

Parameters

• path string A SCIM attribute path.

Returns Object A 'remove' patch operation object.

Patch.replaceOperation

Create a 'replace' patch operation.

Parameters

• path string A SCIM attribute path.
• value (string | number | boolean | Object) The new value to set.

Returns Object A 'replace' patch operation object.

Resource

A class representing a generic SCIM resource, such as a user.

get

Get the attribute value at the specified path.

Parameters

• path string A SCIM attribute path.

Returns (string | number | boolean | Object) The value at the specified path, or undefined if the path does not exist.

id

Get the SCIM resource id.

Returns string The SCIM resource id.

meta

Get the SCIM resource's metadata. This might include the resource's location and created/updated timestamps.

Returns string The SCIM resource's metadata.

schemas

Get the SCIM resource's schemas.

Returns Array An array of SCIM schema URNs.

set

Set an attribute value at the specified path.

Parameters

• path string A SCIM attribute path.
• value (string | number | boolean | Object) The value to set.

toJSON

Get the SCIM resource as a JSON string.

fromJSON

Create a new {Resource} instance from a JSON string.

Parameters

• json string A SCIM resource in JSON format.

Returns Resource A SCIM resource object.