API JetBrains-аккаунта

Обновлено 27/10/2025 13:47

Через API JetBrains-аккаунта можно автоматически управлять лицензиями и учетными записями пользователей в вашей организации.

С помощью API можно:

Получать информацию о лицензии
Назначать и отзывать лицензии
Перемещать лицензии между командами
Создавать и удалять учетные записи пользователей

Справочник по API JetBrains-аккаунта

Полный список методов API см. в справочнике по API JetBrains-аккаунта.

Функции управления учетной записью доступны только организациям с подтвержденным доменом.

Уровни доступа к API

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

Ролям	Что вы можете делать в интерфейсе JetBrains-аккаунта	Доступ через API	Уровень доступа к API
Администраторы организации	Включение и отключение API для всей организации Генерация, обновление и удаление личного токена доступа к API Отзыв токенов доступа у других пользователей в вашей организации, включая других администраторов организации	Профиль всей организации	Полный доступ
Администраторы команды	Генерация, обновление и удаление личного токена доступа к API Отзыв токенов доступа у других пользователей в вашей команде, включая других администраторов команды	Ваша команда	Полный доступ
Наблюдатели и основные контактные лица	Генерация, обновление и удаление личного токена доступа к API	Профиль всей организации	Только для чтения

Включение и отключение API

🔒 Нужно иметь права администратора организации.

Чтобы включить API:

Войдите в свой JetBrains-аккаунт.
В меню слева нажмите на название вашей организации.
В появившемся меню выберите Administration.
В разделе API нажмите Enable API.

После этого API будет включен для всех администраторов, наблюдателей и основных контактных лиц. Они смогут генерировать личные токены API и, в зависимости от их роли, получить доступ к профилю организации или команды через API.

Отключение API

Чтобы отключить API, повторите шаги 1–3 из инструкции выше, а затем нажмите Disable API. После этого API будет отключен для всех пользователей в организации.

Disable API

Отключение API блокирует доступ к профилю организации через методы API, но не делает недействительными токены, которые были сгенерированы. Если позже вы снова включите API, эти токены будут работать. Подробнее см. Срок действия токена.

Управление токенами доступа к API

Если ваша роль в профиле организации дает вам доступ к API, вы можете сгенерировать личный токен доступа, а затем при необходимости сгенерировать его заново или удалить. Администраторы организации и команды также могут управлять токенами, сгенерированными другими пользователями в соответствующей организации или команде.

Управление личным токеном API

🔒 Нужно иметь права администратора организации, администратора команды или основного плательщика.

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

Генерация личного токена

Убедитесь, что в вашей организации включен API JetBrains-аккаунта.
Войдите в свой JetBrains-аккаунт.
В меню слева выберите в зависимости от вашей роли один из следующих вариантов:
- Если вы администратор организации, наблюдатель или основное контактное лицо, нажмите на название организации:
- Если вы администратор команды, нажмите на название команды:
В разделе API на странице Administration нажмите Generate Token.
В появившемся диалоге вы увидите свой токен. По соображениям безопасности мы показываем его только один раз. Сохраните его в безопасном месте, прежде чем закрыть диалог.

Никому не передавайте свой токен. Если он скомпрометирован, немедленно сгенерируйте его заново или удалите.

Повторная генерация личного токена

Токен может понадобиться сгенерировать заново в следующих случах:

Вы потеряли доступ к текущему токену.
Токен был скомпрометирован.

Чтобы сгенерировать новый токен:

Следуйте шагам 1–3 в инструкции для генерации личного токена.
В разделе API на странице Administration нажмите Re-Generate Token.
Когда появится диалог подтверждения, снова нажмите Re-Generate Token.
В следующем всплывающем диалоге вы увидите свой новый токен. По соображениям безопасности мы показываем его только один раз. Сохраните его в безопасном месте, прежде чем закрыть диалог.

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

Удаление личного токена доступа

Если вам больше не нужен доступ к API, выполните следующие шаги, чтобы удалить свой токен:

Повторите шаги 1–3 из инструкции выше, чтобы сгенерировать токен.
В разделе API на странице Administration нажмите Remove Token.
Когда появится диалог подтверждения, снова нажмите Remove Token.

Управление токенами API, сгенерированными другими

Администраторы организации и команды могут просматривать токены API, сгенерированные другими пользователями в соответствующей организации или команде, и отзывать их.

Просмотр и отзыв токенов API во всей организации

🔒 Нужно иметь права администратора организации.

Повторите шаги 1–3 из инструкции выше, чтобы открыть страницу управления организацией.
На странице администрирования прокрутите вниз до секции Users with access to company licenses.
В столбце API token вы увидите всех пользователей в вашей организации, сгенерировавших токены.
Чтобы отозвать токен, найдите пользователя в таблице и нажмите Revoke.

Просмотр и отзыв токенов API в команде

🔒 Нужно иметь права администратора организации или администратора команды.

Повторите шаги 1–3 из инструкции выше, чтобы открыть страницу управления командой.
На странице управления прокрутите вниз до раздела Team Administration.
В столбце API token вы увидите всех пользователей в вашей команде, сгенерировавших токены.
Чтобы отозвать токен, найдите пользователя в таблице и нажмите Revoke.

Срок действия токена

Сгенерированные токены API JetBrains-аккаунта имеют неограниченный срок действия.

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

Если вы отключите API и снова включите его позже, любые ранее сгенерированные токены будут действовать, если вы не удалите их или не сгенерируете повторно.

Если ваш личный токен скомпрометирован, немедленно сгенерируйте его заново или удалите. Если скомпрометирован токен другого пользователя, отзовите его.

Использование методов API

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

Чтобы использовать методы API, необходимо задать два параметра:

1. Ваш идентификатор клиента ID для `X-Customer-Code`

Идентификатор клиента JetBrains — это уникальный идентификатор, связанный с заказами и лицензиями вашей организации. Его можно найти в вашем JetBrains-аккаунте.

Присвойте это значение параметру X-Customer-Code в запросе.

2. Ваш токен доступа для `X-Api-Key`

Выполните описанные выше шаги, чтобы сгенерировать токен. Присвойте это значение параметру X-Api-Key.

Остались вопросы?

Отправить запрос