Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 8045c4550a7f366dd071a6ffb27dba362e59bf95 / . / docs / dyn / cloudidentity_v1beta1.devices.deviceUsers.clientStates.html
blob: b555963fc764e1ad12d731c242980d197c971084 [file] [log] [blame]
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]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_v1beta1.html">Cloud Identity API</a> . <a href="cloudidentity_v1beta1.devices.html">devices</a> . <a href="cloudidentity_v1beta1.devices.deviceUsers.html">deviceUsers</a> . <a href="cloudidentity_v1beta1.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 Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]84 <code><a href="#patch">patch(name, body=None, customer=None, updateMask=None, x__xgafv=None)</a></code></p>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]85<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>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
93 <code class="details" id="get">get(name, customer=None, x__xgafv=None)</code>
94 <pre>Gets the client state for the device user
95
96Args:
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]97 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. You may specify `-` in place of the `{device_id}`, so the ClientState resource name can be: `devices/-/deviceUsers/{device_user_resource_id}/clientStates/{partner_id}`. (required)
98 customer: string, Optional. [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.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]99 x__xgafv: string, V1 error format.
100 Allowed values
101 1 - v1 error format
102 2 - v2 error format
103
104Returns:
105 An object of the form:
106
107 { # 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 -0800[diff] [blame]108 &quot;assetTags&quot;: [ # The caller can specify asset tags for this resource
109 &quot;A String&quot;,
110 ],
111 &quot;complianceState&quot;: &quot;A String&quot;, # The compliance state of the resource as specified by the API client.
112 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the client state data was created.
113 &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.
114 &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
115 &quot;healthScore&quot;: &quot;A String&quot;, # The Health score of the resource
116 &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.
117 &quot;a_key&quot;: { # Additional custom attribute values may be one of these types
118 &quot;boolValue&quot;: True or False, # Represents a boolean value.
119 &quot;numberValue&quot;: 3.14, # Represents a double value.
120 &quot;stringValue&quot;: &quot;A String&quot;, # Represents a string value.
121 },
122 },
123 &quot;lastUpdateTime&quot;: &quot;A String&quot;, # Output only. The time the client state data was last updated.
124 &quot;managed&quot;: &quot;A String&quot;, # The management state of the resource as specified by the API client.
125 &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.
126 &quot;ownerType&quot;: &quot;A String&quot;, # Output only. The owner of the ClientState
127 &quot;scoreReason&quot;: &quot;A String&quot;, # A descriptive cause of the health score.
128}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]129</div>
130
131<div class="method">
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]132 <code class="details" id="patch">patch(name, body=None, customer=None, updateMask=None, x__xgafv=None)</code>
yoshi-code-botb6dc1b92021-03-02 11:49:08 -0800[diff] [blame]133 <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
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]134
135Args:
136 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. (required)
137 body: object, The request body.
138 The object takes the form of:
139
140{ # 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 -0800[diff] [blame]141 &quot;assetTags&quot;: [ # The caller can specify asset tags for this resource
142 &quot;A String&quot;,
143 ],
144 &quot;complianceState&quot;: &quot;A String&quot;, # The compliance state of the resource as specified by the API client.
145 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time the client state data was created.
146 &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.
147 &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
148 &quot;healthScore&quot;: &quot;A String&quot;, # The Health score of the resource
149 &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.
150 &quot;a_key&quot;: { # Additional custom attribute values may be one of these types
151 &quot;boolValue&quot;: True or False, # Represents a boolean value.
152 &quot;numberValue&quot;: 3.14, # Represents a double value.
153 &quot;stringValue&quot;: &quot;A String&quot;, # Represents a string value.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]154 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]155 },
156 &quot;lastUpdateTime&quot;: &quot;A String&quot;, # Output only. The time the client state data was last updated.
157 &quot;managed&quot;: &quot;A String&quot;, # The management state of the resource as specified by the API client.
158 &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.
159 &quot;ownerType&quot;: &quot;A String&quot;, # Output only. The owner of the ClientState
160 &quot;scoreReason&quot;: &quot;A String&quot;, # A descriptive cause of the health score.
161}
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]162
yoshi-code-bota8b35b92021-03-31 13:33:30 -0700[diff] [blame]163 customer: string, Optional. [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 Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]164 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 -0700[diff] [blame]165 x__xgafv: string, V1 error format.
166 Allowed values
167 1 - v1 error format
168 2 - v2 error format
169
170Returns:
171 An object of the form:
172
173 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]174 &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.
175 &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.
176 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
177 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
178 {
179 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
180 },
181 ],
182 &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.
183 },
184 &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.
185 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
186 },
187 &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}`.
188 &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`.
189 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
190 },
191}</pre>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]192</div>
193
194</body></html>