V3 Manage External Users

Use this API to add, update or delete an external user.

Usage Notes

  • The caller must have persona access to update or delete an external user.
  • When a user is deleted through this API, the user gets deleted from Encompass. The user will no longer appear in the UI and will be removed from the database as well.
  • When deleting an external user, there is no validation for loan or contact reassignment. Any loans or contacts assigned to the user must be reassigned manually.

📘

action=add

If the external user is created using this API, currently, the welcome email is not automatically triggered from Encompass. To trigger the email notifications, the administrator can do so from the Encompass admin settings user interface.

Language