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.

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.

Resource Identifier

The following resource identifier is optional.

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 example displays a user search request.

{
    "emailLike": "j.doe"
}

Request Body Parameters

The following table describes the emailLike request parameter.

Response

The API returns an array of matching user data in JSON format, sorted in ascending alphabetical order according to the user email addresses.

The API can find exact and partial matches. The exact match is returned first in the list of results. The remaining results are sorted in ascending order according to the user email addresses.

If no matches are found, an empty body is returned.

Example Response Body

The following example displays a response body.

{
    "totalPages": 1,
    "totalElements": 2,
    "elements": [
        {
            "id": "f85b6e95-f41f-45b4-bc84-559fead6460c",
            "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"
            ]
        }
    ]
}

Response Property Descriptions

The following table describes the properties used in the response.

Response Codes

The following table shows the response codes for this API.