Method: partners.devices.findByOwner
Stay organized with collections
Save and categorize content based on your preferences.
Finds devices claimed for customers. The results only contain devices registered to the reseller that's identified by the partnerId argument. The customer's devices purchased from other resellers don't appear in the results.
HTTP request
POST https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:findByOwner
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
partnerId |
string (int64 format)
Required. The ID of the reseller partner.
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"pageToken": string,
"limit": string,
"sectionType": enum (DeviceProvisioningSectionType),
"customerId": [
string
],
"googleWorkspaceCustomerId": [
string
]
} |
| Fields |
pageToken |
string
A token specifying which result page to return.
|
limit |
string (int64 format)
Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive.
|
sectionType |
enum (DeviceProvisioningSectionType)
Required. The section type of the device's provisioning record.
|
customerId[] |
string (int64 format)
The list of customer IDs to search for.
|
googleWorkspaceCustomerId[] |
string
The list of IDs of Google Workspace accounts to search for.
|
Response body
If successful, the response body contains data with the following structure:
Response containing found devices.
| JSON representation |
{
"devices": [
{
object (Device)
}
],
"nextPageToken": string,
"totalSize": integer
} |
| Fields |
devices[] |
object (Device)
The customer's devices.
|
nextPageToken |
string
A token used to access 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.
|
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/androidworkprovisioning
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-07 UTC.
[null,null,["Last updated 2024-08-07 UTC."],[[["\u003cp\u003eThis API endpoint finds devices claimed by customers, specifically those registered to the reseller identified by the \u003ccode\u003epartnerId\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe HTTP request is a \u003ccode\u003ePOST\u003c/code\u003e method to \u003ccode\u003ehttps://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:findByOwner\u003c/code\u003e, utilizing gRPC Transcoding syntax.\u003c/p\u003e\n"],["\u003cp\u003eThe request body requires parameters such as \u003ccode\u003elimit\u003c/code\u003e, and \u003ccode\u003esectionType\u003c/code\u003e, and includes optional fields for filtering by \u003ccode\u003ecustomerId\u003c/code\u003e and \u003ccode\u003egoogleWorkspaceCustomerId\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe response body returns a list of \u003ccode\u003edevices\u003c/code\u003e, and information about pagination through \u003ccode\u003enextPageToken\u003c/code\u003e, along with the \u003ccode\u003etotalSize\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this API requires the \u003ccode\u003ehttps://www.googleapis.com/auth/androidworkprovisioning\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],["This describes an API endpoint to find devices claimed by customers, specifically those registered to a given reseller. The API uses a `POST` request to `https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:findByOwner`, with `partnerId` specifying the reseller. The request body requires a page limit, section type, and optional customer IDs and/or google workspace id to search by. The response contains a list of devices, a next page token if more results are available, and total size. OAuth scope `https://www.googleapis.com/auth/androidworkprovisioning` is needed.\n"],null,["# Method: partners.devices.findByOwner\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n - [JSON representation](#body.FindDevicesByOwnerResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n\nFinds devices claimed for customers. The results only contain devices registered to the reseller that's identified by the `partnerId` argument. The customer's devices purchased from other resellers don't appear in the results.\n\n### HTTP request\n\n`POST https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:findByOwner`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------|\n| `partnerId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The ID of the reseller partner. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"pageToken\": string, \"limit\": string, \"sectionType\": enum (/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceProvisioningSectionType), \"customerId\": [ string ], \"googleWorkspaceCustomerId\": [ string ] } ``` |\n\n| Fields ||\n|-------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageToken` | `string` A token specifying which result page to return. |\n| `limit` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The maximum number of devices to show in a page of results. Must be between 1 and 100 inclusive. |\n| `sectionType` | `enum (`[DeviceProvisioningSectionType](/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceProvisioningSectionType)`)` Required. The section type of the device's provisioning record. |\n| `customerId[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` The list of customer IDs to search for. |\n| `googleWorkspaceCustomerId[]` | `string` The list of IDs of Google Workspace accounts to search for. |\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nResponse containing found devices.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"devices\": [ { object (/zero-touch/reference/reseller/rest/v1/partners.devices#Device) } ], \"nextPageToken\": string, \"totalSize\": integer } ``` |\n\n| Fields ||\n|-----------------|---------------------------------------------------------------------------------------------------------------|\n| `devices[]` | `object (`[Device](/zero-touch/reference/reseller/rest/v1/partners.devices#Device)`)` The customer's devices. |\n| `nextPageToken` | `string` A token used to access the next page of results. Omitted if no further results are available. |\n| `totalSize` | `integer` The total count of items in the list irrespective of pagination. |\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/androidworkprovisioning`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]