client_states

Creates, updates, deletes, gets or lists a client_states resource.

Overview

Name	client_states
Type	Resource
Id	google.cloudidentity.client_states

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. Resource name of the ClientState in format: devices/{device}/deviceUsers/{device_user}/clientState/{partner}, where partner corresponds to the partner storing the data. For partners belonging to the "BeyondCorp Alliance", this is the partner ID specified to you by Google. For all other callers, this is a string of the form: {customer}-suffix, where customer is your customer ID. The suffix is any string the caller specifies. This string will be displayed verbatim in the administration console. This suffix is used in setting up Custom Access Levels in Context-Aware Access. Your organization's customer ID can be obtained from the URL: GET https://www.googleapis.com/admin/directory/v1/customers/my_customer The id field in the response contains the customer ID starting with the letter 'C'. The customer ID to be used in this API is the string after the letter 'C' (not including 'C')
assetTags	array	The caller can specify asset tags for this resource
complianceState	string	The compliance state of the resource as specified by the API client.
createTime	string (google-datetime)	Output only. The time the client state data was created.
customId	string	This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field.
etag	string	The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest
healthScore	string	The Health score of the resource. The Health score is the callers specification of the condition of the device from a usability point of view. For example, a third-party device management provider may specify a health score based on its compliance with organizational policies.
keyValuePairs	object	The map of key-value attributes stored by callers specific to a device. The total serialized length of this map may not exceed 10KB. No limit is placed on the number of attributes in a map.
lastUpdateTime	string (google-datetime)	Output only. The time the client state data was last updated.
managed	string	The management state of the resource as specified by the API client.
ownerType	string	Output only. The owner of the ClientState
scoreReason	string	A descriptive cause of the health score.

list

Successful response

Name	Datatype	Description
name	string	Output only. Resource name of the ClientState in format: devices/{device}/deviceUsers/{device_user}/clientState/{partner}, where partner corresponds to the partner storing the data. For partners belonging to the "BeyondCorp Alliance", this is the partner ID specified to you by Google. For all other callers, this is a string of the form: {customer}-suffix, where customer is your customer ID. The suffix is any string the caller specifies. This string will be displayed verbatim in the administration console. This suffix is used in setting up Custom Access Levels in Context-Aware Access. Your organization's customer ID can be obtained from the URL: GET https://www.googleapis.com/admin/directory/v1/customers/my_customer The id field in the response contains the customer ID starting with the letter 'C'. The customer ID to be used in this API is the string after the letter 'C' (not including 'C')
assetTags	array	The caller can specify asset tags for this resource
complianceState	string	The compliance state of the resource as specified by the API client.
createTime	string (google-datetime)	Output only. The time the client state data was created.
customId	string	This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field.
etag	string	The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest
healthScore	string	The Health score of the resource. The Health score is the callers specification of the condition of the device from a usability point of view. For example, a third-party device management provider may specify a health score based on its compliance with organizational policies.
keyValuePairs	object	The map of key-value attributes stored by callers specific to a device. The total serialized length of this map may not exceed 10KB. No limit is placed on the number of attributes in a map.
lastUpdateTime	string (google-datetime)	Output only. The time the client state data was last updated.
managed	string	The management state of the resource as specified by the API client.
ownerType	string	Output only. The owner of the ClientState
scoreReason	string	A descriptive cause of the health score.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	devicesId, deviceUsersId, clientStatesId	customer	Gets the client state for the device user
list	select	devicesId, deviceUsersId	customer, filter, pageToken, orderBy	Lists the client states for the given search query.
patch	update	devicesId, deviceUsersId, clientStatesId	customer, updateMask	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

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
clientStatesId	string
deviceUsersId	string
devicesId	string
customer	string
filter	string
orderBy	string
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets the client state for the device user

SELECT
name,
assetTags,
complianceState,
createTime,
customId,
etag,
healthScore,
keyValuePairs,
lastUpdateTime,
managed,
ownerType,
scoreReason
FROM google.cloudidentity.client_states
WHERE devicesId = '{{ devicesId }}' -- required
AND deviceUsersId = '{{ deviceUsersId }}' -- required
AND clientStatesId = '{{ clientStatesId }}' -- required
AND customer = '{{ customer }}';

list

Lists the client states for the given search query.

SELECT
name,
assetTags,
complianceState,
createTime,
customId,
etag,
healthScore,
keyValuePairs,
lastUpdateTime,
managed,
ownerType,
scoreReason
FROM google.cloudidentity.client_states
WHERE devicesId = '{{ devicesId }}' -- required
AND deviceUsersId = '{{ deviceUsersId }}' -- required
AND customer = '{{ customer }}'
AND filter = '{{ filter }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}';

UPDATE examples

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

UPDATE google.cloudidentity.client_states
SET 
data__etag = '{{ etag }}',
data__customId = '{{ customId }}',
data__assetTags = '{{ assetTags }}',
data__healthScore = '{{ healthScore }}',
data__scoreReason = '{{ scoreReason }}',
data__managed = '{{ managed }}',
data__complianceState = '{{ complianceState }}',
data__keyValuePairs = '{{ keyValuePairs }}'
WHERE 
devicesId = '{{ devicesId }}' --required
AND deviceUsersId = '{{ deviceUsersId }}' --required
AND clientStatesId = '{{ clientStatesId }}' --required
AND customer = '{{ customer}}'
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;