Method: enterprises.structures.get
Stay organized with collections
Save and categorize content based on your preferences.
Gets a structure managed by the enterprise.
HTTP request
GET https://smartdevicemanagement.googleapis.com/v1/{name=enterprises/*/structures/*}
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
name |
string
The name of the structure requested. For example: "enterprises/XYZ/structures/ABC".
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Structure
.
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\u003eRetrieves a specific structure within a given enterprise using its unique name.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003esdm.service\u003c/code\u003e scope for accessing the Smart Device Management API.\u003c/p\u003e\n"],["\u003cp\u003eUses a \u003ccode\u003eGET\u003c/code\u003e request with the structure's name as a path parameter and an empty request body.\u003c/p\u003e\n"],["\u003cp\u003eReturns a \u003ccode\u003eStructure\u003c/code\u003e object containing information about the requested structure upon successful execution.\u003c/p\u003e\n"]]],["This document details retrieving a managed structure via an HTTP GET request. The request URL, using gRPC Transcoding, specifies the structure's name via the `name` path parameter (e.g., \"enterprises/XYZ/structures/ABC\"). The request body must be empty. A successful request returns a `Structure` instance in the response body. The operation requires the `https://www.googleapis.com/auth/sdm.service` OAuth scope for authorization. Examples are available within the document.\n"],null,["# Method: enterprises.structures.get\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Examples](#examples)\n\nGets a structure managed by the enterprise.\n\n### HTTP request\n\n`GET https://smartdevicemanagement.googleapis.com/v1/{name=enterprises/*/structures/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|----------------------------------------------------------------------------------------------|\n| `name` | `string` The name of the structure requested. For example: \"enterprises/XYZ/structures/ABC\". |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [Structure](/nest/device-access/reference/rest/v1/enterprises.structures#Structure).\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)."]]