Поделиться через


Api Tokens - Get

Получение маркера API по идентификатору.

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

Ответы

Имя Тип Описание
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 олицетворения учетной записи пользователя

Примеры

Get API token by ID

Образец запроса

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

Пример ответа

{
  "id": "testtoken",
  "roles": [
    {
      "role": "c495eb57-eb18-489e-9802-62c474e5645c",
      "organization": "seattle"
    }
  ],
  "expiry": "2020-10-18T18:30:40.227Z"
}

Определения

Имя Описание
ApiToken

Определение маркера доступа к API.

Error

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

ErrorDetails

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

RoleAssignment

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

ApiToken

Определение маркера доступа к API.

Имя Тип Описание
expiry

string (date-time)

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

id

string

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

roles

RoleAssignment[]

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

token

string

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

Error

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

Имя Тип Описание
error

ErrorDetails

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

ErrorDetails

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

Имя Тип Описание
code

string

Код ошибки.

message

string

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

requestId

string

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

time

string (date-time-rfc1123)

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

RoleAssignment

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

Имя Тип Описание
organization

string

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

role

string

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