Organizations - List

Service:

IoT Central

API Version:

2022-07-31

取得使用者在應用程式中可存取的組織清單

GET https://{subdomain}.{baseDomain}/api/organizations?api-version=2022-07-31

URI 參數

名稱	位於	必要	類型	Description
baseDomain	path	True	string	所有 Azure IoT Central 服務要求的基底網域。
subdomain	path	True	string	應用程式子域。
api-version	query	True	string	所呼叫 API 的版本。

回應

名稱	類型	Description
200 OK	OrganizationCollection	Success
Other Status Codes	Error	從 IoT Central 服務收到的錯誤回應。 Headers x-ms-error-code: string

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

List organizations

Sample Request

HTTP

GET https://appsubdomain.azureiotcentral.com/api/organizations?api-version=2022-07-31

Sample Response

Status code:

200

{
  "value": [
    {
      "id": "us",
      "displayName": "United States"
    },
    {
      "id": "washington",
      "displayName": "Washington",
      "parent": "us"
    },
    {
      "id": "seattle",
      "displayName": "Seattle",
      "parent": "washington"
    }
  ]
}

定義

名稱	Description
Error	回應錯誤定義。
ErrorDetails	錯誤的詳細資訊。
Organization	組織定義。
OrganizationCollection	組織的分頁結果。

Error

回應錯誤定義。

名稱	類型	Description
error	ErrorDetails	目前要求的錯誤詳細數據。

ErrorDetails

錯誤的詳細資訊。

名稱	類型	Description
code	string	錯誤碼。
message	string	錯誤訊息詳細數據。
requestId	string	目前要求的相互關聯標識碼。
time	string	錯誤要求失敗的時間。

Organization

組織定義。

名稱	類型	Description
displayName	string	組織的顯示名稱。
id	string	組織的唯一標識碼。
parent	string	組織的父代標識碼。

OrganizationCollection

組織的分頁結果。

名稱	類型	Description
nextLink	string	取得組織下一頁的 URL。
value	Organization[]	組織的集合。