Search for users API

Use the Search for users API to search for all users in the Control Room.

1. Add the authentication token to the request header.
2. Apply filters to perform basic conditional queries and pagination control for processing web pages. There are three basic features related to filtering: filtering conditions, sorting columns, and pagination parameters. See Filters in an API request body.
3. Use the POST method and endpoint URL:<your_control_room_url>/v1/usermanagement/users/list

   Request body:

   {
     "fields": [],
     "filter": {
       "operator": "and",
       "operands": [
         {
           "operator": "substring",
           "field": "username",
           "value": "mdadmin"
         },
         {
           "operator": "gt",
           "field": "createdOn",
           "value": "2020-09-01T00:00:00.989Z"
         },
         {
           "operator": "lt",
           "field": "createdOn",
           "value": "2020-09-06T23:00:00.123Z"
         }
       ]
     }
   }

4. Send the request.

   The following request finds all users with a username that contains admin and were created between September 1 and September 6, 2020.

   Response body:

   {
     "page": {
       "offset": 0,
       "total": 310,
       "totalFilter": 2
     },
     "list": [
       {
         "id": 1513,
         "username": "mdadmin",
         "domain": "",
         "firstName": "MD_tester",
         "lastName": "MD_user",
         "version": 17,
         "principalId": 1513,
         "email": "md@aa.com",
         "emailVerified": true,
         "passwordSet": true,
         "questionsSet": true,
         "enableAutoLogin": false,
         "disabled": false,
         "clientRegistered": false,
         "description": "To be used for API testing",
         "createdBy": 1,
         "createdOn": "2020-09-01T11:01:17.760Z",
         "updatedBy": 1,
         "updatedOn": "2020-09-01T11:01:17.760Z",
         "licenseFeatures": [],
         "roles": [
           {
             "id": 1,
             "name": "AAE_Admin"
           },
           {
             "id": 2,
             "name": "AAE_Basic"
           }
         ],
         "deleted": false
       },
       {
         "id": 1520,
         "username": "mt_admin",
         "domain": "",
         "firstName": "",
         "lastName": "",
         "version": 6,
         "principalId": 1520,
         "email": "a@a.com",
         "emailVerified": true,
         "passwordSet": true,
         "questionsSet": true,
         "enableAutoLogin": false,
         "disabled": false,
         "clientRegistered": false,
         "description": "",
         "createdBy": 1,
         "createdOn": "2020-09-02T08:47:19.723Z",
         "updatedBy": 1,
         "updatedOn": "2020-09-02T08:47:19.723Z",
         "licenseFeatures": [],
         "roles": [
           {
             "id": 1,
             "name": "AAE_Admin"
           }
         ],
         "deleted": false
       }
     ]
   }

   The response returned data for two user names containing the word admin, mdadmin and mt_admin.

   Response parameters:

   Parameter Name	Description
   id	System-generated ID number who created a user.
   username	User name for a new user.
   domain	Active directory domain name.
   version	System-generated version number for a new user.
   email	New user email address.
   passwordSet	String: 8-15 characters; a-z, A-Z, 0-9, @, -, _, !, #, $, %, &, and . (period). Set a password for a new user only.
   PrincipalId	System-generated ID number of an active directory principal user who created a new user.
   Permission	A specific permission ID.
   licenseFeature	Automation Anywhere license associated with this role.
   Roles: id	System-generated role ID number associated with this user. Not every user has an associated role.
   createdBy	System-generated ID number of an admin user who created a new user.
   updatedBy	System-generated ID number of an admin user who updated the user.

   The REST API responds to each request with an HTTP response code. For details about the response codes, see API response codes.