Api Tokens - Get

サービス:

IoT Central

API バージョン:

2022-07-31

ID で API トークンを取得する。

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

URI パラメーター

名前	/	必須	型	説明
baseDomain	path	True	string	すべての Azure IoT Central サービス要求のベース ドメイン。
subdomain	path	True	string	アプリケーション サブドメイン。
tokenId	path	True	string	API トークンの一意の ID。
api-version	query	True	string	呼び出される API のバージョン。

応答

名前	型	説明
200 OK	ApiToken	Success
Other Status Codes	Error	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	ユーザー アカウントの借用

例

Get API token by ID

要求のサンプル

HTTP

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

応答のサンプル

状態コード:

200

{
  "id": "testtoken",
  "roles": [
    {
      "role": "c495eb57-eb18-489e-9802-62c474e5645c",
      "organization": "seattle"
    }
  ],
  "expiry": "2020-10-18T18:30:40.227Z"
}

定義

名前	説明
ApiToken	API アクセス トークンの定義。
Error	応答エラーの定義。
ErrorDetails	エラーの詳細情報。
RoleAssignment	ロールの割り当ての定義。

ApiToken

API アクセス トークンの定義。

名前	型	説明
expiry	string	トークンの有効期限が切れる時刻を表す文字列形式の日付。
id	string	API トークンの一意の ID。
roles	RoleAssignment[]	アプリケーションにアクセスするためのアクセス許可を指定するロールの割り当ての一覧。
token	string	API トークンの値。

Error

応答エラーの定義。

名前	型	説明
error	ErrorDetails	現在の要求のエラーの詳細。

ErrorDetails

エラーの詳細情報。

名前	型	説明
code	string	エラー コード。
message	string	エラー メッセージの詳細。
requestId	string	現在の要求の関連付け ID。
time	string	エラー要求が失敗した時刻。

RoleAssignment

ロールの割り当ての定義。

名前	型	説明
organization	string	このロールの割り当てのorganizationの ID。
role	string	このロールの割り当てのロールの ID。