Method: devices.deviceUsers.clientStates.get

Gets the client state for the device user

HTTP request

GET https://cloudidentity.googleapis.com/v1beta1/{name=devices/*/deviceUsers/*/clientStates/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Resource name of the ClientState in format: devices/{deviceId}/deviceUsers/{device_user_id}/clientStates/{partner_id}, where deviceId is the unique ID assigned to the Device, device_user_id is the unique ID assigned to the User and partner_id identifies the partner storing the data. To get the client state for devices belonging to your own organization, the partnerId is in the format: customerId-*anystring*. Where the customerId is your organization's customer ID and anystring is any suffix. This suffix is used in setting up Custom Access Levels in Context-Aware Access. You may use my_customer instead of the customer ID for devices managed by your own organization.

You may specify - in place of the {deviceId}, so the ClientState resource name can be: devices/-/deviceUsers/{device_user_resource_id}/clientStates/{partner_id}.

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/{customerId}, where customerId is the customer to whom the device belongs.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of ClientState.

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.