Download Postman Collection
API Reference

Update User

patch https://api.elliemae.com/scim2/v1/users/

Update user profiles associated with the SCIM Global User ID. Also, use this call to re-enable a user profile.

🚧

This API requires using Encompass version 24.2 or above.

Usage Notes

Operations

The following patch operations(op) are supported for the SCIM PATCH calls.

  • Add - Use this operation to add a new value for the attribute. In addition, this operation can be used to create a new user account for a given product and link the user account to an existing globalUserId.
  • Replace - Use this operation to replace existing value of an attribute and or to re-enable a disabled user.
  • Remove - Delete the existing value of an attribute specified in the path.
    • The "value" attribute is not applicable to the "remove" operation.
    • The "path" attribute is required for remove operation.
    • The filter details of what is to be removed must be sent as part of the path attribute.

Updating State License Information

  • When adding a new State license via PATCH with “add” operation, the “selected” attribute must be set to “true”, in order for the state license information to be added.
  • When updating the State license information, the best practice is also to use the “add” operation. Send only the attributes that need to be updated. You do not need to resend all attributes for the license object.
  • To indicate that a State license is no longer active, and retain all other information about that State license, use the “add” operation. Only send the “selected” attribute in the request, and set it to “false”. This will deactivate the license, but preserve all other data about that State license.
  • To completely remove all evidence of a State license, use the “replace” operation. Replace will completely clear out all field values for that State license record, as if it never existed. The only required attribute to completely remove evidence of a State license is the “stateAbbreviation” for the State license you want to remove, and it must be set to the two-digit State Postal Code, e.g. "WA" for Washington State.

Updating an Attribute

  • The path in the PATCH request body is used to specify the attribute/sub-attribute that should be updated.
    Example: "path": "urn:ietf:params:scim:schemas:extension:ice:2.0:EncompassInternalUser:name.middleName"
  • Path is an optional parameter for add and replace operations, there are two ways to define the operation in a payload: with or without the path parameter.
  • Although the path is not mandatory for add and replace operations, the path is supported for all operations.
Language
© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use