1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="cloudidentity_v1.html">Cloud Identity API</a> . <a href="cloudidentity_v1.devices.html">devices</a> . <a href="cloudidentity_v1.devices.deviceUsers.html">deviceUsers</a> . <a href="cloudidentity_v1.devices.deviceUsers.clientStates.html">clientStates</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#get">get(name, customer=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Gets the client state for the device user</p> 83<p class="toc_element"> 84 <code><a href="#list">list(parent, customer=None, filter=None, orderBy=None, pageToken=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Lists the client states for the given search query.</p> 86<p class="toc_element"> 87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 88<p class="firstline">Retrieves the next page of results.</p> 89<p class="toc_element"> 90 <code><a href="#patch">patch(name, body=None, customer=None, updateMask=None, x__xgafv=None)</a></code></p> 91<p class="firstline">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</p> 92<h3>Method Details</h3> 93<div class="method"> 94 <code class="details" id="close">close()</code> 95 <pre>Close httplib2 connections.</pre> 96</div> 97 98<div class="method"> 99 <code class="details" id="get">get(name, customer=None, x__xgafv=None)</code> 100 <pre>Gets the client state for the device user 101 102Args: 103 name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the ClientState in format: `devices/{device}/deviceUsers/{device_user}/clientStates/{partner}`, where `device` is the unique ID assigned to the Device, `device_user` is the unique ID assigned to the User and `partner` 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 `{device}`, so the ClientState resource name can be: `devices/-/deviceUsers/{device_user_resource}/clientStates/{partner}`. (required) 104 customer: string, Optional. [Resource name](https://cloud.google.com/apis/design/resource_names) 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}`, where customer is the customer to whom the device belongs. 105 x__xgafv: string, V1 error format. 106 Allowed values 107 1 - v1 error format 108 2 - v2 error format 109 110Returns: 111 An object of the form: 112 113 { # Represents the state associated with an API client calling the Devices API. Resource representing ClientState and supports updates from API users 114 "assetTags": [ # The caller can specify asset tags for this resource 115 "A String", 116 ], 117 "complianceState": "A String", # The compliance state of the resource as specified by the API client. 118 "createTime": "A String", # Output only. The time the client state data was created. 119 "customId": "A String", # This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field. 120 "etag": "A String", # The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest 121 "healthScore": "A 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. 122 "keyValuePairs": { # 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. 123 "a_key": { # Additional custom attribute values may be one of these types 124 "boolValue": True or False, # Represents a boolean value. 125 "numberValue": 3.14, # Represents a double value. 126 "stringValue": "A String", # Represents a string value. 127 }, 128 }, 129 "lastUpdateTime": "A String", # Output only. The time the client state data was last updated. 130 "managed": "A String", # The management state of the resource as specified by the API client. 131 "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) 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') 132 "ownerType": "A String", # Output only. The owner of the ClientState 133 "scoreReason": "A String", # A descriptive cause of the health score. 134}</pre> 135</div> 136 137<div class="method"> 138 <code class="details" id="list">list(parent, customer=None, filter=None, orderBy=None, pageToken=None, x__xgafv=None)</code> 139 <pre>Lists the client states for the given search query. 140 141Args: 142 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} (required) 143 customer: string, Optional. [Resource name](https://cloud.google.com/apis/design/resource_names) 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}`, where customer is the customer to whom the device belongs. 144 filter: string, Optional. Additional restrictions when fetching list of client states. 145 orderBy: string, Optional. Order specification for client states in the response. 146 pageToken: string, Optional. A page token, received from a previous `ListClientStates` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListClientStates` must match the call that provided the page token. 147 x__xgafv: string, V1 error format. 148 Allowed values 149 1 - v1 error format 150 2 - v2 error format 151 152Returns: 153 An object of the form: 154 155 { # Response message that is returned in ListClientStates. 156 "clientStates": [ # Client states meeting the list restrictions. 157 { # Represents the state associated with an API client calling the Devices API. Resource representing ClientState and supports updates from API users 158 "assetTags": [ # The caller can specify asset tags for this resource 159 "A String", 160 ], 161 "complianceState": "A String", # The compliance state of the resource as specified by the API client. 162 "createTime": "A String", # Output only. The time the client state data was created. 163 "customId": "A String", # This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field. 164 "etag": "A String", # The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest 165 "healthScore": "A 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. 166 "keyValuePairs": { # 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. 167 "a_key": { # Additional custom attribute values may be one of these types 168 "boolValue": True or False, # Represents a boolean value. 169 "numberValue": 3.14, # Represents a double value. 170 "stringValue": "A String", # Represents a string value. 171 }, 172 }, 173 "lastUpdateTime": "A String", # Output only. The time the client state data was last updated. 174 "managed": "A String", # The management state of the resource as specified by the API client. 175 "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) 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') 176 "ownerType": "A String", # Output only. The owner of the ClientState 177 "scoreReason": "A String", # A descriptive cause of the health score. 178 }, 179 ], 180 "nextPageToken": "A String", # Token to retrieve the next page of results. Empty if there are no more results. 181}</pre> 182</div> 183 184<div class="method"> 185 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 186 <pre>Retrieves the next page of results. 187 188Args: 189 previous_request: The request for the previous page. (required) 190 previous_response: The response from the request for the previous page. (required) 191 192Returns: 193 A request object that you can call 'execute()' on to request the next 194 page. Returns None if there are no more items in the collection. 195 </pre> 196</div> 197 198<div class="method"> 199 <code class="details" id="patch">patch(name, body=None, customer=None, updateMask=None, x__xgafv=None)</code> 200 <pre>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 201 202Args: 203 name: string, Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) 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') (required) 204 body: object, The request body. 205 The object takes the form of: 206 207{ # Represents the state associated with an API client calling the Devices API. Resource representing ClientState and supports updates from API users 208 "assetTags": [ # The caller can specify asset tags for this resource 209 "A String", 210 ], 211 "complianceState": "A String", # The compliance state of the resource as specified by the API client. 212 "createTime": "A String", # Output only. The time the client state data was created. 213 "customId": "A String", # This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field. 214 "etag": "A String", # The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest 215 "healthScore": "A 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. 216 "keyValuePairs": { # 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. 217 "a_key": { # Additional custom attribute values may be one of these types 218 "boolValue": True or False, # Represents a boolean value. 219 "numberValue": 3.14, # Represents a double value. 220 "stringValue": "A String", # Represents a string value. 221 }, 222 }, 223 "lastUpdateTime": "A String", # Output only. The time the client state data was last updated. 224 "managed": "A String", # The management state of the resource as specified by the API client. 225 "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) 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') 226 "ownerType": "A String", # Output only. The owner of the ClientState 227 "scoreReason": "A String", # A descriptive cause of the health score. 228} 229 230 customer: string, Optional. [Resource name](https://cloud.google.com/apis/design/resource_names) 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}`, where customer is the customer to whom the device belongs. 231 updateMask: string, Optional. Comma-separated list of fully qualified names of fields to be updated. If not specified, all updatable fields in ClientState are updated. 232 x__xgafv: string, V1 error format. 233 Allowed values 234 1 - v1 error format 235 2 - v2 error format 236 237Returns: 238 An object of the form: 239 240 { # This resource represents a long-running operation that is the result of a network API call. 241 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 242 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 243 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 244 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 245 { 246 "a_key": "", # Properties of the object. Contains field @type with type URL. 247 }, 248 ], 249 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 250 }, 251 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 252 "a_key": "", # Properties of the object. Contains field @type with type URL. 253 }, 254 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 255 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 256 "a_key": "", # Properties of the object. Contains field @type with type URL. 257 }, 258}</pre> 259</div> 260 261</body></html>