List
|
|||||
|
|
||||
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
Input
This building block consumes 3 input parameters
| Name | Format | Description |
|---|---|---|
partnerId Required |
INTEGER |
Required. The ID of the reseller partner |
pageToken |
STRING |
A token identifying a page of results returned by the server |
pageSize |
INTEGER |
The maximum number of results to be returned. If not specified or 0, all the records are returned |
= Parameter name
= Format
|
partnerId INTEGER Required Required. The ID of the reseller partner |
|
pageToken STRING A token identifying a page of results returned by the server |
|
pageSize INTEGER The maximum number of results to be returned. If not specified or 0, all the records are returned |
Output
This building block provides 9 output parameters
| Name | Format | Description |
|---|---|---|
customers[] |
OBJECT |
A reseller, vendor, or customer in the zero-touch reseller and customer APIs |
customers[].name |
STRING |
Output only. The API resource name of the company. The resource name is one of the following formats:
Assigned by the server |
customers[].adminEmails[] |
STRING |
|
customers[].termsStatus |
ENUMERATION |
Output only. Whether any user from the company has accepted the latest Terms of Service (ToS). See TermsStatus |
customers[].ownerEmails[] |
STRING |
|
customers[].companyName |
STRING |
Required. The name of the company. For example XYZ Corp. Displayed to the company's employees in the zero-touch enrollment portal |
customers[].companyId |
INTEGER |
Output only. The ID of the company. Assigned by the server |
nextPageToken |
STRING |
A token to retrieve the next page of results. Omitted if no further results are available |
totalSize |
INTEGER |
The total count of items in the list irrespective of pagination |
= Parameter name
= Format
|
customers[] OBJECT A reseller, vendor, or customer in the zero-touch reseller and customer APIs |
|
customers[].name STRING Output only. The API resource name of the company. The resource name is one of the following formats:
Assigned by the server |
|
customers[].adminEmails[] STRING |
|
customers[].termsStatus ENUMERATION Output only. Whether any user from the company has accepted the latest Terms of Service (ToS). See TermsStatus |
|
customers[].ownerEmails[] STRING |
|
customers[].companyName STRING Required. The name of the company. For example XYZ Corp. Displayed to the company's employees in the zero-touch enrollment portal |
|
customers[].companyId INTEGER Output only. The ID of the company. Assigned by the server |
|
nextPageToken STRING A token to retrieve the next page of results. Omitted if no further results are available |
|
totalSize INTEGER The total count of items in the list irrespective of pagination |