API JetBrains Account
Через API JetBrains Account можно автоматически управлять лицензиями и получать информацию об использовании лицензии из JetBrains Account.
С помощью методов API можно получать информацию о лицензии, назначать и отзывать лицензии, а также перераспределять лицензии между командами. Роль JetBrains Account определяет уровень доступа к методам API. Подробные сведения см. в документации по API.
Роли
В API предусмотрено три уровня доступа, соответствующих ролям, которые можно назначить в профиле организации.
- Администраторы организации могут включать и отключать API, генерировать и повторно создавать токены для себя, а также отзывать токены доступа у любого пользователя в организации, в том числе у других администраторов.
- Администраторы команды могут генерировать, повторно создавать и отзывать токены доступа у любого участника своей команды, в том числе у любых других администраторов.
- Просмотрщики и основные контактные лица могут генерировать, повторно создавать и отзывать токены доступа у самих себя. Токены доступа просмотрщика и основного контактного лица обеспечивают доступ к API в режиме только для чтения.
Как включить API
Чтобы включить API, выполните следующие действия.
- Войдите в JetBrains Account с учетными данными администратора организации.
Администраторы команды не имеют права включать и отключать API. - В меню слева выберите название вашей организации и нажмите Administration
-
Нажмите кнопку Enable API.
После этого API станет доступен всем администраторам организации, администраторам команд, а также просмотрщикам и основным контактным лицам. Все пользователи, которым назначены роли, могут генерировать токены.
Как отключить API
Чтобы отключить API, выполните приведенные выше шаги 1 и 2, после чего нажмите кнопку Disable API.
После нажатия этой кнопки API будет отключен для всех администраторов, просмотрщиков и основных контактных лиц.
Как получить доступ к методам API
Чтобы получить доступ к методам, необходимо задать два параметра.
1. Ваш код клиента для параметра X-Customer-Code
Код клиента представляет собой уникальный идентификатор организации. Чтобы узнать код клиента, перейдите в JetBrains Account и найдите число рядом с названием вашей организации.
Присвойте это значение параметру X-Customer-Code.
2. Ваш токен доступа для параметра X-Api-Key
Чтобы сгенерировать токен доступа, выполните указанные ниже действия:
- Перейдите в JetBrains Account.
- В меню слева выберите название вашей организации или команды и нажмите Administration.
- Нажмите Generate Token.
- Токен отобразится во всплывающем диалоговом окне. В целях безопасности токен отображается только один раз. Перед тем как закрыть диалоговое окно, сохраните токен в надежном месте. Не передавайте свой токен другим лицам.
Если токен будет утерян, его необходимо будет сгенерировать заново. После создания нового токена прежний токен аннулируется.
Передайте полученный токен в качестве значения параметра X-Api-Key.
Срок действия токена
При включении и отключении API токен доступа продолжает действовать, пока вы вручную не сгенерируете новый токен.
Каждому пользователю выделяется только один токен, даже если ему назначено несколько ролей. Пока пользователю назначена хотя бы одна роль, токен остается неизменным. Если пользователь лишается всех ролей, его токен доступа автоматически отзывается.