Organizations - List
アプリケーションでユーザーがアクセスできる組織の一覧を取得する
GET https://{subdomain}.{baseDomain}/api/organizations?api-version=2022-07-31
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
base
|
path | True |
string |
すべての Azure IoT Central サービス要求のベース ドメイン。 |
subdomain
|
path | True |
string |
アプリケーション サブドメイン。 |
api-version
|
query | True |
string |
呼び出される API のバージョン。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
Success |
|
Other Status Codes |
IoT Central サービスから受信したエラー応答。 ヘッダー x-ms-error-code: string |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
List organizations
要求のサンプル
GET https://appsubdomain.azureiotcentral.com/api/organizations?api-version=2022-07-31
応答のサンプル
{
"value": [
{
"id": "us",
"displayName": "United States"
},
{
"id": "washington",
"displayName": "Washington",
"parent": "us"
},
{
"id": "seattle",
"displayName": "Seattle",
"parent": "washington"
}
]
}
定義
名前 | 説明 |
---|---|
Error |
応答エラーの定義。 |
Error |
エラーの詳細情報。 |
Organization |
organization定義。 |
Organization |
組織のページングされた結果。 |
Error
応答エラーの定義。
名前 | 型 | 説明 |
---|---|---|
error |
現在の要求のエラーの詳細。 |
ErrorDetails
エラーの詳細情報。
名前 | 型 | 説明 |
---|---|---|
code |
string |
エラー コード。 |
message |
string |
エラー メッセージの詳細。 |
requestId |
string |
現在の要求の関連付け ID。 |
time |
string |
エラー要求が失敗した時刻。 |
Organization
organization定義。
名前 | 型 | 説明 |
---|---|---|
displayName |
string |
organizationの表示名。 |
id |
string |
organizationの一意の ID。 |
parent |
string |
organizationの親の ID。 |
OrganizationCollection
組織のページングされた結果。
名前 | 型 | 説明 |
---|---|---|
nextLink |
string |
組織の次のページを取得する URL。 |
value |
組織のコレクション。 |