Эта статья предназначена для организаций, использующих бесплатные лицензии для учебных заведений (Classroom licenses). Если у вашей организации коммерческие лицензии, управлять ими можно через JetBrains Console. Подробные инструкции вы найдете в документации JetBrains Console.

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

API позволяет:

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

Справочник по API

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

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

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

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

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

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

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

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

Отключение API

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

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

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

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

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

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

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

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

5. В появившемся диалоге вы увидите свой токен. По соображениям безопасности мы показываем его только один раз — обязательно сохраните его в надежном месте перед тем, как закрыть окно. 
   

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

Перевыпуск личного токена

Вам может потребоваться перевыпустить личный токен, если:

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

Чтобы создать новый токен:

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

При перевыпуске токена старый сразу становится недействительным. Не забудьте обновить токен во всех приложениях, использующих API.

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

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

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

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

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

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

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

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

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

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

Токены JetBrains Account API бессрочны. 

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

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

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

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

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

Для вызова методов API потребуются два параметра:

1. Ваш Customer ID для X-Customer-Code

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

Укажите это значение в параметре X-Customer-Code в запросе.

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

Создайте личный токен по инструкции выше. Используйте его для параметра X-Api-Key.