Blame - docs/dyn/androiddeviceprovisioning_v1.partners.customers.html - platform/external/python/google-api-python-client

blob: 89d4f276916051d13f3c6e9f85ee1c54d9d76deb [file] [log] [blame]

Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -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="androiddeviceprovisioning_v1.html">Android Device Provisioning Partner API</a> . <a href="androiddeviceprovisioning_v1.partners.html">partners</a> . <a href="androiddeviceprovisioning_v1.partners.customers.html">customers</a></h1>
				76	<h2>Instance Methods</h2>
				77	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	78	<code><a href="#close">close()</a></code></p>
				79	<p class="firstline">Close httplib2 connections.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	80	<p class="toc_element">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	81	<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
				82	<p class="firstline">Creates a customer for zero-touch enrollment. After the method returns successfully, admin and owner roles can manage devices and EMM configs by calling API methods or using their zero-touch enrollment portal. The customer receives an email that welcomes them to zero-touch enrollment and explains how to sign into the portal.</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(partnerId, pageToken=None, pageSize=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 customers that are enrolled to the reseller identified by the `partnerId` argument. This list includes customers that the reseller created and customers that enrolled themselves using the portal.</p>
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	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	<h3>Method Details</h3>
				90	<div class="method">
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	91	<code class="details" id="close">close()</code>
				92	<pre>Close httplib2 connections.</pre>
				93	</div>
				94
				95	<div class="method">
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	96	<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	97	<pre>Creates a customer for zero-touch enrollment. After the method returns successfully, admin and owner roles can manage devices and EMM configs by calling API methods or using their zero-touch enrollment portal. The customer receives an email that welcomes them to zero-touch enrollment and explains how to sign into the portal.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	98
				99	Args:
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	100	parent: string, Required. The parent resource ID in the format `partners/[PARTNER_ID]` that identifies the reseller. (required)
Dan O'Meara	dd49464	2020-05-01 07:42:23 -0700	[diff] [blame]	101	body: object, The request body.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	102	The object takes the form of:
				103
				104	{ # Request message to create a customer.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	105	"customer": { # A reseller, vendor, or customer in the zero-touch reseller and customer APIs. # Required. The company data to populate the new customer. Must contain a value for `companyName` and at least one `owner_email` that's associated with a Google Account. The values for `companyId` and `name` must be empty.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	106	"companyId": "A String", # Output only. The ID of the company. Assigned by the server.
				107	"termsStatus": "A String", # Output only. Whether any user from the company has accepted the latest Terms of Service (ToS). See TermsStatus.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	108	"adminEmails": [ # Optional. Email address of customer's users in the admin role. Each email address must be associated with a Google Account.
				109	"A String",
				110	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	111	"ownerEmails": [ # Required. Input only. Email address of customer's users in the owner role. At least one `owner_email` is required. Each email address must be associated with a Google Account. Owners share the same access as admins but can also add, delete, and edit your organization's portal users.
				112	"A String",
				113	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	114	"name": "A String", # Output only. The API resource name of the company. The resource name is one of the following formats: * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned by the server.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	115	"companyName": "A String", # Required. The name of the company. For example _XYZ Corp_. Displayed to the company's employees in the zero-touch enrollment portal.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	116	},
				117	}
				118
				119	x__xgafv: string, V1 error format.
				120	Allowed values
				121	1 - v1 error format
				122	2 - v2 error format
				123
				124	Returns:
				125	An object of the form:
				126
				127	{ # A reseller, vendor, or customer in the zero-touch reseller and customer APIs.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	128	"companyId": "A String", # Output only. The ID of the company. Assigned by the server.
				129	"termsStatus": "A String", # Output only. Whether any user from the company has accepted the latest Terms of Service (ToS). See TermsStatus.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	130	"adminEmails": [ # Optional. Email address of customer's users in the admin role. Each email address must be associated with a Google Account.
				131	"A String",
				132	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	133	"ownerEmails": [ # Required. Input only. Email address of customer's users in the owner role. At least one `owner_email` is required. Each email address must be associated with a Google Account. Owners share the same access as admins but can also add, delete, and edit your organization's portal users.
				134	"A String",
				135	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	136	"name": "A String", # Output only. The API resource name of the company. The resource name is one of the following formats: * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned by the server.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	137	"companyName": "A String", # Required. The name of the company. For example _XYZ Corp_. Displayed to the company's employees in the zero-touch enrollment portal.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	138	}</pre>
				139	</div>
				140
				141	<div class="method">
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	142	<code class="details" id="list">list(partnerId, pageToken=None, pageSize=None, x__xgafv=None)</code>
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	143	<pre>Lists the customers that are enrolled to the reseller identified by the `partnerId` argument. This list includes customers that the reseller created and customers that enrolled themselves using the portal.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	144
				145	Args:
				146	partnerId: string, Required. The ID of the reseller partner. (required)
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	147	pageToken: string, A token identifying a page of results returned by the server.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	148	pageSize: integer, The maximum number of results to be returned. If not specified or 0, all the records are returned.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	149	x__xgafv: string, V1 error format.
				150	Allowed values
				151	1 - v1 error format
				152	2 - v2 error format
				153
				154	Returns:
				155	An object of the form:
				156
				157	{ # Response message of all customers related to this partner.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	158	"totalSize": 42, # The total count of items in the list irrespective of pagination.
				159	"nextPageToken": "A String", # A token to retrieve the next page of results. Omitted if no further results are available.
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	160	"customers": [ # List of customers related to this reseller partner.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	161	{ # A reseller, vendor, or customer in the zero-touch reseller and customer APIs.
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	162	"companyId": "A String", # Output only. The ID of the company. Assigned by the server.
				163	"termsStatus": "A String", # Output only. Whether any user from the company has accepted the latest Terms of Service (ToS). See TermsStatus.
Dmitry Frenkel	3e17f89	2020-10-06 16:46:05 -0700	[diff] [blame]	164	"adminEmails": [ # Optional. Email address of customer's users in the admin role. Each email address must be associated with a Google Account.
				165	"A String",
				166	],
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	167	"ownerEmails": [ # Required. Input only. Email address of customer's users in the owner role. At least one `owner_email` is required. Each email address must be associated with a Google Account. Owners share the same access as admins but can also add, delete, and edit your organization's portal users.
				168	"A String",
				169	],
Yoshi Automation Bot	c2228be	2020-11-24 15:48:03 -0800	[diff] [blame^]	170	"name": "A String", # Output only. The API resource name of the company. The resource name is one of the following formats: * `partners/[PARTNER_ID]/customers/[CUSTOMER_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]` * `partners/[PARTNER_ID]/vendors/[VENDOR_ID]/customers/[CUSTOMER_ID]` Assigned by the server.
Bu Sun Kim	673ec5c	2020-11-16 11:05:03 -0700	[diff] [blame]	171	"companyName": "A String", # Required. The name of the company. For example _XYZ Corp_. Displayed to the company's employees in the zero-touch enrollment portal.
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	172	},
				173	],
				174	}</pre>
				175	</div>
				176
				177	<div class="method">
				178	<code class="details" id="list_next">list_next(previous_request, previous_response)</code>
				179	<pre>Retrieves the next page of results.
				180
				181	Args:
				182	previous_request: The request for the previous page. (required)
				183	previous_response: The response from the request for the previous page. (required)
				184
				185	Returns:
Bu Sun Kim	6502091	2020-05-20 12:08:20 -0700	[diff] [blame]	186	A request object that you can call 'execute()' on to request the next
Bu Sun Kim	715bd7f	2019-06-14 16:50:42 -0700	[diff] [blame]	187	page. Returns None if there are no more items in the collection.
				188	</pre>
				189	</div>
				190
				191	</body></html>