When specifying parameters, the following rules apply:
- Parameters specified will overwrite existing property values
- Parameters not specified will not change existing property values
To clear an existing property value, specify the parameter without a value.
Request syntax
https://mycloud.perfectomobile.com/services/users/<userId>?operation=update&user=value&password=value[&optionalParameter=value]Parameters
|
Name |
Type |
Default |
Description |
|---|---|---|---|
|
user* |
string |
|
The name of the user running the operation. |
|
password* |
string |
|
The password for the user running the operation. |
|
responseFormat |
string |
json |
The response format. Either json, or xml |
|
userPassword |
string |
|
The password of the target user |
|
firstName |
string |
|
The user's first name. |
|
lastName |
string |
|
The user's last name. |
|
roles |
list of strings |
|
The roles assigned to the user specified as a comma separated list. |
|
groups |
string |
|
The group id of the group to assign the user 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 user works for. |
|
|
string |
|
The user's email address. |
|
phoneNumber |
string |
|
Deprecated. The user's land line phone number. |
|
phoneNumberExt |
string |
|
Deprecated. The user's phone number extension. |
|
mobilePhone |
string |
|
Deprecated. The user's mobile phone number. |
|
jobTitle |
string |
|
Deprecated. The user's job title. |
|
address |
string |
|
Deprecated. The first line of the user's address. |
|
city |
string |
|
Deprecated. The city of the user's address. |
|
country |
string |
|
Deprecated. The country of the user's address. |
|
state |
string |
|
Deprecated. The state of the user's address. |
|
zipCode |
string |
|
Deprecated. The zip code of the user's address. |
|
website |
string |
|
Deprecated. The user's website. |
|
birthDate |
string |
|
Deprecated. The 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 |
The user’s authentication type, either internal (Perfecto SSO Authentication) or external (External SSO Authentication). |
|
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. |
* Mandatory parameter
Response
|
Name |
Description |
|---|---|
|
status |
success if the operation completed successfully; otherwise failure. |
Example
This example shows a request to update user JohnSmith, changing the firstName to James and clearing the country property.
https://mycloud.perfectomobile.com/services/users/JohnSmith?operation=update&user=adminUser&password=adminPassword&firstName=James&country=
