Вернуться наверх
На этой странице:

Авторизация ​

Выполнять запросы к API могут только аутентифицированные пользователи. Для этого при выполнении запроса необходимо в заголовке Authorization: Bearer передавать аутентификационный jwt-токен.

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

  • Кратковременный токен
  • Долговременный токен

Кратковременный токен ​

Пара access/refresh токенов, генерируемая при помощи запроса POST /iam/v2/tokens.

Сгенерированный аccess-токен позволит выполнять запросы к API в течение ограниченного периода времени (например, 1 час). Refresh-токен понадобится для продления сессии — его нужно будет передать в теле запроса PUT /iam/v2/tokens/current.

Такой вид токена подходит для выполнения реальных пользовательских сценариев, и является безопасным, поскольку имеет ограниченное время жизни. В тоже время, данный тип токена плохо подойдет для автоматизации каких-либо периодических действий через API.

Долговременный токен ​

Такой access-токен можно сгенерировать для сервисного аккаунта. Сервисный аккаунт действует в рамках назначенной ему роли; запросы, выполняемые от лица сервисного аккаунта, авторизуется сгенерированным access-токеном.

Данный вид токена обладает длительным временем действия (дата истечения задается при генерации). Хорошо подойдет для автоматизации каких-либо рутинных действий через API. В то же время, крайне важно не допускать компрометации долговременного access-токена.

Создание долговременного токена ​

  1. Авторизуйтесь в Платформе и откройте Дашборд.
  2. В правой части экрана в секции IAM (Пользователи и сервисные аккаунты) откройте ссылку Все >.
  3. На вкладке Сервисные аккаунты нажмите +Добавить сервисный аккаунт.
  4. Укажите название аккаунта, затем нажмите на значок + и добавьте роль — например, Project Admin.
  5. Нажмите Добавить для завершения создания сервисного аккаунта.
  6. На вкладке Сервисные аккаунты выберите в списке созданный и кликните на него.
  7. Нажмите +Создать токен.
  8. Задайте имя токена и дату истечения его действия, затем нажмите Добавить.
  9. Скопируйте сгенерированный токен в буфер обмена. После закрытия окна токен не будет отображаться.
  10. Сохраните токен в надежном месте.
  11. Для автоматизации каких-либо периодических действий через API используйте данный токен при выполнении запросов в заголовке Authorization: Bearer.