Method: devices.deviceUsers.clientStates.list

Lists the client states for the given search query.

HTTP request

GET https://cloudidentity.googleapis.com/v1/{parent=devices/*/deviceUsers/*}/clientStates

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

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

Required. 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_id}, where customer_id 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

If successful, the response body contains data with the following structure:

Response message that is returned in clientStates.list.

JSON representation
{
  "clientStates": [
    {
      object (ClientState)
    }
  ],
  "nextPageToken": string
}
Fields
clientStates[]

object (ClientState)

Client states meeting the list restrictions.

nextPageToken

string

Token to retrieve the next page of results. Empty if there are no more results.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-identity.devices.readonly
  • https://www.googleapis.com/auth/cloud-identity.devices
  • https://www.googleapis.com/auth/cloud-identity

For more information, see the Authentication Overview.