Required. To list all ClientStates, set this to "devices/-/deviceUsers/-". To list all ClientStates owned by a DeviceUser, set this to the resource name of the DeviceUser. Format: devices/{device}/deviceUsers/{deviceUser}
Query parameters
Parameters
customer
string
Optional. Resource name of the customer. If you're using this API for your own organization, use customers/my_customer If you're using this API to manage another organization, use customers/{customer}, where customer is the customer to whom the device belongs.
filter
string
Optional. Additional restrictions when fetching list of client states.
pageToken
string
Optional. A page token, received from a previous clientStates.list call. Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to clientStates.list must match the call that provided the page token.
orderBy
string
Optional. Order specification for client states in the response.
Request body
The request body must be empty.
Response body
Response message that is returned in clientStates.list.
If successful, the response body contains data with the following structure:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-06 UTC."],[[["\u003cp\u003eThis webpage details how to list client states for a given search query using the Cloud Identity API.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request uses a GET method with a specific URL structure including path parameters such as \u003ccode\u003eparent\u003c/code\u003e to specify the scope of the list, such as all client states or those for a specific device user.\u003c/p\u003e\n"],["\u003cp\u003eOptional query parameters like \u003ccode\u003ecustomer\u003c/code\u003e, \u003ccode\u003efilter\u003c/code\u003e, \u003ccode\u003epageToken\u003c/code\u003e, and \u003ccode\u003eorderBy\u003c/code\u003e are available to refine the search and pagination of client states.\u003c/p\u003e\n"],["\u003cp\u003eThe response body contains a list of \u003ccode\u003eclientStates\u003c/code\u003e objects and a \u003ccode\u003enextPageToken\u003c/code\u003e for pagination, if applicable.\u003c/p\u003e\n"],["\u003cp\u003eAccessing this API requires specific OAuth scopes, including \u003ccode\u003ecloud-identity.devices.readonly\u003c/code\u003e, \u003ccode\u003ecloud-identity.devices\u003c/code\u003e, or \u003ccode\u003ecloud-identity\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,[]]