Method: devices.deviceUsers.clientStates.patch

Updates the client state for the device user

Note: This method is available only to customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud Identity Premium

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
clientState.name

string

Output only. Resource name of the ClientState in format: devices/{deviceId}/deviceUsers/{device_user_id}/clientState/{partner_id} , where partner_id corresponds to the partner storing the data.

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.

updateMask

string ( FieldMask format)

Optional. Comma-separated list of fully qualified names of fields to be updated. If not specified, all updatable fields in ClientState are updated.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo" .

Request body

The request body contains an instance of ClientState .

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authorization guide .

Design a Mobile Site
View Site in Mobile | Classic
Share by: