POST токен*

Материал из Документация Ключ-АСТРОМ

Создает новый токен АктивногоШлюза.

Токен будет принадлежать пользователю, которому принадлежит токен, используемый для аутентификации вызова.

Запрос создает и использует application/json формат.

POST Managed https://{your-domain}/e/{your-environment-id}/api/v2/activeGateTokens
Окружающая среда ActiveGate https://{your-activegate-domain}/e/{your-environment-id}/api/v2/activeGateTokens

Аутентификация

Чтобы выполнить этот запрос, вам нужен токен доступа с областью действия Создание токенов АктивногоШлюза ( activeGateTokenManagement.create) . Чтобы узнать, как его получить и использовать, см. раздел Токены и аутентификация .

Параметры

Параметр Тип Описание In Необходимость
body ActiveGateTokenCreate Тело JSON запроса. Содержит параметры нового токена АктивногоШлюза. body требуется

Объекты тела запроса

Объект ActiveGateTokenCreate

Параметры нового токена АктивногоШлюза.

Элемент Тип Описание Необходимость
name string Имя токена. требуется
expirationDate string Срок действия токена.

Вы можете использовать один из следующих форматов:

  • Отметка времени в миллисекундах UTC.
  • Человекочитаемый формат 2021-01-25T05:57:01.123+01:00. Если часовой пояс не указан, используется UTC. Вы можете использовать пробел вместо T. Секунды и доли секунды не являются обязательными.
  • Относительный таймфрейм, назад. Формат: now-NU/A, где Nколичество времени, Uединица времени и Aвыравнивание. Выравнивание округляет все меньшие значения до ближайшего нуля в прошлом. Например, now-1y/wэто один год назад, выровненный на неделю. Вы также можете указать относительный таймфрейм без выравнивания: now-NU. Поддерживаемые единицы времени для относительного таймфрейма:
    • m: минуты
    • h: часы
    • d: дни
    • w: недели
    • M: месяцы
    • y: годы

Если не установлено, срок действия токена никогда не истекает.

по желанию
seedToken boolean Токен является начальным токеном ( true) или отдельным токеном ( false).

Мы рекомендуем использовать индивидуальный токен (false).

по желанию
activeGateType string Тип АктивногоШлюза, для которого действителен токен.

Элемент может содержать эти значения

  • ENVIRONMENT
  • CLUSTER
требуется

JSON-модель тела запроса

Это модель тела запроса, показывающая возможные элементы. Его необходимо настроить для использования в реальном запросе.

{
  "name": "myToken",
  "expirationDate": "now+14d",
  "seedToken": false,
  "activeGateType": "ENVIRONMENT"
}

Ответ

Коды ответов

Код Тип Описание
201 ActiveGateTokenCreated Успех. Токен создан. Тело ответа содержит секрет токена.
400 ErrorEnvelope Не удалось. Ввод недействителен.

Объекты тела ответа

Объект ActiveGateTokenCreated

Недавно созданный токен АктивногоШлюза.

Элемент Тип Описание
id string Идентификатор токена АктивногоШлюза, состоящий из префикса и общедоступной части токена.
token string Секрет токена.
expirationDate string Дата истечения срока действия токена в формате ISO 8601 ( yyyy-MM-dd'T'HH:mm:ss.SSS'Z').

JSON-модель тела ответа

{
  "id": "dt0g02.4KWZO5EF",
  "token": "dt0g02.4KWZO5EF.XT47R5DRADJIZUFOX4UDNOKTSUSABGLN7XSMJG7UXHRXKNY4WLORH4OF4T75MG7E",
  "expirationDate": "2020-11-24T08:15:30.144Z"
}

Пример

В этом примере запрос создает новый токен АктивногоШлюза для среды АктивногоШлюза. Токен действителен в течение двух недель (14 дней) с момента создания.

Маркер API передается в заголовке авторизации .

Curl

curl --request GET \
  --url https://mySampleEnv.live.ruscomtech.ru//api/v2/activeGateTokens \
  --header 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
   --header 'Content-Type: application/json' \
  --data '{
  "name": "REST test",
  "expirationDate": "now+14d",
  "seedToken": false,
  "activeGateType": "ENVIRONMENT"
}'

URL-адрес запроса

https://mySampleEnv.live.ruscomtech.ru//api/v2/activeGateTokens

Тело запроса

{
  "name": "REST test",
  "expirationDate": "now+14d",
  "seedToken": false,
  "activeGateType": "ENVIRONMENT"
}

Тело ответа

{
  "id": "dt0g02.xyz789",
  "token": "dt0g02.xyz789.987654321zyxwvutsrq",
  "expirationDate": "2021-12-14T13:42:31.148Z"
}

Код ответа

201