Cloud Administration User Details API
The Cloud Administration User Details API enables Help Desk administrators to look up a single user without logging into the Cloud Administration Console. This API can look up only one user at a time.
Note: Make sure that RSA has enabled SMS Tokencode and Voice Tokencode authentication for your company. Otherwise, the User Details API does not include the smsNumber and voiceNumber in the response.
For information about managing access to this API, see Accessing the Cloud Administration APIs.
Authentication
Clients calling this API must authenticate themselves by including a JSON Web Token in a request. For information 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 retrieve information about a particular user.
| Method | Request URL | Response Content Type | Response Body | Response Codes |
|---|---|---|---|---|
| POST |
/AdminInterface/restapi/v1/users/lookup | application/json | User details with property | 200, 400, 403, 404, 415, 429, 500 |
Example Request Data
The following example displays a request.
POST /AdminInterface/restapi/v1/users/lookup
Accept: application/json
Authorization: Bearer <JWT token>
Request Body Parameters
The following table describes the request parameters.
| Request Parameter | Required | Description | Type |
|---|---|---|---|
| No | User's email address. Either email or username must be provided. | String | |
| username | No | The user's username. Either email or username must be provided. | String |
| searchUnsynched | No | When set to True, Cloud Access Service (CAS) searches for the user with the specified email address. If the user is not yet synchronized to the cloud, synchronization occurs before results are returned. This process significantly increases the search time. The default value is False. | Boolean |
Example Request Body
The following is an example request body.
{
"searchUnsynched" : "true",
"username" : "SampleUser1",
“email” : "SampleUser1@rsavia.com"
}
Example Response
The following example response shows the status of a single user:
{
"id": "d7c0c371-b892-8ec3-8ed3-c79fc2093b3c",
"emailAddress": "SampleUser1@rsavia.com",
"firstName": "SampleUser1",
"lastName": "SampleLname1",
"principalUsername": "SampleUser1",
"alternateUsername": "group1, group2",
"creationDate": "2026-09-04T15:12:52.000Z",
"identitySource": "LOCAL_IS",
"identitySourceType": "CLOUD",
"primaryUniqueIdentifier": "d7c0c371-b892-8ec3-8ed3-c79fc2093b3c",
"userStatus": "Enabled",
"markDeleted": false,
"highRiskUser": false,
"markDeletedAt": null,
"markDeletedBy": null,
"smsNumber": "+12345678910",
"voiceNumber": "+12345678910",
"isSmsLocked": false,
"isVoiceLocked": false,
"isTokenLocked": false,
"isFingerprintLocked": false,
"isApproveLocked": false,
"lastSyncTime": "2026-09-04T15:17:07.000Z",
"lastSuccessfulAuthenticationMethod": null,
"lastSuccessfulAuthenticationDate": null,
"monthLastAuthenticated": null,
"emergencyAccessStatus": "Disabled",
"emergencyTokencodeId": null,
"emergencyTokencodeExpiration": null,
"emergencyTokencodeLastUse": null,
"emergencyTokencodeOneTimeUse": null,
"offlineEmergencyAccessStatus": "Disabled",
"offlineEmergencyTokencodeExpiration": null,
"appAuthenticityCheckRelaxedUntil": null,
"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 is an example response for a user that has additional common schema attributes.
{
"id": "d7c0c371-b892-8ec3-8ed3-c79fc2093b3c",
"emailAddress": "SampleUser1@rsavia.com",
"firstName": "SampleUser1",
"lastName": "SampleLname1",
"creationDate": "2026-08-07T08:41:23.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-08-07T08:41:23.000Z",
"emergencyAccessStatus": "Disabled",
"emergencyTokencodeId": null,
"emergencyTokencodeExpiration": null,
"emergencyTokencodeLastUse": null,
"emergencyTokencodeOneTimeUse": null,
"offlineEmergencyTokencodeExpiration": null,
"offlineEmergencyAccessStatus": "Disabled",
"monthLastAuthenticated": null,
"principalUsername": "SampleUser1",
"alternateUsername": "group1, group2",
"primaryUniqueIdentifier": "d7c0c371-b892-8ec3-8ed3-c79fc2093b3c",
"lastSuccessfulAuthenticationMethod": null,
"lastSuccessfulAuthenticationDate": null,
"identitySourceSpecificGroups": [
"group1",
"group2"
],
"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": "username3@personal.com",
"mobile": "+1234567892",
"workPhone": "+0987654322",
"fullName": "sample fullName"
}Response Properties
The following table shows property descriptions and data types.
| Property | Description | Data Type |
|---|---|---|
| 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 CAS. | String |
| identitySource | Name of identity source. | String |
| userStatus | Enabled: Users can access protected resources. Disabled: Users cannot access protected resources or register devices. Pending Deletion: The user and all associated data and devices are automatically deleted from CAS seven days after being marked for deletion in the Cloud Administration Console. | 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 | String |
| markDeletedBy | Administrator who initiated mark for delete. | String |
| lastSuccessfulAuthenticationMethod | Specifies the authentication method(s) the user last used successfully. | String |
| lastSuccessfulAuthenticationDate | Shows the date and time when the user was last successfully authenticated. Note: This property is applicable only for cloud authentications. | String |
| smsNumber | Displays user 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 phone numbers after you click Show synchronized phone numbers. Phone numbers appear only if corresponding attributes were configured and synchronized. | String |
| isTokenLocked | Token locked status is either true (locked) or false (unlocked). | Boolean |
| isSmsLocked | SMS phone locked status is either true (locked) or false (unlocked). | Boolean |
| isVoiceLocked | Voice phone locked status is either true (locked) or false (unlocked). | Boolean |
| lastSyncTime | Most recent time when user details were synchronized with an identity source. See 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 and their descriptions for the User Details API.
| Code | Description |
|---|---|
| 200 | User is successfully found. |
| 400 | User ID not provided as parameter. |
| 403 | Not authorized to perform the request. |
| 404 | User is not found. |
| 415 | Unsupported media type (must be JSON). |
| 429 | Too many requests. |
| 500 | Internal error occurred when processing the request. |
Related Articles
Cloud Administration Authenticator Details API Version 1 115Number of Views Cloud Administration Synchronize User API 110Number of Views Cloud Administration Update SMS and Voice Phone API 100Number of Views Business Role Does not Show Missing Direct Entitlements 129Number of Views Authentication Manager Log Messages (23001-23091) 46Number of Views