Тема
API-токены
Токен - секрет, которым скрипт, задача CI или интеграция обращается к API. В DoQA три вида токенов.
| Вид | Кому принадлежит | Где создаётся |
|---|---|---|
| Личный | Пользователю | Профиль, вкладка API-токены |
| Токен проекта | Проекту (для отправки результатов автотестов) | Администрирование → проект → «Токены» |
| Токен сервисного аккаунта | Сервисному аккаунту | Администрирование → сервисный аккаунт → «Токены» |
Общие правила:
- Секрет показывается один раз, сразу после создания. Закройте окно, не скопировав его, и увидеть его уже не сможет никто, включая администраторов. Хранятся только хэш и маска.
- Токен передают заголовком
Authorization: Bearer <токен>. - Токен никогда не шире прав владельца и пересчитывается при каждом запросе: если у владельца права пропали, токен их тоже теряет.
- У токена видно дату последнего использования.
- Отозванный токен восстановить нельзя: выпустите новый и обновите скрипты. Отзыв действует сразу.
Личные токены
Личный токен действует от вашего имени с подмножеством ваших прав.
| Параметр | Правило |
|---|---|
| Количество | До 10 токенов на пользователя |
| Срок действия | Необязателен: 30, 90 или 180 дней, 1 год, своя дата (до года вперёд) или «Бессрочный». Бессрочный токен действует, пока его не отзовут, поэтому лучше выбирать ограниченный срок |
| Где действует | Можно ограничить местами (организация, проекты, пространства). Пустой список означает все ваши места |
| Права | Можно ограничить набором прав. Пустой набор означает все ваши права. Выбрать право шире своего нельзя |
| Название | До 255 символов |
Блокировка пользователя отзывает его личные токены. Администратор с правом user.tokens_manage видит личные токены другого человека в его карточке (раздел «Вход и токены») и может отозвать один или все. Создать токен за другого администратор не может.
Токены, выпущенные до обновления
Личные токены, созданные до перехода на новую систему прав, продолжают работать с правами владельца на всех его местах. Токены без срока остаются бессрочными.
Токены проекта
Токены проекта отправляют в проект результаты автотестов из CI, см. Отправка результатов. Вкладка «Токены» проекта видна тем, у кого есть право project_token.view, создавать и отзывать токены можно с project_token.manage.
- Создание: «Создать токен», название (например, gitlab-ci). Секрет показывается один раз.
- «Переименовать» меняет название. «Отозвать» останавливает отправку результатов с этим токеном: запросы получат 401.
- В таблице видны автор токена, подключение CI, дата создания и последнее использование. Если автор заблокирован, строка помечена. Токены, которые не использовались 90 дней, подсвечены.
Токен проекта работает как сервисный аккаунт с ролью «Агент CI» на этом проекте: он может отправлять результаты и читать план прогона. Отозвать его доступ можно, сняв роль у аккаунта.
Раздел «Подключения» → «API-токены»
Показывает токены всех проектов: что использует CI и что стоит отозвать. Есть поиск по названию токена или проекта, фильтры, пометка «Не использовался более 90 дней» и массовый отзыв. Личные токены находятся в карточке пользователя.
Токены сервисных аккаунтов
См. Сервисные аккаунты.