Creating Client Level Users

Purpose: This article will step through how to create Client level users via the API, as you would via the Manage Users app in Orion Connect. This will include how to assign the Household user should be associated with.

Simple Use Case: You would like to create new Client level users via the API.

Scope and Outputs: This is for the creation of Client level logins. The client must have a household already created in Orion. Please see Creating a New Portfolio or Household for instructions on creating the household.

Process Overview: Determine the Household to assign the new user. Update payload with details for user and household and POST newly created payload to create login and provide temp password.

Process Steps:

Add the user data to the Profiles section of the payload. In the “profiles” section, be sure to include all data except role, this will remain null for client users.
POST payload to Security/Users?sendEmail=false

Sample payload

{
	"profiles": [{
		"alClientId": 1350,
		"advisorName": "Orion Integration Demo",
		"entity": "Household",
		"entityName": "Dean And Elizabeth Martin",
		"loginEntityId": "Client",
		"entityId": 119,
		"isUserDefault": true,
		"isInCurrentDb": true,
		"roleId": null,
		"hideRole": true
	}],
	"password": null,
	"isSecureExchangeRecipient": false,
	"partnerAppId": null,
	"errorMessage": null,
	"id": 0,
	"userId": "annie.test.12",
	"firstName": "Dean And Elizabeth",
	"lastName": "Martin",
	"email": "bethmartin1@advisorengine.net",
	"isActive": true,
	"activeDate": null,
	"inactiveDate": null,
	"lastLogin": null,
	"lastPasswordChange": null,
	"isReset": null,
	"mobilePhone": "801-319-4052",
	"businessPhone": "4078675306",
	"businessPhoneExtension": "",
	"company": null,
	"jobTitle": null,
	"entityName": "Martin, Dean And Elizabeth"
}

Sample Response:

{
  "profiles": [
    {
      "id": 6963858,
      "loginEntityId": 4,
      "entity": "Household",
      "entityId": 119,
      "advisorName": "Orion Integration Demo",
      "entityName": "Dean Martin",
      "roleId": 5,
      "isUserDefault": true,
      "alClientId": 1350,
      "roleName": "Default Client",
      "isInCurrentDb": true
    }
  ],
  "password": "bI0wz6fddS",
  "isSecureExchangeRecipient": false,
  "partnerAppId": null,
  "errorMessage": null,
  "id": 1745614,
  "userId": "user.test.13",
  "firstName": "Dean And Elizabeth",
  "lastName": "Martin",
  "email": "test@test.net",
  "isActive": true,
  "activeDate": "2022-11-30",
  "inactiveDate": null,
  "lastLogin": null,
  "lastPasswordChange": null,
  "isReset": true,
  "mobilePhone": "800-800-0000",
  "businessPhone": "4008005006",
  "businessPhoneExtension": "",
  "company": null,
  "jobTitle": null,
  "entityName": "Martin, Dean And Elizabeth"
}

Process Tips and Controls:

Orion best practice is to use the email of the user as the userID, but not required.

2. If sentEmail=true when submitting the request, an email will be sent to the email listed in the payload with a reset link to update the password.

3. Optional fields are first name, job title, company, and business phone. Mobile is not requited but is recommended for two factor authentication.

Development Guides

Creating Client Level Users