Method: enterprises.structures.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists structures managed by the enterprise.
HTTP request
GET https://smartdevicemanagement.googleapis.com/v1/{parent=enterprises/*}/structures
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
The parent enterprise to list structures under. E.g. "enterprises/XYZ".
|
Query parameters
| Parameters |
filter |
string
Optional filter to list structures.
|
Request body
The request body must be empty.
Response body
Response message for SmartDeviceManagementService.ListStructures
If successful, the response body contains data with the following structure:
| JSON representation |
{
"structures": [
{
object (Structure)
}
]
} |
| Fields |
structures[] |
object (Structure)
The list of structures.
|
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 device access structures managed by an enterprise using the provided endpoint.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering structures via an optional query parameter.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization using the \u003ccode\u003ehttps://www.googleapis.com/auth/sdm.service\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eReturns a list of structures if successful, formatted as outlined in the response body section.\u003c/p\u003e\n"]]],["This document details retrieving a list of enterprise-managed structures. It uses a `GET` request to a specific URL: `https://smartdevicemanagement.googleapis.com/v1/{parent=enterprises/*}/structures`. The `parent` path parameter specifies the enterprise. An optional `filter` query parameter refines the structure list. The request body is empty. The successful response includes a list of `structures` in JSON format. This action requires the `https://www.googleapis.com/auth/sdm.service` authorization scope.\n"],null,["# Method: enterprises.structures.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.ListStructuresResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Examples](#examples)\n\nLists structures managed by the enterprise.\n\n### HTTP request\n\n`GET https://smartdevicemanagement.googleapis.com/v1/{parent=enterprises/*}/structures`\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 structures under. E.g. \"enterprises/XYZ\". |\n\n### Query parameters\n\n| Parameters ||\n|----------|----------------------------------------------|\n| `filter` | `string` Optional filter to list structures. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for SmartDeviceManagementService.ListStructures\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------|\n| ``` { \"structures\": [ { object (/nest/device-access/reference/rest/v1/enterprises.structures#Structure) } ] } ``` |\n\n| Fields ||\n|----------------|--------------------------------------------------------------------------------------------------------------------------|\n| `structures[]` | `object (`[Structure](/nest/device-access/reference/rest/v1/enterprises.structures#Structure)`)` The list of structures. |\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)."]]
