Download Postman Collection
API Reference

Get Users

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

Retrieve all users and associated user profiles.

Usage Notes

SCIM Global User ID

  • The response body includes an 'id" attribute above the product schema which is the globalUserId for the given user profile. The globalUserId can be parsed and extracted for PATCH and DELETE user calls.
...{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:ice:2.0:EncompassInternalUser"
    ],
    "id": "a327ae1d-14d8-499a-a740-31d188ca65b1",
    "urn:ietf:params:scim:schemas:extension:ice:2.0:EncompassInternalUser":
    {...}
  • The API response only returns user profiles with a globalUserId. To retrieve a list of all users from Encompass, please use the GET/ encompass/v3/users API.

Filters

  • The enc_isRecursive filter will allow inclusion of subfolders to root folder (Administration). The users within those subfolders will be returned. The default is false and it returns just the root users.
    • Note: The startIndex changes when the subfolders are included.
  • The enc_orgId (currently defined as 'organization' in Encompass schema) will allow the ability to filter by organization/folder. When not provided, the API assume all orgIds. When provided, the API filters to a specific orgId. In order to include sub-folders, this parameter must be used with enc_isRecursive eq true.
    • Note: Applicable to Encompass product only.
  • The userName filter allows to filter the user list by the given userName. The userName filter cannot be used in conjunction with enc_orgId and enc_isRecursive as those filters work for use cases when retrieving a list of users.

Pagination

  • Request Parameters “startIndex” and “count” will allow you to specify which user record is the starting record, and how many user records to return. If you do not include these parameters, the first 10 user records will be returned.
  • Response
    • totalResults = The total number of Encompass user records in your instance.
    • itemsPerPage = Default is 10. Or, if “count” parameter is provided, is equal to the number of user records requested. Max is 100.
    • startIndex = Default is 1. Or, if “startIndex” parameter is provided, is equal to the starting user record you specified.

Get ALL Users Limitation for DDA (a.k.a AIQ) Product

  • To retrieve a user from the DDA product, you must pass the product schema and the userName filter as query parameters.
Language
© ICE Mortgage Technology, Inc. All rights reserved. Terms of Use