Creating Advisor Level Users

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

Simple Use Case: You would like to create Advisor level logins via API.

Scope and Outputs: This will be for creation of an Advisor level user that will have access to all Representatives data.  If the user should only have access to select Representatives data, please see Creating Representative Level Users.

Process Overview: Locate the Role that should be assigned to the user.  POST the payload with the associated information to the system to create the user.  All data is required in profiles section, additional required data highlighted in the payload example below. 

Process Steps:

1. GET: /Security/Roles/Simple
2. POST: /Security/Users?sendEmail=false  Here is a sample Payload

{
	"id": 0,
	"isActive": true,
	"profiles": [{
		"alClientId": 1350,
		"advisorName": "Orion Integration Demo (test)",
		"entity": "Advisor",
		"loginEntityId": "Advisor",
		"entityId": 0,
		"isUserDefault": true,
		"isInCurrentDb": true,
		"roleId": 1955,
		"hideRole": false
	}],
	"isSecureExchangeRecipient": true,
	"userId": "Test.Advisor.User",
	"firstName": "Test",
	"lastName": "Advisor",
	"email": "test@test.com",
	"entityName": "Advisor, Test"
}

Sample Reponse:

{
	"profiles": [{
		"id": 5382490,
		"loginEntityId": 5,
		"entity": "Advisor",
		"entityId": 0,
		"advisorName": "Orion Integration Demo (test)",
		"entityName": "",
		"roleId": 1955,
		"isUserDefault": true,
		"alClientId": 1350,
		"roleName": "Default Advisor",
		"isInCurrentDb": true
	}],
	"password": "SGTnTy7EKN",
	"isSecureExchangeRecipient": true,
	"partnerAppId": null,
	"errorMessage": null,
	"id": 1036369,
	"userId": "Test.Advisor.User",
	"firstName": "Test",
	"lastName": "Advisor",
	"email": "test@test.com",
	"isActive": true,
	"activeDate": "2022-08-25",
	"inactiveDate": null,
	"lastLogin": null,
	"lastPasswordChange": null,
	"isReset": true,
	"mobilePhone": null,
	"businessPhone": null,
	"businessPhoneExtension": null,
	"company": null,
	"jobTitle": null,
	"entityName": "Advisor, Test"
}

3. Provide Temporary password returned in response to appropriate party to create permanent password.   *See below for additional password option

Process Tips or Controls:

1. If sendEmail=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.

1. Optional fields are first name, job title, company, business phone, and mobile phone.