Method: partners.devices.findByIdentifier
Stay organized with collections
Save and categorize content based on your preferences.
Finds devices by hardware identifiers, such as IMEI.
HTTP request
POST https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:findByIdentifier
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,
"deviceIdentifier": {
object (DeviceIdentifier)
}
} |
| 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.
|
deviceIdentifier |
object (DeviceIdentifier)
Required. Required. The device identifier 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)
Found 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 allows searching for devices by hardware identifiers like IMEI using a POST request.\u003c/p\u003e\n"],["\u003cp\u003eThe request URL follows gRPC Transcoding syntax and requires the \u003ccode\u003epartnerId\u003c/code\u003e as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must include \u003ccode\u003epageToken\u003c/code\u003e, \u003ccode\u003elimit\u003c/code\u003e, and \u003ccode\u003edeviceIdentifier\u003c/code\u003e to specify the search criteria and results page size.\u003c/p\u003e\n"],["\u003cp\u003eThe response body includes a list of \u003ccode\u003edevices\u003c/code\u003e, along with \u003ccode\u003enextPageToken\u003c/code\u003e for pagination and \u003ccode\u003etotalSize\u003c/code\u003e for the total device count.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization for this API requires the OAuth scope \u003ccode\u003ehttps://www.googleapis.com/auth/androidworkprovisioning\u003c/code\u003e.\u003c/p\u003e\n"]]],["This content describes how to find devices by hardware identifiers using a POST request to `https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:findByIdentifier`. The request requires a `partnerId` path parameter. The request body must include `pageToken`, `limit` (1-100), and `deviceIdentifier`. The response body includes an array of `devices`, `nextPageToken` for pagination, and `totalSize`. This operation requires the `https://www.googleapis.com/auth/androidworkprovisioning` OAuth scope.\n"],null,["# Method: partners.devices.findByIdentifier\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.FindDevicesByDeviceIdentifierResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n\nFinds devices by hardware identifiers, such as IMEI.\n\n### HTTP request\n\n`POST https://androiddeviceprovisioning.googleapis.com/v1/partners/{partnerId}/devices:findByIdentifier`\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, \"deviceIdentifier\": { object (/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceIdentifier) } } ``` |\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| `deviceIdentifier` | `object (`[DeviceIdentifier](/zero-touch/reference/reseller/rest/v1/partners.devices#DeviceIdentifier)`)` Required. Required. The device identifier 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)`)` Found 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)."]]