Api Tokens - Create

Служба:

IoT Central

Версия API:

2022-07-31

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

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

Поток OAuth2 в Azure Active Directory

Тип: oauth2
Flow: 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.
roles	RoleAssignment[]	Список назначений ролей, указывающих разрешения на доступ к приложению.
token	string	Значение маркера API.

Error

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

Имя	Тип	Описание
error	ErrorDetails	Сведения об ошибке для текущего запроса.

ErrorDetails

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

Имя	Тип	Описание
code	string	Код ошибки.
message	string	Сведения об сообщении об ошибке.
requestId	string	Идентификатор корреляции для текущего запроса.
time	string	Время сбоя запроса ошибки.

RoleAssignment

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

Имя	Тип	Описание
organization	string	Идентификатор организации для этого назначения роли.
role	string	Идентификатор роли для этого назначения роли.