你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 参数

名称	在	必需	类型	说明
baseDomain	path	True	string	所有 Azure IoT Central 服务请求的基域。
subdomain	path	True	string	应用程序子域。
tokenId	path	True	string	API 令牌的唯一 ID。
api-version	query	True	string	正在调用的 API 的版本。

请求正文

名称	必需	类型	说明
roles	True	RoleAssignment[]	指定访问应用程序的权限的角色分配列表。
expiry		string	表示令牌过期时间的字符串格式日期。

响应

名称	类型	说明
200 OK	ApiToken	成功
Other Status Codes	Error	从 IoT Central 服务收到的错误响应。 标头 x-ms-error-code: string

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称	说明
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=..."
}

定义

名称	说明
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	此角色分配的组织 ID。
role	string	此角色分配的角色 ID。