Blame - docs/dyn/cloudidentity_v1.devices.deviceUsers.clientStates.html - platform/external/python/google-api-python-client

blob: 2fd646214d81e35a3262b6813486a515774350f0 [file] [log] [blame]

Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	1	<html><body>
				2	<style>
				3
				4	body, 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
				15	body {
				16	font-size: 13px;
				17	padding: 1em;
				18	}
				19
				20	h1 {
				21	font-size: 26px;
				22	margin-bottom: 1em;
				23	}
				24
				25	h2 {
				26	font-size: 24px;
				27	margin-bottom: 1em;
				28	}
				29
				30	h3 {
				31	font-size: 20px;
				32	margin-bottom: 1em;
				33	margin-top: 1em;
				34	}
				35
				36	pre, code {
				37	line-height: 1.5;
				38	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
				39	}
				40
				41	pre {
				42	margin-top: 0.5em;
				43	}
				44
				45	h1, h2, h3, p {
				46	font-family: Arial, sans serif;
				47	}
				48
				49	h1, 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">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	84	<code><a href="#list">list(parent, customer=None, orderBy=None, pageToken=None, filter=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	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">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	90	<code><a href="#patch">patch(name, body=None, customer=None, updateMask=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	91	<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
				102	Args:
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	103	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'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 Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	104	customer: string, Required. [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_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
				110	Returns:
				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
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	114	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	115	"assetTags": [ # The caller can specify asset tags for this resource
				116	"A String",
				117	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	118	"complianceState": "A String", # The compliance state of the resource as specified by the API client.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	119	"lastUpdateTime": "A String", # Output only. The time the client state data was last updated.
				120	"customId": "A String", # This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field.
				121	"managed": "A String", # The management state of the resource as specified by the API client.
				122	"scoreReason": "A String", # A descriptive cause of the health score.
				123	"createTime": "A String", # Output only. The time the client state data was created.
				124	"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.
				125	"a_key": { # Additional custom attribute values may be one of these types
				126	"boolValue": True or False, # Represents a boolean value.
				127	"stringValue": "A String", # Represents a string value.
				128	"numberValue": 3.14, # Represents a double value.
				129	},
				130	},
				131	"etag": "A String", # The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest
				132	"name": "A 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 "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')
				133	"ownerType": "A String", # Output only. The owner of the ClientState
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	134	}</pre>
				135	</div>
				136
				137	<div class="method">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	138	<code class="details" id="list">list(parent, customer=None, orderBy=None, pageToken=None, filter=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	139	<pre>Lists the client states for the given search query.
				140
				141	Args:
				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)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	143	customer: string, Required. [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_id}`, where customer_id is the customer to whom the device belongs.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	144	orderBy: string, Optional. Order specification for client states in the response.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	145	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.
				146	filter: string, Optional. Additional restrictions when fetching list of client states.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	147	x__xgafv: string, V1 error format.
				148	Allowed values
				149	1 - v1 error format
				150	2 - v2 error format
				151
				152	Returns:
				153	An object of the form:
				154
				155	{ # Response message that is returned in ListClientStates.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	156	"nextPageToken": "A String", # Token to retrieve the next page of results. Empty if there are no more results.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	157	"clientStates": [ # Client states meeting the list restrictions.
				158	{ # Represents the state associated with an API client calling the Devices API. Resource representing ClientState and supports updates from API users
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	159	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	160	"assetTags": [ # The caller can specify asset tags for this resource
				161	"A String",
				162	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	163	"complianceState": "A String", # The compliance state of the resource as specified by the API client.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	164	"lastUpdateTime": "A String", # Output only. The time the client state data was last updated.
				165	"customId": "A String", # This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field.
				166	"managed": "A String", # The management state of the resource as specified by the API client.
				167	"scoreReason": "A String", # A descriptive cause of the health score.
				168	"createTime": "A String", # Output only. The time the client state data was created.
				169	"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.
				170	"a_key": { # Additional custom attribute values may be one of these types
				171	"boolValue": True or False, # Represents a boolean value.
				172	"stringValue": "A String", # Represents a string value.
				173	"numberValue": 3.14, # Represents a double value.
				174	},
				175	},
				176	"etag": "A String", # The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest
				177	"name": "A 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 "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')
				178	"ownerType": "A String", # Output only. The owner of the ClientState
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	179	},
				180	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	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
				188	Args:
				189	previous_request: The request for the previous page. (required)
				190	previous_response: The response from the request for the previous page. (required)
				191
				192	Returns:
				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">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	199	<code class="details" id="patch">patch(name, body=None, customer=None, updateMask=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	200	<pre>Updates the client state for the device user
				201
				202	Args:
				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 "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') (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
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	208	"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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	209	"assetTags": [ # The caller can specify asset tags for this resource
				210	"A String",
				211	],
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	212	"complianceState": "A String", # The compliance state of the resource as specified by the API client.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	213	"lastUpdateTime": "A String", # Output only. The time the client state data was last updated.
				214	"customId": "A String", # This field may be used to store a unique identifier for the API resource within which these CustomAttributes are a field.
				215	"managed": "A String", # The management state of the resource as specified by the API client.
				216	"scoreReason": "A String", # A descriptive cause of the health score.
				217	"createTime": "A String", # Output only. The time the client state data was created.
				218	"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.
				219	"a_key": { # Additional custom attribute values may be one of these types
				220	"boolValue": True or False, # Represents a boolean value.
				221	"stringValue": "A String", # Represents a string value.
				222	"numberValue": 3.14, # Represents a double value.
				223	},
				224	},
				225	"etag": "A String", # The token that needs to be passed back for concurrency control in updates. Token needs to be passed back in UpdateRequest
				226	"name": "A 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 "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')
				227	"ownerType": "A String", # Output only. The owner of the ClientState
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	228	}
				229
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	230	customer: string, Required. [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_id}`, where customer_id is the customer to whom the device belongs.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	232	x__xgafv: string, V1 error format.
				233	Allowed values
				234	1 - v1 error format
				235	2 - v2 error format
				236
				237	Returns:
				238	An object of the form:
				239
				240	{ # This resource represents a long-running operation that is the result of a network API call.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	241	"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.
				242	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	243	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	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	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	249	},
				250	"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}`.
				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.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	253	},
				254	"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.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame^]	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`.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	256	"a_key": "", # Properties of the object. Contains field @type with type URL.
				257	},
				258	}</pre>
				259	</div>
				260
				261	</body></html>