Find Users

This API endpoint is not supported in the Free Trial cloud.

Use to find a specific user in the system by specifying search criteria, such as a group.

This endpoint is optimized to fetch a maximum of 50 users at a time. When the limit is reached, the results are truncated. To access the subsequent set of 50 users, you can use the _skip parameter, which allows you to bypass the initial set of users fetched and seamlessly retrieve the subsequent batch.

To be able to run this API endpoint, you need to be logged in as the user you want to find. To find a different user, you need to be an Admin user or part of Perfecto Support.

URL	Copy `https://<your-cloud>.app.perfectomobile.com/api/v1/users/search`
Method	`GET`

Header parameters

Name	Description
`Perfecto-Authorization`	Security Token

Query parameters

Parameter	Type	Default	Description
`username`	`string`		Username of the user to locate.
`firstName`	`string`		The first name of the user.
`lastName`	`string`		The last name of the user.
`groupKey`	`string`		The ID of the group that the new user is assigned to.
`isIdpUser`	`boolean`		A flag that indicates if the user is authenticated through a third-party identity provider (IdP).
`_skip`	`int`	0	Specifies how many elements to skip, if any. If used, 0 means not to skip any elements, 10 means to skip 10 elements, and so on. Use this parameter to fetch an additional set of users after the initial set of up to 50 users has been retrieved.
`_pageSize`	`int`	50	Specifies how many artifacts to retrieve per request. For example, a value of 1 means to return 1 element per request.
`_sort[0][field]`	`string`		The field by which to sort the search result. Valid fields: `username`, `firstName`, `lastName`, `groupKey`, `isIdpUser`
`_sort[0][order]`	`ASCEND/DESCEND`		The sort order of the search result (ascending or descending).

^* Mandatory

Success response

A list of users. The list may be truncated if pageSize is set or if the number of entities exceeds the default page size of 50.

Copy

Sample request

http://<your-cloud>.app.perfectomobile.com/api/v1/users/search?lastName=star&_sort[0][field]=firstName&_sort[0][order]=DESCEND&_pageSize=5&_skip=0&_groupKey=myGroup12&firstName=alex&username=alexBen

Copy

Sample JSON response

{
    "users": [
        {
            "username": z-automation-eyufi@perfectomobile.com,
            "firstName": bbb,
            "lastName": "star",
            "email": z-automation-eyufi@perfectomobile.com,
            "enabled": true,
            "isIdpUser": false,
            "lastLoginAt": 0
        },
        {
            "username": z-automation-pegmf@perfectomobile.com,
            "firstName": aaa,
            "lastName": "star",
            "email": z-automation-pegmf@perfectomobile.com,
            "enabled": true,
            "isIdpUser": true,
            "lastLoginAt": 0
        }
    ],
    "truncated": false
}

where truncated indicates if additional entities exist (used, for example, when pageSize is specified).