blob: 23f71933dd4f4cfeb330ba930a017a4ffec83802 [file] [log] [blame]
Dmitry Frenkel3e17f892020-10-06 16:46:05 -07001<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">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080084 <code><a href="#list">list(parent, customer=None, filter=None, orderBy=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070085<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">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -080090 <code><a href="#patch">patch(name, body=None, customer=None, updateMask=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091<p class="firstline">Updates the client state for the device user</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:
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700103 name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the ClientState in format: `devices/{device_id}/deviceUsers/{device_user_id}/clientStates/{partner_id}`, where device_id 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&#x27;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. (required)
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700104 customer: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the customer. If you&#x27;re using this API for your own organization, use `customers/my_customer` If you&#x27;re using this API to manage another organization, use `customers/{customer_id}`, where customer_id 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
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800114 &quot;assetTags&quot;: [ # The caller can specify asset tags for this resource
115 &quot;A String&quot;,
116 ],
117 &quot;complianceState&quot;: &quot;A String&quot;, # The compliance state of the resource as specified by the API client.
118 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the client state data was created.
119 &quot;customId&quot;: &quot;A String&quot;, # This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field.
120 &quot;etag&quot;: &quot;A String&quot;, # The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest
121 &quot;healthScore&quot;: &quot;A String&quot;, # 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 &quot;keyValuePairs&quot;: { # 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 &quot;a_key&quot;: { # Additional custom attribute values may be one of these types
124 &quot;boolValue&quot;: True or False, # Represents a boolean value.
125 &quot;numberValue&quot;: 3.14, # Represents a double value.
126 &quot;stringValue&quot;: &quot;A String&quot;, # Represents a string value.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800127 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800128 },
129 &quot;lastUpdateTime&quot;: &quot;A String&quot;, # Output only. The time the client state data was last updated.
130 &quot;managed&quot;: &quot;A String&quot;, # The management state of the resource as specified by the API client.
131 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) 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 &quot;BeyondCorp Alliance&quot;, 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&#x27;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 &#x27;C&#x27;. The customer ID to be used in this API is the string after the letter &#x27;C&#x27; (not including &#x27;C&#x27;)
132 &quot;ownerType&quot;: &quot;A String&quot;, # Output only. The owner of the ClientState
133 &quot;scoreReason&quot;: &quot;A String&quot;, # A descriptive cause of the health score.
134}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700135</div>
136
137<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800138 <code class="details" id="list">list(parent, customer=None, filter=None, orderBy=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700139 <pre>Lists the client states for the given search query.
140
141Args:
142 parent: string, Required. To list all ClientStates, set this to &quot;devices/-/deviceUsers/-&quot;. To list all ClientStates owned by a DeviceUser, set this to the resource name of the DeviceUser. Format: devices/{device}/deviceUsers/{deviceUser} (required)
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800143 customer: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the customer. If you&#x27;re using this API for your own organization, use `customers/my_customer` If you&#x27;re using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800144 filter: string, Optional. Additional restrictions when fetching list of client states.
145 orderBy: string, Optional. Order specification for client states in the response.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800146 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700147 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800156 &quot;clientStates&quot;: [ # 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 &quot;assetTags&quot;: [ # The caller can specify asset tags for this resource
159 &quot;A String&quot;,
160 ],
161 &quot;complianceState&quot;: &quot;A String&quot;, # The compliance state of the resource as specified by the API client.
162 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the client state data was created.
163 &quot;customId&quot;: &quot;A String&quot;, # This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field.
164 &quot;etag&quot;: &quot;A String&quot;, # The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest
165 &quot;healthScore&quot;: &quot;A String&quot;, # 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 &quot;keyValuePairs&quot;: { # 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 &quot;a_key&quot;: { # Additional custom attribute values may be one of these types
168 &quot;boolValue&quot;: True or False, # Represents a boolean value.
169 &quot;numberValue&quot;: 3.14, # Represents a double value.
170 &quot;stringValue&quot;: &quot;A String&quot;, # Represents a string value.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700171 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800172 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800173 &quot;lastUpdateTime&quot;: &quot;A String&quot;, # Output only. The time the client state data was last updated.
174 &quot;managed&quot;: &quot;A String&quot;, # The management state of the resource as specified by the API client.
175 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) 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 &quot;BeyondCorp Alliance&quot;, 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&#x27;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 &#x27;C&#x27;. The customer ID to be used in this API is the string after the letter &#x27;C&#x27; (not including &#x27;C&#x27;)
176 &quot;ownerType&quot;: &quot;A String&quot;, # Output only. The owner of the ClientState
177 &quot;scoreReason&quot;: &quot;A String&quot;, # A descriptive cause of the health score.
178 },
179 ],
180 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results. Empty if there are no more results.
181}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700182</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 &#x27;execute()&#x27; 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">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800199 <code class="details" id="patch">patch(name, body=None, customer=None, updateMask=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700200 <pre>Updates the client state for the device user
201
202Args:
203 name: string, Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) 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 &quot;BeyondCorp Alliance&quot;, 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&#x27;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 &#x27;C&#x27;. The customer ID to be used in this API is the string after the letter &#x27;C&#x27; (not including &#x27;C&#x27;) (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
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800208 &quot;assetTags&quot;: [ # The caller can specify asset tags for this resource
209 &quot;A String&quot;,
210 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800211 &quot;complianceState&quot;: &quot;A String&quot;, # The compliance state of the resource as specified by the API client.
212 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the client state data was created.
213 &quot;customId&quot;: &quot;A String&quot;, # This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800214 &quot;etag&quot;: &quot;A String&quot;, # The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800215 &quot;healthScore&quot;: &quot;A String&quot;, # 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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800216 &quot;keyValuePairs&quot;: { # 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 &quot;a_key&quot;: { # Additional custom attribute values may be one of these types
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800218 &quot;boolValue&quot;: True or False, # Represents a boolean value.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800219 &quot;numberValue&quot;: 3.14, # Represents a double value.
220 &quot;stringValue&quot;: &quot;A String&quot;, # Represents a string value.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700221 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800222 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800223 &quot;lastUpdateTime&quot;: &quot;A String&quot;, # Output only. The time the client state data was last updated.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800224 &quot;managed&quot;: &quot;A String&quot;, # The management state of the resource as specified by the API client.
225 &quot;name&quot;: &quot;A String&quot;, # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) 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 &quot;BeyondCorp Alliance&quot;, 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&#x27;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 &#x27;C&#x27;. The customer ID to be used in this API is the string after the letter &#x27;C&#x27; (not including &#x27;C&#x27;)
226 &quot;ownerType&quot;: &quot;A String&quot;, # Output only. The owner of the ClientState
227 &quot;scoreReason&quot;: &quot;A String&quot;, # A descriptive cause of the health score.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800228}
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700229
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800230 customer: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the customer. If you&#x27;re using this API for your own organization, use `customers/my_customer` If you&#x27;re using this API to manage another organization, use `customers/{customer_id}`, where customer_id is the customer to whom the device belongs.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800231 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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700232 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.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800241 &quot;done&quot;: 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 &quot;error&quot;: { # 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 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
244 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
245 {
246 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
247 },
248 ],
249 &quot;message&quot;: &quot;A String&quot;, # 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 &quot;metadata&quot;: { # 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 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
253 },
254 &quot;name&quot;: &quot;A String&quot;, # 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 &quot;response&quot;: { # 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 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
257 },
258}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700259</div>
260
261</body></html>