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

blob: 0198314de86616e331c745cd98b54e1bd7f5f972 [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_v1beta1.html">Cloud Identity API</a> . <a href="cloudidentity_v1beta1.devices.html">devices</a> . <a href="cloudidentity_v1beta1.devices.deviceUsers.html">deviceUsers</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
				78	<code><a href="cloudidentity_v1beta1.devices.deviceUsers.clientStates.html">clientStates()</a></code>
				79	</p>
				80	<p class="firstline">Returns the clientStates Resource.</p>
				81
				82	<p class="toc_element">
				83	<code><a href="#approve">approve(name, body=None, x__xgafv=None)</a></code></p>
				84	<p class="firstline">Approves device to access user data.</p>
				85	<p class="toc_element">
				86	<code><a href="#block">block(name, body=None, x__xgafv=None)</a></code></p>
				87	<p class="firstline">Blocks device from accessing user data</p>
				88	<p class="toc_element">
				89	<code><a href="#cancelWipe">cancelWipe(name, body=None, x__xgafv=None)</a></code></p>
				90	<p class="firstline">Cancels an unfinished user account wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped.</p>
				91	<p class="toc_element">
				92	<code><a href="#close">close()</a></code></p>
				93	<p class="firstline">Close httplib2 connections.</p>
				94	<p class="toc_element">
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	95	<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	96	<p class="firstline">Deletes the specified DeviceUser. This also revokes the user's access to device data.</p>
				97	<p class="toc_element">
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	98	<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	99	<p class="firstline">Retrieves the specified DeviceUser</p>
				100	<p class="toc_element">
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	101	<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	102	<p class="firstline">Lists/Searches DeviceUsers.</p>
				103	<p class="toc_element">
				104	<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
				105	<p class="firstline">Retrieves the next page of results.</p>
				106	<p class="toc_element">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	107	<code><a href="#lookup">lookup(parent, androidId=None, pageSize=None, pageToken=None, rawResourceId=None, userId=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	108	<p class="firstline">Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: No properties need to be passed, the caller's credentials are sufficient to identify the corresponding DeviceUser. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.</p>
				109	<p class="toc_element">
				110	<code><a href="#lookup_next">lookup_next(previous_request, previous_response)</a></code></p>
				111	<p class="firstline">Retrieves the next page of results.</p>
				112	<p class="toc_element">
				113	<code><a href="#wipe">wipe(name, body=None, x__xgafv=None)</a></code></p>
				114	<p class="firstline">Wipes the user's account on a device.</p>
				115	<h3>Method Details</h3>
				116	<div class="method">
				117	<code class="details" id="approve">approve(name, body=None, x__xgafv=None)</code>
				118	<pre>Approves device to access user data.
				119
				120	Args:
				121	name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User. (required)
				122	body: object, The request body.
				123	The object takes the form of:
				124
				125	{ # Request message for approving the device to access user data.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	126	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	127
				128	x__xgafv: string, V1 error format.
				129	Allowed values
				130	1 - v1 error format
				131	2 - v2 error format
				132
				133	Returns:
				134	An object of the form:
				135
				136	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	137	"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.
				138	"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.
				139	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				140	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				141	{
				142	"a_key": "", # Properties of the object. Contains field @type with type URL.
				143	},
				144	],
				145	"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.
				146	},
				147	"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.
				148	"a_key": "", # Properties of the object. Contains field @type with type URL.
				149	},
				150	"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}`.
				151	"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`.
				152	"a_key": "", # Properties of the object. Contains field @type with type URL.
				153	},
				154	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	155	</div>
				156
				157	<div class="method">
				158	<code class="details" id="block">block(name, body=None, x__xgafv=None)</code>
				159	<pre>Blocks device from accessing user data
				160
				161	Args:
				162	name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User. (required)
				163	body: object, The request body.
				164	The object takes the form of:
				165
				166	{ # Request message for blocking account on device.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	167	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	168
				169	x__xgafv: string, V1 error format.
				170	Allowed values
				171	1 - v1 error format
				172	2 - v2 error format
				173
				174	Returns:
				175	An object of the form:
				176
				177	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	178	"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.
				179	"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.
				180	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				181	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				182	{
				183	"a_key": "", # Properties of the object. Contains field @type with type URL.
				184	},
				185	],
				186	"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.
				187	},
				188	"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.
				189	"a_key": "", # Properties of the object. Contains field @type with type URL.
				190	},
				191	"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}`.
				192	"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`.
				193	"a_key": "", # Properties of the object. Contains field @type with type URL.
				194	},
				195	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	196	</div>
				197
				198	<div class="method">
				199	<code class="details" id="cancelWipe">cancelWipe(name, body=None, x__xgafv=None)</code>
				200	<pre>Cancels an unfinished user account wipe. This operation can be used to cancel device wipe in the gap between the wipe operation returning success and the device being wiped.
				201
				202	Args:
				203	name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User. (required)
				204	body: object, The request body.
				205	The object takes the form of:
				206
				207	{ # Request message for cancelling an unfinished user account wipe.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	208	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	209
				210	x__xgafv: string, V1 error format.
				211	Allowed values
				212	1 - v1 error format
				213	2 - v2 error format
				214
				215	Returns:
				216	An object of the form:
				217
				218	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	219	"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.
				220	"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.
				221	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				222	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				223	{
				224	"a_key": "", # Properties of the object. Contains field @type with type URL.
				225	},
				226	],
				227	"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.
				228	},
				229	"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.
				230	"a_key": "", # Properties of the object. Contains field @type with type URL.
				231	},
				232	"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}`.
				233	"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`.
				234	"a_key": "", # Properties of the object. Contains field @type with type URL.
				235	},
				236	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	237	</div>
				238
				239	<div class="method">
				240	<code class="details" id="close">close()</code>
				241	<pre>Close httplib2 connections.</pre>
				242	</div>
				243
				244	<div class="method">
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	245	<code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	246	<pre>Deletes the specified DeviceUser. This also revokes the user's access to device data.
				247
				248	Args:
				249	name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User. (required)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	250	x__xgafv: string, V1 error format.
				251	Allowed values
				252	1 - v1 error format
				253	2 - v2 error format
				254
				255	Returns:
				256	An object of the form:
				257
				258	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	259	"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.
				260	"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.
				261	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				262	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				263	{
				264	"a_key": "", # Properties of the object. Contains field @type with type URL.
				265	},
				266	],
				267	"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.
				268	},
				269	"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.
				270	"a_key": "", # Properties of the object. Contains field @type with type URL.
				271	},
				272	"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}`.
				273	"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`.
				274	"a_key": "", # Properties of the object. Contains field @type with type URL.
				275	},
				276	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	277	</div>
				278
				279	<div class="method">
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	280	<code class="details" id="get">get(name, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	281	<pre>Retrieves the specified DeviceUser
				282
				283	Args:
				284	name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User. (required)
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	285	x__xgafv: string, V1 error format.
				286	Allowed values
				287	1 - v1 error format
				288	2 - v2 error format
				289
				290	Returns:
				291	An object of the form:
				292
				293	{ # Represents a user's use of a Device in the Cloud Identity Devices API. A DeviceUser is a resource representing a user's use of a Device
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	294	"compromisedState": "A String", # Compromised State of the DeviceUser object
				295	"createTime": "A String", # When the user first signed in to the device
				296	"firstSyncTime": "A String", # Output only. Most recent time when user registered with this service.
				297	"languageCode": "A String", # Output only. Default locale used on device, in IETF BCP-47 format.
				298	"lastSyncTime": "A String", # Output only. Last time when user synced with policies.
				299	"managementState": "A String", # Output only. Management state of the user on the device.
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	300	"name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the DeviceUser in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where `device_user_id` uniquely identifies a user's use of a device.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	301	"passwordState": "A String", # Password state of the DeviceUser object
				302	"userAgent": "A String", # Output only. User agent on the device for this specific user
				303	"userEmail": "A String", # Email address of the user registered on the device.
				304	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	305	</div>
				306
				307	<div class="method">
yoshi-code-bot	a8b35b9	2021-03-31 13:33:30 -0700	[diff] [blame]	308	<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	309	<pre>Lists/Searches DeviceUsers.
				310
				311	Args:
				312	parent: string, Required. To list all DeviceUsers, set this to "devices/-". To list all DeviceUsers owned by a device, set this to the resource name of the device. Format: devices/{device} (required)
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	313	filter: string, Optional. Additional restrictions when fetching list of devices. For a list of search fields, refer to [Mobile device search fields](https://developers.google.com/admin-sdk/directory/v1/search-operators). Multiple search fields are separated by the space character.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	314	orderBy: string, Optional. Order specification for devices in the response.
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	315	pageSize: integer, Optional. The maximum number of DeviceUsers to return. If unspecified, at most 5 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	316	pageToken: string, Optional. A page token, received from a previous `ListDeviceUsers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListBooks` must match the call that provided the page token.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	317	x__xgafv: string, V1 error format.
				318	Allowed values
				319	1 - v1 error format
				320	2 - v2 error format
				321
				322	Returns:
				323	An object of the form:
				324
				325	{ # Response message that is returned from the ListDeviceUsers method.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	326	"deviceUsers": [ # Devices meeting the list restrictions.
				327	{ # Represents a user's use of a Device in the Cloud Identity Devices API. A DeviceUser is a resource representing a user's use of a Device
				328	"compromisedState": "A String", # Compromised State of the DeviceUser object
				329	"createTime": "A String", # When the user first signed in to the device
				330	"firstSyncTime": "A String", # Output only. Most recent time when user registered with this service.
				331	"languageCode": "A String", # Output only. Default locale used on device, in IETF BCP-47 format.
				332	"lastSyncTime": "A String", # Output only. Last time when user synced with policies.
				333	"managementState": "A String", # Output only. Management state of the user on the device.
yoshi-code-bot	bfa2f1c	2021-05-08 07:21:27 -0700	[diff] [blame]	334	"name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the DeviceUser in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where `device_user_id` uniquely identifies a user's use of a device.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	335	"passwordState": "A String", # Password state of the DeviceUser object
				336	"userAgent": "A String", # Output only. User agent on the device for this specific user
				337	"userEmail": "A String", # Email address of the user registered on the device.
				338	},
				339	],
				340	"nextPageToken": "A String", # Token to retrieve the next page of results. Empty if there are no more results.
				341	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	342	</div>
				343
				344	<div class="method">
				345	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				346	<pre>Retrieves the next page of results.
				347
				348	Args:
				349	previous_request: The request for the previous page. (required)
				350	previous_response: The response from the request for the previous page. (required)
				351
				352	Returns:
				353	A request object that you can call 'execute()' on to request the next
				354	page. Returns None if there are no more items in the collection.
				355	</pre>
				356	</div>
				357
				358	<div class="method">
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	359	<code class="details" id="lookup">lookup(parent, androidId=None, pageSize=None, pageToken=None, rawResourceId=None, userId=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	360	<pre>Looks up resource names of the DeviceUsers associated with the caller's credentials, as well as the properties provided in the request. This method must be called with end-user credentials with the scope: https://www.googleapis.com/auth/cloud-identity.devices.lookup If multiple properties are provided, only DeviceUsers having all of these properties are considered as matches - i.e. the query behaves like an AND. Different platforms require different amounts of information from the caller to ensure that the DeviceUser is uniquely identified. - iOS: No properties need to be passed, the caller's credentials are sufficient to identify the corresponding DeviceUser. - Android: Specifying the 'android_id' field is required. - Desktop: Specifying the 'raw_resource_id' field is required.
				361
				362	Args:
				363	parent: string, Must be set to "devices/-/deviceUsers" to search across all DeviceUser belonging to the user. (required)
Yoshi Automation Bot	0bf565c	2020-12-09 08:56:03 -0800	[diff] [blame]	364	androidId: string, Android Id returned by [Settings.Secure#ANDROID_ID](https://developer.android.com/reference/android/provider/Settings.Secure.html#ANDROID_ID).
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	365	pageSize: integer, The maximum number of DeviceUsers to return. If unspecified, at most 20 DeviceUsers will be returned. The maximum value is 20; values above 20 will be coerced to 20.
				366	pageToken: string, A page token, received from a previous `LookupDeviceUsers` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `LookupDeviceUsers` must match the call that provided the page token.
				367	rawResourceId: string, Raw Resource Id used by Google Endpoint Verification. If the user is enrolled into Google Endpoint Verification, this id will be saved as the 'device_resource_id' field in the following platform dependent files. Mac: ~/.secureConnect/context_aware_config.json Windows: C:\Users\%USERPROFILE%\.secureConnect\context_aware_config.json Linux: ~/.secureConnect/context_aware_config.json
				368	userId: string, The user whose DeviceUser's resource name will be fetched. Must be set to 'me' to fetch the DeviceUser's resource name for the calling user.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	369	x__xgafv: string, V1 error format.
				370	Allowed values
				371	1 - v1 error format
				372	2 - v2 error format
				373
				374	Returns:
				375	An object of the form:
				376
				377	{ # Response containing resource names of the DeviceUsers associated with the caller's credentials.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	378	"customer": "A String", # The obfuscated customer Id that may be passed back to other Devices API methods such as List, Get, etc.
				379	"names": [ # [Resource names](https://cloud.google.com/apis/design/resource_names) of the DeviceUsers in the format: `devices/{device_id}/deviceUsers/{user_resource_id}`, where device_id is the unique ID assigned to a Device and user_resource_id is the unique user ID
				380	"A String",
				381	],
				382	"nextPageToken": "A String", # Token to retrieve the next page of results. Empty if there are no more results.
				383	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	384	</div>
				385
				386	<div class="method">
				387	<code class="details" id="lookup_next">lookup_next(previous_request, previous_response)</code>
				388	<pre>Retrieves the next page of results.
				389
				390	Args:
				391	previous_request: The request for the previous page. (required)
				392	previous_response: The response from the request for the previous page. (required)
				393
				394	Returns:
				395	A request object that you can call 'execute()' on to request the next
				396	page. Returns None if there are no more items in the collection.
				397	</pre>
				398	</div>
				399
				400	<div class="method">
				401	<code class="details" id="wipe">wipe(name, body=None, x__xgafv=None)</code>
				402	<pre>Wipes the user's account on a device.
				403
				404	Args:
				405	name: string, Required. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Device in format: `devices/{device_id}/deviceUsers/{device_user_id}`, where device_id is the unique ID assigned to the Device, and device_user_id is the unique ID assigned to the User. (required)
				406	body: object, The request body.
				407	The object takes the form of:
				408
				409	{ # Request message for starting an account wipe on device.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	410	}
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	411
				412	x__xgafv: string, V1 error format.
				413	Allowed values
				414	1 - v1 error format
				415	2 - v2 error format
				416
				417	Returns:
				418	An object of the form:
				419
				420	{ # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Bot	cc94ec8	2021-01-15 07:10:04 -0800	[diff] [blame]	421	"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.
				422	"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.
				423	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
				424	"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
				425	{
				426	"a_key": "", # Properties of the object. Contains field @type with type URL.
				427	},
				428	],
				429	"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.
				430	},
				431	"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.
				432	"a_key": "", # Properties of the object. Contains field @type with type URL.
				433	},
				434	"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}`.
				435	"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`.
				436	"a_key": "", # Properties of the object. Contains field @type with type URL.
				437	},
				438	}</pre>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	439	</div>
				440
				441	</body></html>