Legacy | Get User List

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

When specifying multiple filter parameters, only the users that belong to all the listed parameters are returned in the response.

Request syntax

Copy

https://mycloud.perfectomobile.com/services/users?operation=list[&optionalParameter=value]&securityToken=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. 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 to use for the response: JSON, XML
responseFields	string		The fields to return in the response, specified as a comma-separated list. For example, lastLogin,location,roles.
firstName	string		The user's first name.
lastName	string		The user's last name.
roles	string		The roles assigned to the user-specified as a comma-separated list. When specifying multiple roles, only the users that belong to all the listed roles are returned in the response.
groups	string		The groups assigned to the user-specified as a comma-separated list. When specifying multiple groups, only the users that belong to all the listed groups are returned in the response.
location	string		Deprecated. This parameter is applicable to users with the handset administration role and corresponds to the location parameter specified on devices.
companyName	string		Deprecated. The name of the company the user works for.
email	string		The user's email address.
phoneNumber	string		Deprecated. The user's landline phone number.
phone NumberExt	string		Deprecated. The user's phone number extension.
mobilePhoneNumber	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.
externally Authenticated	boolean	false	true to indicate that the user uses an external LDAP server for authentication; By default, authentication is performed by the MobileCloud.
lastLogin	integer		The period of time since the last log in specified in minutes.
lastUpdate	integer		The period of time since the last update specified in minutes.

^* Mandatory parameter

Response

The response includes the following information regarding the system

Name	Description
creationTime	Time-stamp of the generation of the response in both ISO_DATETIME_FORMAT and in system milliseconds format
modelVersion	System build version number
productVersion	System release identifier
time	Time-stamp of the generation of the user information response in ISO_DATETIME_FORMAT

In addition to the list of User objects information for all user-id that match the filter (empty fields are not listed).

Example

This example shows the request for getting the list of users called John that last logged in within the last 60 minutes.

Copy

Request

https://mycloud.perfectomobile.com/services/users?operation=list&securityToken=<your_token>&firstName=John&lastLogin=600

Copy

Response

{
    "users":[{"username":"john@perfectomobile.com",
        "firstName":"John",
        "lastName":"Perfecto",
        "roles":["ECLIPSE","HANDSET_DEV_TUNNEL"],
        "groups":[],
        "email":"john@perfectomobile.com",
        "authentication":"internal",
        "lastLogin":"2016-11-16",
        "account":{"name":"john@perfectomobile.com",
        }
    }],
    "info":{"creationTime":{"formatted":"2016-11-16T14:39:43Z",
            "millis":"1479307183769"},
        "items":"1",
        "modelVersion":"2.19.0.0",
        "productVersion":"master",
        "time":"2016-11-16T14:39:43Z"    }
}