V3 Create Internal User

Creates an Encompass internal user.

This API endpoint added with the 24.2 release of Encompass.

Usage Notes

  • Access Rights
    • Only administrators (admin account, Super Administrator persona, and/or Administrator persona) or non-admin users with the Settings “Organizations/User” persona can create user accounts.
    • The calling user only has access to create users within their same organization, or lower child organizations of their organization.
  • The “id” attribute is the Encompass user id and has the following requirements.
    • The ID can’t start with a period (.). The following characters can’t be used: (backslash),/ (forward slash), : (colon), * (asterisk), ? (question mark), “(quotation mark), < (less than) and > (greater than).
  • To create a user, the Query Parameter ‘orgId’1 and the following Request Payload attributes are required: Id, Firstname, LastName, WorkingFolder1, Email, Personas1.

1 Indicates that for these attributes, see the Company Setting exceptions below on attribute requirements.

  • Password is required, unless the user is an API User (apiUser = true) or an SSO user (isSsoOnly = true).
  • For Creating and Updating the Encompass user (Internal user) with cc site details; the user needs to pass CC site ID in the request payload.
  • Company Settings: A System Administrator can configure default values for user Organization, Persona and Working Folder attributes in the Admin Tools > Server Settings Manager > Policies for a given instance of Encompass. When the defaults are configured, then you do not need to provide the following parameter and/or properties in the request when creating an Encompass user.
AttributeLocated in...Company Setting, Category = PoliciesIf Company Setting is configured...If Company Setting is not configured...
orgIdQuery ParameterDefault Org Id for creating an internal userParameter not required. If not provided, configured ‘Default Org Id’ will be used.This query parameter must be provided.
PersonasRequest BodyDefault Persona Id for creating an internal userProperty not required. If not provided, configured ‘Default Persona Id’ will be used.This property must be provided.
workingFolderRequest BodyDefault Working Folder for creating an internal userProperty not required. If not provided, configured ‘Default Working Folder’ will be used.This property must be provided.
Language