Api Tokens - Create

服務:

IoT Central

API 版本:

2022-07-31

在應用程式中建立新的 API 令牌，以在 IoT Central 公用 API 中使用。 令牌值將會在回應中傳回，且不會在後續要求中再次傳回。

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

URI 參數

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

要求本文

名稱	必要	類型	Description
roles	True	RoleAssignment[]	指定存取應用程式許可權的角色指派清單。
expiry		string	字串格式的日期，表示令牌到期的時間。

回應

名稱	類型	Description
200 OK	ApiToken	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	模擬您的用戶帳戶

範例

Create API token

範例要求

HTTP

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

{
  "roles": [
    {
      "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4"
    },
    {
      "role": "c495eb57-eb18-489e-9802-62c474e5645c",
      "organization": "seattle"
    }
  ]
}

範例回覆

狀態碼:

200

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

定義

名稱	Description
ApiToken	API 存取令牌定義。
Error	回應錯誤定義。
ErrorDetails	錯誤的詳細資訊。
RoleAssignment	角色指派定義。

ApiToken

API 存取令牌定義。

名稱	類型	Description
expiry	string	字串格式的日期，表示令牌到期的時間。
id	string	API 令牌的唯一標識碼。
roles	RoleAssignment[]	指定存取應用程式許可權的角色指派清單。
token	string	API 令牌的值。

Error

回應錯誤定義。

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

ErrorDetails

錯誤的詳細資訊。

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

RoleAssignment

角色指派定義。

名稱	類型	Description
organization	string	此角色指派的組織標識碼。
role	string	此角色指派的角色標識碼。