Legacy | Create User & Account

Restriction: This information no longer refers to the latest product version but may still be relevant if you are working with an older version.

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

Request syntax

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

Parameters

Name

Type

Default

Description

securityToken*

string


A unique cryptographic key assigned to an authorized user.

user

string


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

Important: All REST API commands require authentication through the Perfecto security token. See also Authentication in new APIs.

password

string


Deprecated. The password for the user.

Important: All REST API commands require authentication through the Perfecto security token. See also Authentication in new APIs.

responseFormat

string

json

The format of the response. Either JSON or XML

sendNotification

boolean

false

true to email the user the credentials, Lab URL, documentation links, and support information if the operation is successful.

username

string


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.

firstName

string


The new user's first name.

lastName

string


The new user's last name.

roles

string


The roles assigned to the new user specified as a comma separated list.

groups

string


The group id of the group the new user is assigned to.

location

string


Deprecated. 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.

companyName

string


Deprecated. The name of the company the new user works for.

email*

string


The new user's email address.

phoneNumber

string


Deprecated. The new user's land line phone number.

phoneNumberExt

string


Deprecated. The new user's phone number extension.

mobilePhone
Number

string


Deprecated. The new user's mobile phone number.

jobTitle

string


Deprecated. The new user's job title.

address

string


Deprecated. The first line of the new user's address.

city

string


Deprecated. The city of the new user's address.

country

string


Deprecated. The country of the new user's address.

state

string


Deprecated. The state of the new user's address.

zipCode

string


Deprecated. The Zip code of the new user's address.

website

string


Deprecated. The new user's website.

birthDate

string


Deprecated. The new user's birthday specified in ISO format, i.e. yyyy-MM-dd.

gender

string


Deprecated. Male or female.

status

string

active

Deprecated. The user's status specified as active or pending.

referredBy

string


Deprecated. The name of the person who referred this user.

authentication

string

internal

If external, a password is not required. If internal, a password is mandatory.

account.unlimited

boolean

false

Deprecated. true to indicate that user has an unlimited number of tokens. For example, you might want to set this option to true for administrators.

account.tokens

integer

0

Deprecated. The number of tokens allocated to the user.

* Mandatory parameter

Response

Name

Description

status

success if the operation completed successfully; otherwise failure.

Examples

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

Name

Value

username

JohnSmith

userPassword

Password

firstName

John

lastName

Smith

sendNotifications

false

Copy

Request with optional paramters

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

Response format

{
    "status":"success"}