Page tree
Skip to end of metadata
Go to start of metadata

Last updated: Feb 12, 2020 13:19

Creates new User and Account objects in the system and associates them to each other.

Request syntax

https://mycloud.perfectomobile.com/services/users?operation=create&securityToken=value&email=value&userPassword=value[&optionalParameter=value]

Parameters

NameTypeDefaultDescription
securityToken*string
A unique cryptographic key assigned to an authorized user.
userstring

Deprecated. The name of the user running the operation. This will be saved in the new User's createdBy field.

Note: Going forward, all authentication requires a security token. For information on obtaining a security token, see Generate security tokens.

passwordstring

Deprecated. The password for the user.

Note: Going forward, all authentication requires a security token. For information on obtaining a security token, see Generate security tokens.

responseFormatstringjsonThe format of the response. Either JSON or XML
sendNotificationbooleanfalsetrue to email the user the credentials, Lab URL, documentation links, and support information if the operation is successful.
usernamestring
The name of the user being created. This parameter is mandatory if the lab is not configured to use the email address as the user.
userPassword *string
The password for the new user being created.
firstNamestring
The new user's first name.
lastNamestring
The new user's last name.
rolesstring
The roles assigned to the new user specified as a comma separated list.
groupsstring
The group id of the group the new user is assigned to.
locationstring
This parameter is applicable to users with the handset administration role, and corresponds to the location parameter specified on devices. By specifying a location, you enable the user to manage devices with that location. For example, by specifying the location as Paris, you enable the user to manage devices that have their location set to Paris.
companyNamestring
The name of the company the new user works for.
email *string
The new user's email address.
phoneNumberstring
The new user's land line phone number. For additional information see the Valid Phone Number Format
phoneNumberExtstring
The new user's phone number extension.
mobilePhone
Number
string
The new user's mobile phone number. For additional information see the Valid Phone Number Format
jobTitlestring
The new user's job title.
addressstring
The first line of the new user's address.
citystring
The city of the new user's address.
countrystring
The country of the new user's address.
statestring
The state of the new user's address.
zipCodestring
The Zip code of the new user's address.
websitestring
The new user's website.
birthDatestring
The new user's birthday specified in ISO format, i.e. yyyy-MM-dd.
genderstring
male or female.
statusstringactiveThe user's status specified as active or pending.
referredBystring
The name of the person who referred this user.
authenticationstringinternalIf external, a password is not required. If internal, a password is mandatory.
account.unlimitedbooleanfalsetrue to indicate that user has an unlimited number of tokens. For example, you might want to set this option to true for administrators.
account.tokensinteger0The number of tokens allocated to the user.

* Mandatory

Response

NameDescription
statussuccess if the operation completed successfully; otherwise failure.

Examples

Request with optional parameters

This example shows the request for creating a user with the following parameters:

NameValue
useradminUsername
passwordadminPassword
usernameJohnSmith
userPasswordPassword
firstNameJohn
lastNameSmith
countryUSA
statuspending
sendNotificationsfalse


Request
https://mycloud.perfectomobile.com/services/users?operation=create&securityToken=<your_token>&username=JohnSmith&userPassword=Password&firstName=John&lastName=Smith&country=USA&status=pending&sendNotifications=false 


Response format
{
	"status":"success"
}