Cloud Administration User Search API Version 2
Use the Cloud Administration User Search API Version 2 to find a user by searching for a string in the user's email address, name, or Mobile Lock device ID. When you search by name, you can enter a first name, last name, full name, partial first name, or partial last name. When you search by Mobile Lock device ID, you must enter the full ID.
For information about managing access to this API, see Accessing the Cloud Administration APIs.
Authentication
Clients calling this API to search for a user must authenticate themselves by including a JSON Web Token in a request. For instructions on using this token, see Authentication for the Cloud Administration REST APIs.
Software Developer Kit
You can download the API Software Developer Kit (SDK) from Cloud Administration REST API Download.
Request Requirements
Use the following information to search for a particular user.
| Method | Request URL | Response Content Type | Response Body | Response Codes |
|---|---|---|---|---|
| POST | /AdminInterface/restapi/v2/users/search | application/json | List of user details that match the search string in the email address, name, or Mobile Lock device ID. | 200, 400, 403, 429, 500 |
Resource Identifiers
The following resource identifiers are optional.
| Resource Identifier | Required | Description | Type |
|---|---|---|---|
| <pageSize> | No | Specifies the maximum number of matching results to return. Valid values are 1 to 25, inclusive. The default value is 25. | Integer |
| <pageNumber> | No | Zero-based index of the page to return. | Integer |
Example Request Data
The following example displays a user search request.
POST /AdminInterface/restapi/v2/users/search?pageSize=20
Accept: application/json
Authorization: Bearer <JWT token>
Example Request Body
The following examples show user search requests by email address, name, and Mobile Lock device ID.
Search by email address:
{
"emailLike": "j.doe"
}Search by name:
{
"nameLike": "abc"
}
Search by Mobile Lock device ID:
{
"mobileLockDeviceId": "5hjQP47C3D0TvYXJV99UfN6w"
}The following example request returns a user's additional common schema attributes.
{
"emailLike": "SampleUser1@rsavia.com
}Request Body Parameters
The following table describes the request parameters. Provide one search parameter per request.
| Request Parameter | Required | Description | Type |
|---|---|---|---|
| emailLike | Conditional | The user's email address must contain the literal string passed in this parameter. Do not use wildcards. | String |
| nameLike | Conditional | The user's name must match the string passed in this parameter. The string must be between 3 and 255 characters. Do not use wildcards or special characters. The response returns a single page of results. pageNumber and pageSize are ignored. | String |
| mobileLockDeviceId | Conditional | The ID of a Mobile Lock device. Returns the user who owns the device. pageNumber and pageSize are ignored. | String |
Response
The API returns an array of matching user data in JSON format, sorted in ascending alphabetical order by user email address. The API can find exact and partial matches. It returns the exact match first in the list of results. The remaining results are sorted in ascending order by user email address. If no matches are found, the API returns an empty body.
Example Response Body
The following example displays a response body.
{
"totalPages": 1,
"totalElements": 2,
"elements": [
{
"id": "53ea47b4-b1f0-2e6d-1da0-a5571ced5f9f",
"emailAddress": "j.doe1@mycompany.com",
"firstName": "Jane",
"lastName": "Doe",
"creationDate": "2018-08-31T19:10:30.045Z",
"identitySource": "My Company AD",
"userStatus": "Enabled",
"markDeleted": false,
"highRiskUser": false,
"markDeletedAt": null,
"markDeletedBy": null,
"smsNumber": "+11235556799",
"voiceNumber": "+17815551235",
"isTokenLocked": false,
"isSmsLocked": false,
"isVoiceLocked": false,
"lastSyncTime": "2018-08-31T19:20:30.045Z",
"monthLastAuthenticated": null,
"identitySourceSpecificGroups": [
"Group 1",
"Group 2"
],
"globalGroups": [
"Group 3"
]
},
{
"id": "f85b6e95-f41f-45b4-bc84-559fead6460c",
"emailAddress": "j.doe2@mycompany.com",
"firstName": "John",
"lastName": "Doe",
"creationDate": "2018-08-31T19:10:30.045Z",
"identitySource": "My Company AD",
"userStatus": "Enabled",
"markDeleted": false,
"highRiskUser": false,
"markDeletedAt": null,
"markDeletedBy": null,
"smsNumber": "+17815552234",
"voiceNumber": "+17815552235",
"isTokenLocked": false,
"isSmsLocked": false,
"isVoiceLocked": false,
"lastSyncTime": "2018-08-31T19:20:30.045Z",
"emergencyAccessStatus": "Enabled",
"emergencyTokencodeId": "007c4e8d-7450-4293-be46-16454a78a217",
"emergencyTokencodeExpiration": "2019-08-21T15:02:45.000Z",
"emergencyTokencodeLastUse": null,
"offlineEmergencyTokencodeExpiration": "2019-08-21T15:02:45.000Z",
"offlineEmergencyAccessStatus": "Enabled",
"monthLastAuthenticated": "Nov 2020",
"identitySourceSpecificGroups": [
"Group 1",
"Group 2"
],
"globalGroups": [
"Group 3"
]
}
]
}When Enable Common User Schema Attributes is enabled, the API returns additional common schema attributes in the response body. This setting is disabled by default. For more information, see the Common User Schema Attributes section in Identity Sources for Cloud Access Service.
The following example response includes the user's additional common schema attributes.
{
"elements": [
{
"id": "53ea47b4-b1f0-2e6d-1da0-a5571ced5f9f",
"emailAddress": "SampleUser1@rsavia.com",
"firstName": "SampleUser1",
"lastName": "SampleLname1",
"creationDate": "2026-07-30T08:48:19.000Z",
"identitySource": "local is",
"userStatus": "Enabled",
"highRiskUser": false,
"markDeleted": false,
"markDeletedAt": null,
"markDeletedBy": null,
"isTokenLocked": false,
"isSmsLocked": false,
"isVoiceLocked": false,
"isFingerprintLocked": false,
"isApproveLocked": false,
"lastSyncTime": "2026-07-30T08:48:19.000Z",
"emergencyAccessStatus": "Disabled",
"emergencyTokencodeId": null,
"emergencyTokencodeExpiration": null,
"emergencyTokencodeLastUse": null,
"emergencyTokencodeOneTimeUse": null,
"offlineEmergencyTokencodeExpiration": null,
"offlineEmergencyAccessStatus": "Disabled",
"monthLastAuthenticated": null,
"principalUsername": "SampleUser1",
"alternateUsername": "group1, group2",
"primaryUniqueIdentifier": "53ea47b4-b1f0-2e6d-1da0-a5571ced5f9f",
"lastSuccessfulAuthenticationMethod": null,
"lastSuccessfulAuthenticationDate": null,
"identitySourceSpecificGroups": [
"group2",
"group1"
],
"globalGroups": [],
"identitySourceType": "CLOUD",
"appAuthenticityCheckRelaxedUntil": null,
"businessCategory" : "Sample Business Category",
"companyOrOrganization" : "Sample Company",
"department" : "Sample Department",
"countryCode": "+1",
"description": "Software Engineer",
"displayName": "SampleUser1",
"employeeNumber": "EMP001",
"employeeType": "Full-Time",
"homeEmail": "username1@personal.com",
"mobile": "+1234567892",
"workPhone": "+0987654322",
"fullName" : "sample fullName"
}
],
"totalPages": 1,
"totalElements": 1
}Response Properties
The following table describes the properties in the response.
| Property | Description | Data Type |
|---|---|---|
| totalPages | Total number of user pages returned by the query. | Integer |
| totalElements | Total number of users returned by the query. | Integer |
| elements | List containing the users returned by the query. | List |
| id | Identifies the user. | String |
| emailAddress | User's email address. | String |
| firstName | User's first name. | String |
| lastName | User's last name. | String |
| creationDate | Date when the user account was added to Cloud Access Service. See https://www.w3.org/TR/NOTE-datetime for information on formatting timestamps in ISO 8601 format. | String |
| identitySource | Name of identity source. | String |
| userStatus | Enabled: Users can access protected resources. Disabled: Users cannot access protected resources or register devices. | String |
| markDeleted | Indicates whether the user is marked deleted. | Boolean |
| markDeletedAt | Date when a user is marked deleted. See https://www.w3.org/TR/NOTE-datetime for information on formatting timestamps in ISO 8601 format. | String |
| markDeletedBy | Administrator who initiated mark for delete. | String |
| smsNumber | Displays user SMS Tokencode phone numbers after you click Show synchronized phone numbers. Phone numbers appear only if corresponding attributes were configured and synchronized. | String |
| voiceNumber | Displays user Voice Tokencode phone numbers after you click Show synchronized phone numbers. Phone numbers appear only if corresponding attributes were configured and synchronized. | String |
| isTokenLocked | Tokencode status is true (locked) or false (unlocked). | Boolean |
| isSmsLocked | SMS Tokencode status is true (locked) or false (unlocked). | Boolean |
| isVoiceLocked | Voice Tokencode status is true (locked) or false (unlocked). | Boolean |
| lastSyncTime | Most recent time when user details were synchronized with an identity source. Check https://www.w3.org/TR/NOTE-datetime for information on formatting timestamps in ISO 8601 format. | String |
| highRiskUser | True indicates the user is marked as high risk by an external third-party application. False indicates the user is not marked as high risk by an external third-party application. | Boolean |
| emergencyAccessStatus | Enabled: An Emergency Tokencode has been generated for this user. Disabled: An Emergency Tokencode has not been generated for this user. Locked: Emergency Tokencode is locked for this user. | String |
| emergencyTokencodeId | Identifies the Emergency Tokencode, if one has been generated for this user. | String |
| emergencyTokencodeExpiration | Emergency Tokencode expiration date. | String |
| emergencyTokencodeLastUse | Emergency Tokencode last used date. | String |
| emergencyTokencodeOneTimeUse | True indicates that an Emergency Tokencode can be used only once. False indicates that an Emergency Tokencode can be used multiple times. | Boolean |
| offlineEmergencyTokencodeExpiration | Offline Emergency Tokencode expiration date. | String |
| offlineEmergencyAccessStatus | Enabled: An offline Emergency Tokencode has been generated for this user. Disabled: An offline Emergency Tokencode has not been generated for this user. | String |
| monthLastAuthenticated | Month the user last authenticated. Returns null if not applicable, or a date in MMM/YYYY format. | String |
| identitySourceSpecificGroups | Names of identity source groups that the user belongs to. | Array of strings |
| globalGroups | Names of CAS groups (local groups) that the user belongs to. | Array of strings |
| businessCategory | Descriptive text about an organizational unit the user is associated with. | String |
| companyOrOrganization | Name of the company or organization the user belongs to. | String |
| countryCode | Two-letter country code for the user. | String |
| department | Department the user belongs to. | String |
| description | Descriptive text about the user. | String |
| displayName | Name shown for the user. This may be the full name or a nickname set by the user or an administrator. | String |
| employeeNumber | Numeric or alphanumeric identifier assigned to the person. | String |
| employeeType | Job category of the employee. | String |
| fullName | User's full name. | String |
| homeEmail | Additional mail addresses associated with the user. | String |
| mobile | User's mobile phone number. | String |
| workPhone | User's work telephone number. | String |
Response Codes
The following table shows the response codes for this API.
| Code | Description |
|---|---|
| 200 | Search completed successfully. |
| 400 | Operation not performed because of client syntax errors. |
| 403 | Not authorized to perform the request. |
| 429 | Too many requests. |
| 500 | Internal error occurred when processing the request. |
Related Articles
Administration Log Messages for Cloud Access Service (80001 - 81402) 53Number of Views MFA Agent Test Authentication fails with error ServerConnectionFailed 250Number of Views Trying to get a MSI package built to deploy SA SFTP Agent via SCCM. 37Number of Views Assign a Hardware Token to a User in the User Dashboard 48Number of Views Mapping login name to UPN name in RSA Authentication Manager 8.x 621Number of Views