Method: enterprises.devices.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists devices managed by the enterprise.
HTTP request
GET https://smartdevicemanagement.googleapis.com/v1/{parent=enterprises/*}/devices
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
The parent enterprise to list devices under. E.g. "enterprises/XYZ".
|
Query parameters
| Parameters |
filter |
string
Optional filter to list devices. Filters can be done on: Device custom name (substring match): 'customName=wing'
|
Request body
The request body must be empty.
Response body
Response message for SmartDeviceManagementService.ListDevices
If successful, the response body contains data with the following structure:
| JSON representation |
{
"devices": [
{
object (Device)
}
]
} |
| Fields |
devices[] |
object (Device)
The list of devices.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/sdm.service
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\u003eLists all devices managed by a given enterprise, allowing for filtering by device custom name.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/sdm.service\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eUses a \u003ccode\u003eGET\u003c/code\u003e request to the specified endpoint with the enterprise ID as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eThe response provides a list of devices in JSON format, including details for each device.\u003c/p\u003e\n"],["\u003cp\u003eThe request body should be empty, while query parameters can be used to specify filters.\u003c/p\u003e\n"]]],[],null,["# Method: enterprises.devices.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListDevicesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Examples](#examples)\n\nLists devices managed by the enterprise.\n\n### HTTP request\n\n`GET https://smartdevicemanagement.googleapis.com/v1/{parent=enterprises/*}/devices`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-------------------------------------------------------------------------------|\n| `parent` | `string` The parent enterprise to list devices under. E.g. \"enterprises/XYZ\". |\n\n### Query parameters\n\n| Parameters ||\n|----------|---------------------------------------------------------------------------------------------------------------------------|\n| `filter` | `string` Optional filter to list devices. Filters can be done on: Device custom name (substring match): 'customName=wing' |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for SmartDeviceManagementService.ListDevices\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------|\n| ``` { \"devices\": [ { object (/nest/device-access/reference/rest/v1/enterprises.devices#Device) } ] } ``` |\n\n| Fields ||\n|-------------|--------------------------------------------------------------------------------------------------------------|\n| `devices[]` | `object (`[Device](/nest/device-access/reference/rest/v1/enterprises.devices#Device)`)` The list of devices. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/sdm.service`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]
