共用方式為


Api Tokens - List

取得應用程式中的 API 權杖清單。 基於安全性考慮,令牌值永遠不會傳回。

GET https://{subdomain}.{baseDomain}/api/apiTokens?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

ApiTokenCollection

Success

Other Status Codes

Error

從 IoT Central 服務收到的錯誤回應。

標題

x-ms-error-code: string

安全性

azure_auth

Azure Active Directory OAuth2 Flow

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

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

範例

List API tokens

範例要求

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

範例回覆

{
  "value": [
    {
      "id": "testtoken",
      "roles": [
        {
          "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
        },
        {
          "role": "c495eb57-eb18-489e-9802-62c474e5645c",
          "organization": "seattle"
        }
      ],
      "expiry": "2020-10-18T18:30:40.227Z"
    }
  ]
}

定義

名稱 Description
ApiToken

API 存取令牌定義。

ApiTokenCollection

API 令牌的分頁結果。

Error

回應錯誤定義。

ErrorDetails

錯誤的詳細資訊。

RoleAssignment

角色指派定義。

ApiToken

API 存取令牌定義。

名稱 類型 Description
expiry

string

字串格式的日期,表示令牌到期的時間。

id

string

API 令牌的唯一標識碼。

roles

RoleAssignment[]

指定存取應用程式許可權的角色指派清單。

token

string

API 令牌的值。

ApiTokenCollection

API 令牌的分頁結果。

名稱 類型 Description
nextLink

string

取得 API 令牌下一頁的 URL。

value

ApiToken[]

API 令牌的集合。

Error

回應錯誤定義。

名稱 類型 Description
error

ErrorDetails

目前要求的錯誤詳細數據。

ErrorDetails

錯誤的詳細資訊。

名稱 類型 Description
code

string

錯誤碼。

message

string

錯誤訊息詳細數據。

requestId

string

目前要求的相互關聯標識碼。

time

string

錯誤要求失敗的時間。

RoleAssignment

角色指派定義。

名稱 類型 Description
organization

string

此角色指派的組織標識碼。

role

string

此角色指派的角色標識碼。