List
|
|||||
|
|
||||
Lists the customers of the vendor
Input
This building block consumes 3 input parameters
| Name | Format | Description |
|---|---|---|
parent Required |
STRING |
Required. The resource name in the format
|
pageToken |
STRING |
A token identifying a page of results returned by the server |
pageSize |
INTEGER |
The maximum number of results to be returned |
= Parameter name
= Format
|
parent STRING Required Required. The resource name in the format
|
|
pageToken STRING A token identifying a page of results returned by the server |
|
pageSize INTEGER The maximum number of results to be returned |
Output
This building block provides 9 output parameters
| Name | Format | Description |
|---|---|---|
totalSize |
INTEGER |
The total count of items in the list irrespective of pagination |
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 |
= Parameter name
= Format
|
totalSize INTEGER The total count of items in the list irrespective of pagination |
|
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 |