REST Resource: devices.deviceUsers.clientStates

Resource: ClientState

Represents the state associated with an API client calling the Devices API.

Resource representing ClientState and supports updates from API users

JSON representation
{
  "name": string,
  "createTime": string,
  "lastUpdateTime": string,
  "etag": string,
  "customId": string,
  "assetTags": [
    string
  ],
  "healthScore": enum (HealthScore),
  "scoreReason": string,
  "managed": enum (ManagedState),
  "complianceState": enum (ComplianceState),
  "keyValuePairs": {
    string: {
      object(CustomAttributeValue)
    },
    ...
  },
  "ownerType": enum (OwnerType)
}
Fields
name

string

Output only. Resource name of the ClientState in format: devices/{device_id}/deviceUsers/{device_user_id}/clientState/{partner_id}, where partner_id 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_id}-suffix, where customer_id 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')

createTime

string (Timestamp format)

Output only. The time the client state data was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

lastUpdateTime

string (Timestamp format)

Output only. The time the client state data was last updated.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

etag

string

The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest

customId

string

This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field.

assetTags[]

string

The caller can specify asset tags for this resource

healthScore

enum (HealthScore)

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.

scoreReason

string

A descriptive cause of the health score.

managed

enum (ManagedState)

The management state of the resource as specified by the API client.

complianceState

enum (ComplianceState)

The compliance state of the resource as specified by the API client.

keyValuePairs

map (key: string, value: object (CustomAttributeValue))

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.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

ownerType

enum (OwnerType)

Output only. The owner of the ClientState

HealthScore

Enums
HEALTH_SCORE_UNSPECIFIED Default value
VERY_POOR The object is in very poor health as defined by the caller.
POOR The object is in poor health as defined by the caller.
NEUTRAL The object health is neither good nor poor, as defined by the caller.
GOOD The object is in good health as defined by the caller.
VERY_GOOD The object is in very good health as defined by the caller.

ManagedState

Management status of the device as provided by the Client

Enums
MANAGED_STATE_UNSPECIFIED The management state of the resource is unknown or unspecified.
MANAGED The resource is managed.
UNMANAGED The resource is not managed.

ComplianceState

Whether the object is compliant with third party policies or not

Enums
COMPLIANCE_STATE_UNSPECIFIED The compliance state of the resource is unknown or unspecified.
COMPLIANT Device is compliant with third party policies
NON_COMPLIANT Device is not compliant with third party policies

OwnerType

Ownership type of data

Enums
OWNER_TYPE_UNSPECIFIED Unknown owner type
OWNER_TYPE_CUSTOMER Customer is the owner
OWNER_TYPE_PARTNER Partner is the owner

Methods

get

Gets the client state for the device user

list

Lists the client states for the given search query.

patch

Updates the client state for the device user