Blame - docs/dyn/androidenterprise_v1.users.html - platform/external/python/google-api-python-client

blob: 036caa3f32cdaff131dda15a0d96be4f7e6d51e2 [file] [log] [blame]

Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[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
Nathaniel Manista	4f877e5	2015-06-15 16:44:50 +0000	[diff] [blame]	75	<h1><a href="androidenterprise_v1.html">Google Play EMM API</a> . <a href="androidenterprise_v1.users.html">users</a></h1>
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	78	<code><a href="#delete">delete(enterpriseId, userId)</a></code></p>
				79	<p class="firstline">Deleted an EMM-managed user.</p>
				80	<p class="toc_element">
				81	<code><a href="#generateAuthenticationToken">generateAuthenticationToken(enterpriseId, userId)</a></code></p>
				82	<p class="firstline">Generates an authentication token which the device policy client can use to provision the given EMM-managed user account on a device. The generated token is single-use and expires after a few minutes.</p>
				83	<p class="toc_element">
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	84	<code><a href="#generateToken">generateToken(enterpriseId, userId)</a></code></p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	85	<p class="firstline">Generates a token (activation code) to allow this user to configure their managed account in the Android Setup Wizard. Revokes any previously generated token.</p>
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	86	<p class="toc_element">
				87	<code><a href="#get">get(enterpriseId, userId)</a></code></p>
				88	<p class="firstline">Retrieves a user's details.</p>
				89	<p class="toc_element">
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	90	<code><a href="#getAvailableProductSet">getAvailableProductSet(enterpriseId, userId)</a></code></p>
				91	<p class="firstline">Retrieves the set of products a user is entitled to access.</p>
				92	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	93	<code><a href="#insert">insert(enterpriseId, body=None)</a></code></p>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	94	<p class="firstline">Creates a new EMM-managed user.</p>
				95	<p class="toc_element">
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	96	<code><a href="#list">list(enterpriseId, email)</a></code></p>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	97	<p class="firstline">Looks up a user by primary email address. This is only supported for Google-managed users. Lookup of the id is not needed for EMM-managed users because the id is already returned in the result of the Users.insert call.</p>
				98	<p class="toc_element">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	99	<code><a href="#revokeDeviceAccess">revokeDeviceAccess(enterpriseId, userId)</a></code></p>
				100	<p class="firstline">Revokes access to all devices currently provisioned to the user. The user will no longer be able to use the managed Play store on any of their managed devices.</p>
				101	<p class="toc_element">
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	102	<code><a href="#revokeToken">revokeToken(enterpriseId, userId)</a></code></p>
				103	<p class="firstline">Revokes a previously generated token (activation code) for the user.</p>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	104	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	105	<code><a href="#setAvailableProductSet">setAvailableProductSet(enterpriseId, userId, body=None)</a></code></p>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	106	<p class="firstline">Modifies the set of products that a user is entitled to access (referred to as whitelisted products). Only products that are approved or products that were previously approved (products with revoked approval) can be whitelisted.</p>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	107	<p class="toc_element">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	108	<code><a href="#update">update(enterpriseId, userId, body=None)</a></code></p>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	109	<p class="firstline">Updates the details of an EMM-managed user.</p>
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	110	<h3>Method Details</h3>
				111	<div class="method">
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	112	<code class="details" id="delete">delete(enterpriseId, userId)</code>
				113	<pre>Deleted an EMM-managed user.
				114
				115	Args:
				116	enterpriseId: string, The ID of the enterprise. (required)
				117	userId: string, The ID of the user. (required)
				118	</pre>
				119	</div>
				120
				121	<div class="method">
				122	<code class="details" id="generateAuthenticationToken">generateAuthenticationToken(enterpriseId, userId)</code>
				123	<pre>Generates an authentication token which the device policy client can use to provision the given EMM-managed user account on a device. The generated token is single-use and expires after a few minutes.
				124
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	125	You can provision a maximum of 10 devices per user.
				126
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	127	This call only works with EMM-managed accounts.
				128
				129	Args:
				130	enterpriseId: string, The ID of the enterprise. (required)
				131	userId: string, The ID of the user. (required)
				132
				133	Returns:
				134	An object of the form:
				135
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	136	{ # An AuthenticationToken is used by the EMM's device policy client on a device to provision the given EMM-managed user on that device.
				137	"kind": "androidenterprise#authenticationToken",
				138	"token": "A String", # The authentication token to be passed to the device policy client on the device where it can be used to provision the account for which this token was generated.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	139	}</pre>
				140	</div>
				141
				142	<div class="method">
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	143	<code class="details" id="generateToken">generateToken(enterpriseId, userId)</code>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	144	<pre>Generates a token (activation code) to allow this user to configure their managed account in the Android Setup Wizard. Revokes any previously generated token.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	145
Jon Wayne Parrott	36e41bc	2016-02-19 16:02:29 -0800	[diff] [blame]	146	This call only works with Google managed accounts.
				147
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	148	Args:
				149	enterpriseId: string, The ID of the enterprise. (required)
				150	userId: string, The ID of the user. (required)
				151
				152	Returns:
				153	An object of the form:
				154
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	155	{ # A UserToken is used by a user when setting up a managed device or profile with their managed Google Play account on a device. When the user enters their email address and token (activation code) the appropriate EMM app can be automatically downloaded.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	156	"kind": "androidenterprise#userToken",
				157	"token": "A String", # The token (activation code) to be entered by the user. This consists of a sequence of decimal digits. Note that the leading digit may be 0.
				158	"userId": "A String", # The unique ID for the user.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	159	}</pre>
				160	</div>
				161
				162	<div class="method">
				163	<code class="details" id="get">get(enterpriseId, userId)</code>
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	164	<pre>Retrieves a user's details.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	165
				166	Args:
				167	enterpriseId: string, The ID of the enterprise. (required)
				168	userId: string, The ID of the user. (required)
				169
				170	Returns:
				171	An object of the form:
				172
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	173	{ # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to managed Google Play only, or to other Google services, depending on the identity model:
				174	# - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
				175	# - The managed Google Play Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to managed Google Play.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	176	"accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
				177	"accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
				178	"displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
				179	"id": "A String", # The unique ID for the user.
				180	"kind": "androidenterprise#user",
				181	"managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
				182	"primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	183	}</pre>
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	184	</div>
				185
				186	<div class="method">
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	187	<code class="details" id="getAvailableProductSet">getAvailableProductSet(enterpriseId, userId)</code>
				188	<pre>Retrieves the set of products a user is entitled to access.
				189
				190	Args:
				191	enterpriseId: string, The ID of the enterprise. (required)
				192	userId: string, The ID of the user. (required)
				193
				194	Returns:
				195	An object of the form:
				196
				197	{ # A set of products.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	198	"kind": "androidenterprise#productSet",
				199	"productId": [ # The list of product IDs making up the set of products.
				200	"A String",
				201	],
				202	"productSetBehavior": "A String", # The interpretation of this product set. "unknown" should never be sent and is ignored if received. "whitelist" means that the user is entitled to access the product set. "includeAll" means that all products are accessible, including products that are approved, products with revoked approval, and products that have never been approved. "allApproved" means that the user is entitled to access all products that are approved for the enterprise. If the value is "allApproved" or "includeAll", the productId field is ignored. If no value is provided, it is interpreted as "whitelist" for backwards compatibility. Further "allApproved" or "includeAll" does not enable automatic visibility of "alpha" or "beta" tracks for Android app. Use ProductVisibility to enable "alpha" or "beta" tracks per user.
				203	"productVisibility": [ # Additional list of product IDs making up the product set. Unlike the productID array, in this list It's possible to specify which tracks (alpha, beta, production) of a product are visible to the user. See ProductVisibility and its fields for more information. Specifying the same product ID both here and in the productId array is not allowed and it will result in an error.
				204	{ # A product to be made visible to a user.
				205	"productId": "A String", # The product ID to make visible to the user. Required for each item in the productVisibility list.
				206	"trackIds": [ # Grants the user visibility to the specified product track(s), identified by trackIds.
				207	"A String",
				208	],
				209	"tracks": [ # Deprecated. Use trackIds instead.
				210	"A String",
				211	],
				212	},
				213	],
				214	}</pre>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	215	</div>
				216
				217	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	218	<code class="details" id="insert">insert(enterpriseId, body=None)</code>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	219	<pre>Creates a new EMM-managed user.
				220
				221	The Users resource passed in the body of the request should include an accountIdentifier and an accountType.
Sai Cheemalapati	ea3a5e1	2016-10-12 14:05:53 -0700	[diff] [blame]	222	If a corresponding user already exists with the same account identifier, the user will be updated with the resource. In this case only the displayName field can be changed.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	223
				224	Args:
				225	enterpriseId: string, The ID of the enterprise. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	226	body: object, The request body.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	227	The object takes the form of:
				228
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	229	{ # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to managed Google Play only, or to other Google services, depending on the identity model:
				230	# - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
				231	# - The managed Google Play Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to managed Google Play.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	232	"accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
				233	"accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
				234	"displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
				235	"id": "A String", # The unique ID for the user.
				236	"kind": "androidenterprise#user",
				237	"managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
				238	"primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	239	}
				240
				241
				242	Returns:
				243	An object of the form:
				244
				245	{ # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to managed Google Play only, or to other Google services, depending on the identity model:
				246	# - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
				247	# - The managed Google Play Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to managed Google Play.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	248	"accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
				249	"accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
				250	"displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
				251	"id": "A String", # The unique ID for the user.
				252	"kind": "androidenterprise#user",
				253	"managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
				254	"primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	255	}</pre>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	256	</div>
				257
				258	<div class="method">
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	259	<code class="details" id="list">list(enterpriseId, email)</code>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	260	<pre>Looks up a user by primary email address. This is only supported for Google-managed users. Lookup of the id is not needed for EMM-managed users because the id is already returned in the result of the Users.insert call.
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	261
				262	Args:
				263	enterpriseId: string, The ID of the enterprise. (required)
				264	email: string, The exact primary email address of the user to look up. (required)
				265
				266	Returns:
				267	An object of the form:
				268
				269	{ # The matching user resources.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	270	"kind": "androidenterprise#usersListResponse", # Identifies what kind of resource this is. Value: the fixed string "androidenterprise#usersListResponse".
				271	"user": [ # A user of an enterprise.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	272	{ # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to managed Google Play only, or to other Google services, depending on the identity model:
				273	# - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
				274	# - The managed Google Play Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to managed Google Play.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	275	"accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
				276	"accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
				277	"displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
				278	"id": "A String", # The unique ID for the user.
				279	"kind": "androidenterprise#user",
				280	"managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
				281	"primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	282	},
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	283	],
				284	}</pre>
				285	</div>
				286
				287	<div class="method">
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	288	<code class="details" id="revokeDeviceAccess">revokeDeviceAccess(enterpriseId, userId)</code>
				289	<pre>Revokes access to all devices currently provisioned to the user. The user will no longer be able to use the managed Play store on any of their managed devices.
				290
				291	This call only works with EMM-managed accounts.
				292
				293	Args:
				294	enterpriseId: string, The ID of the enterprise. (required)
				295	userId: string, The ID of the user. (required)
				296	</pre>
				297	</div>
				298
				299	<div class="method">
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	300	<code class="details" id="revokeToken">revokeToken(enterpriseId, userId)</code>
				301	<pre>Revokes a previously generated token (activation code) for the user.
				302
				303	Args:
				304	enterpriseId: string, The ID of the enterprise. (required)
				305	userId: string, The ID of the user. (required)
				306	</pre>
				307	</div>
				308
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	309	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	310	<code class="details" id="setAvailableProductSet">setAvailableProductSet(enterpriseId, userId, body=None)</code>
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	311	<pre>Modifies the set of products that a user is entitled to access (referred to as whitelisted products). Only products that are approved or products that were previously approved (products with revoked approval) can be whitelisted.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	312
				313	Args:
				314	enterpriseId: string, The ID of the enterprise. (required)
				315	userId: string, The ID of the user. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	316	body: object, The request body.
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	317	The object takes the form of:
				318
				319	{ # A set of products.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	320	"kind": "androidenterprise#productSet",
				321	"productId": [ # The list of product IDs making up the set of products.
				322	"A String",
				323	],
				324	"productSetBehavior": "A String", # The interpretation of this product set. "unknown" should never be sent and is ignored if received. "whitelist" means that the user is entitled to access the product set. "includeAll" means that all products are accessible, including products that are approved, products with revoked approval, and products that have never been approved. "allApproved" means that the user is entitled to access all products that are approved for the enterprise. If the value is "allApproved" or "includeAll", the productId field is ignored. If no value is provided, it is interpreted as "whitelist" for backwards compatibility. Further "allApproved" or "includeAll" does not enable automatic visibility of "alpha" or "beta" tracks for Android app. Use ProductVisibility to enable "alpha" or "beta" tracks per user.
				325	"productVisibility": [ # Additional list of product IDs making up the product set. Unlike the productID array, in this list It's possible to specify which tracks (alpha, beta, production) of a product are visible to the user. See ProductVisibility and its fields for more information. Specifying the same product ID both here and in the productId array is not allowed and it will result in an error.
				326	{ # A product to be made visible to a user.
				327	"productId": "A String", # The product ID to make visible to the user. Required for each item in the productVisibility list.
				328	"trackIds": [ # Grants the user visibility to the specified product track(s), identified by trackIds.
				329	"A String",
				330	],
				331	"tracks": [ # Deprecated. Use trackIds instead.
				332	"A String",
				333	],
				334	},
				335	],
				336	}
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	337
				338
				339	Returns:
				340	An object of the form:
				341
				342	{ # A set of products.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	343	"kind": "androidenterprise#productSet",
				344	"productId": [ # The list of product IDs making up the set of products.
				345	"A String",
				346	],
				347	"productSetBehavior": "A String", # The interpretation of this product set. "unknown" should never be sent and is ignored if received. "whitelist" means that the user is entitled to access the product set. "includeAll" means that all products are accessible, including products that are approved, products with revoked approval, and products that have never been approved. "allApproved" means that the user is entitled to access all products that are approved for the enterprise. If the value is "allApproved" or "includeAll", the productId field is ignored. If no value is provided, it is interpreted as "whitelist" for backwards compatibility. Further "allApproved" or "includeAll" does not enable automatic visibility of "alpha" or "beta" tracks for Android app. Use ProductVisibility to enable "alpha" or "beta" tracks per user.
				348	"productVisibility": [ # Additional list of product IDs making up the product set. Unlike the productID array, in this list It's possible to specify which tracks (alpha, beta, production) of a product are visible to the user. See ProductVisibility and its fields for more information. Specifying the same product ID both here and in the productId array is not allowed and it will result in an error.
				349	{ # A product to be made visible to a user.
				350	"productId": "A String", # The product ID to make visible to the user. Required for each item in the productVisibility list.
				351	"trackIds": [ # Grants the user visibility to the specified product track(s), identified by trackIds.
				352	"A String",
				353	],
				354	"tracks": [ # Deprecated. Use trackIds instead.
				355	"A String",
				356	],
				357	},
				358	],
				359	}</pre>
Takashi Matsuo	0669410	2015-09-11 13:55:40 -0700	[diff] [blame]	360	</div>
				361
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	362	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	363	<code class="details" id="update">update(enterpriseId, userId, body=None)</code>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	364	<pre>Updates the details of an EMM-managed user.
				365
				366	Can be used with EMM-managed users only (not Google managed users). Pass the new details in the Users resource in the request body. Only the displayName field can be changed. Other fields must either be unset or have the currently active value.
				367
				368	Args:
				369	enterpriseId: string, The ID of the enterprise. (required)
				370	userId: string, The ID of the user. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	371	body: object, The request body.
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	372	The object takes the form of:
				373
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	374	{ # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to managed Google Play only, or to other Google services, depending on the identity model:
				375	# - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
				376	# - The managed Google Play Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to managed Google Play.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	377	"accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
				378	"accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
				379	"displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
				380	"id": "A String", # The unique ID for the user.
				381	"kind": "androidenterprise#user",
				382	"managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
				383	"primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	384	}
				385
				386
				387	Returns:
				388	An object of the form:
				389
				390	{ # A Users resource represents an account associated with an enterprise. The account may be specific to a device or to an individual user (who can then use the account across multiple devices). The account may provide access to managed Google Play only, or to other Google services, depending on the identity model:
				391	# - The Google managed domain identity model requires synchronization to Google account sources (via primaryEmail).
				392	# - The managed Google Play Accounts identity model provides a dynamic means for enterprises to create user or device accounts as needed. These accounts provide access to managed Google Play.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	393	"accountIdentifier": "A String", # A unique identifier you create for this user, such as "user342" or "asset#44418". Do not use personally identifiable information (PII) for this property. Must always be set for EMM-managed users. Not set for Google-managed users.
				394	"accountType": "A String", # The type of account that this user represents. A userAccount can be installed on multiple devices, but a deviceAccount is specific to a single device. An EMM-managed user (emmManaged) can be either type (userAccount, deviceAccount), but a Google-managed user (googleManaged) is always a userAccount.
				395	"displayName": "A String", # The name that will appear in user interfaces. Setting this property is optional when creating EMM-managed users. If you do set this property, use something generic about the organization (such as "Example, Inc.") or your name (as EMM). Not used for Google-managed user accounts.
				396	"id": "A String", # The unique ID for the user.
				397	"kind": "androidenterprise#user",
				398	"managementType": "A String", # The entity that manages the user. With googleManaged users, the source of truth is Google so EMMs have to make sure a Google Account exists for the user. With emmManaged users, the EMM is in charge.
				399	"primaryEmail": "A String", # The user's primary email address, for example, "jsmith@example.com". Will always be set for Google managed users and not set for EMM managed users.
Sai Cheemalapati	c30d2b5	2017-03-13 12:12:03 -0400	[diff] [blame]	400	}</pre>
Jon Wayne Parrott	7d5badb	2016-08-16 12:44:29 -0700	[diff] [blame]	401	</div>
				402
Nathaniel Manista	5cbe5ba	2015-03-10 23:29:22 +0000	[diff] [blame]	403	</body></html>