Api Tokens - Create

Создайте новый маркер API в приложении для использования в общедоступном API IoT Central. Значение токена будет возвращено в ответе и не будет возвращено повторно в последующих запросах.

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

Параметры URI

Name In Required Type Description
baseDomain
path True
  • string

Базовый домен для всех запросов на обслуживание Azure IoT Central.

subdomain
path True
  • string

Поддомен приложения.

tokenId
path True
  • string

Уникальный идентификатор маркера API.

api-version
query True
  • string

Версия вызываемого API.

Текст запроса

Name Required Type Description
roles True

Список назначений ролей, указывающих разрешения на доступ к приложению.

expiry
  • string

Дата в формате строки, представляющая время истечения срока действия маркера.

Ответы

Name Type Description
200 OK

Успешное завершение

Other Status Codes

Ответ об ошибке, полученный от службы IoT Central.

Headers

  • x-ms-error-code: string

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation олицетворения учетной записи пользователя

Примеры

Create API token

Sample Request

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"
    }
  ]
}

Sample Response

{
  "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.

Name Type Description
expiry
  • string

Дата в формате строки, представляющая время истечения срока действия маркера.

id
  • string

Уникальный идентификатор маркера API.

roles

Список назначений ролей, указывающих разрешения на доступ к приложению.

token
  • string

Значение маркера API.

Error

Определение ошибки ответа.

Name Type Description
error

Сведения об ошибке для текущего запроса.

ErrorDetails

Подробные сведения об ошибке.

Name Type Description
code
  • string

Код ошибки.

message
  • string

Сведения об сообщении об ошибке.

requestId
  • string

Идентификатор корреляции для текущего запроса.

time
  • string

Время сбоя запроса на ошибку.

RoleAssignment

Определение назначения ролей.

Name Type Description
organization
  • string

Идентификатор организации для назначения ролей.

role
  • string

Идентификатор роли для этого назначения роли.