Create user

URL

POST https://{api-url}/api/v2/tenants/{orgId}/users

Sample URLs

https://{api-url}/api/v2/tenants/client_16/users

https://{api-url}/api/v2/tenants/msp_15/users

Parameters

Field	Data Type	Description
loginName	String	User login name.
lastName	String	User last name
firstName	String	User first name.
password	String	Password must have a minimum of 7 characters with at least: One number (0-9) One special character (#,!, $,*) One lowercase (a-z) One uppercase (A-Z) character
email	String	Email of the user. (Alert and report notifications are sent to the email address.)
country	String	Country name. To get the list of countries, use Get Countries API.
timeZone code	String	Time zone of the country. Use the Get Timezones API to retrieve the list of timezones. Example: "timeZone": { "code": "EST"}
address	String	(Optional) User address.
city	String	(Optional) City name.
state	String	(Optional) State name.
zip	String	(Optional) Zip code.
phoneNumber	String	(Optional) User phone number.
mobileNumber	String	(Optional) User mobile number.
altEmail	String	(Optional) Alternate email of user.
userAccountType	String	(Optional) User account type: REGULAR BUSINESS
designation	String	(Optional) User designation.
userNotifications	String	(Optional) Email to which the alert and report notifications are sent.
roles	String	(Optional) Defines permission sets to user and user groups on devices and device groups. Assign roles to a user. See Search Roles API to retrieve roles created under a partner or client.
userGroupType	String	(Optional) Assign users to all user groups, or specific users groups. A user can also be an individual user, NOT being part of any user group. Supported Values: ALL, NONE If a user should be part of all user groups, provide userGroupType: ALL If a user should be part of a specific user group, provide user group name. Example:"userGroups": [{ "name": "Luminalto Admins" }] If a user should NOT be part of any user group, provide userGroupType: NONE
userGroups name	String	(Optional) Assign users to specific user groups. Provide name of the user group.Use Search User Groups API to retrieve details of user groups.

Sample request

{
	"loginName" : "ScarletJohn",
	"password" : "ChangeMe@1234",
	"firstName" : "Scarlet",
	"lastName" : "John",
	"designation" : "Architect",
	"address" : "300 BOYLSTON AVE E",
	"city" : "SEATTLE ",
	"state" : "WA",
	"zip" : "98102",
	"country" : "United States",
	"email" : "scarlet@gmail.com",
	"altEmail" : "scarletjohn@gmail.com",
	"phoneNumber" : "206-232-4543",
	"mobileNumber" : "623-731-1540",
	"timeZone" : {
		"code" : "EST"
	},
	"userNotifications" : [
		{
			"notifyType" : "Account Information",
			"notifyMethod" : "Email",
			"notifyInputType" : "Primary Email",
			"notifyRecurringReport" : "false"
		},
		{
			"notifyType" : "Alert Notification",
			"notifyMethod" : "No Notify",
			"notifyRecurringReport" : "false"
		},
		{
			"notifyType" : "Report Notification",
			"notifyMethod" : "No Notify",
			"notifyRecurringReport" : false
		}
	],
	"roles" : [
		{
			"name" : "Client Administrator"
		},
		{
			"name" : "Client User"
		},
		{
			"name" : "Customer"
		},
		{
			"name" : "End User View"
		},
		{
			"name" : "ACS Client Administrator"
		}
	],
	"userGroups" : [
		{
			"name" : "Implementation Team"
		},
		{
			"name" : "Architecture Department"
		}
	]
}

Sample response

{
	"id": "USR0000002145",
	"loginName": "ScarletJohn",
	"lastName": "John",
	"firstName": "Scarlet",
	"email": "scarlet@gmail.com",
	"altEmail": "scarletjohn@gmail.com",
	"userAccountType": "REGULAR",
	"designation": "Architect",
	"address": "300 BOYLSTON AVE E",
	"city": "SEATTLE ",
	"state": "WA",
	"country": "United States",
	"zip": "98102",
	"phoneNumber": "206-232-4543",
	"mobileNumber": "623-731-1540",
	"timeZone": {
		"id": "7",
		"name": "America/New_York",
		"label": "GMT -05:00 Eastern",
		"code": "EST"
	},
	"roles": [{
			"id": 4,
			"name": "Client Administrator"
		},
		{
			"id": 5,
			"name": "Client User"
		},
		{
			"id": 6,
			"name": "Customer"
		},
		{
			"id": 9,
			"name": "End User View"
		},
		{
			"id": 10,
			"name": "ACS Client Administrator"
		}
	],
	"authType": "LOCAL",
	"userGroups": [{
			"uniqueId": "USRGRP-13cfc012-bb01-bbe3-6ed9-c46a192d0567",
			"name": "Implementation Team"
		},
		{
			"uniqueId": "USRGRP-ab5afe06-0cca-9b8f-6053-357531f7d9ff",
			"name": "Architecture Department"
		}
	],
	"status": "active",
	"orgId": "client_16",
	"profileImage": {
		"logoPath": "https://yourdomain.com/img/nophoto.gif",
		"thumbPath": "https://yourdomain.com/img/nophoto.gif",
		"tinyThumbPath": "https://yourdomain.com/img/wall_img1.gif"
	},
	"organizationName": "Luminalto",
	"userNotifications": [{
			"notifyType": "Account Information",
			"notifyMethod": "Email",
			"notifyInputType": "Primary Email",
			"notifyRecurringReport": false
		},
		{
			"notifyType": "Alert Notification",
			"notifyMethod": "No Notify",
			"notifyRecurringReport": false
		},
		{
			"notifyType": "Report Notification",
			"notifyMethod": "No Notify",
			"notifyRecurringReport": false
		}
	],
	"createdTime": "2016-11-01T11:54:24+0000",
	"updatedTime": "2016-11-01T11:54:24+0000"
}