API da Conta da JetBrains
Com a API da conta da JetBrains, você pode gerenciar automaticamente as licenças e as contas de usuário da sua organização.
A API pode ser usada para:
- Obter detalhes da licença
- Atribuir ou revogar licenças
- Transferir licenças entre equipes
- Criar ou excluir contas de usuário
Referência da API da conta da JetBrains
Para obter a lista completa de métodos da API, consulte Referência da API da conta da JetBrains.
Observe que os recursos de gerenciamento de contas apenas estão disponíveis para organizações com um a domínio verificado.
Níveis de acesso à API
Sua função no perfil da organização determina o que você pode fazer na interface do usuário da conta da JetBrains, quais informações você pode acessar por meio da API e se tem permissão para alterá-las.
| Papel | O que você pode fazer na interface de usuário da conta da JetBrains | O que você pode acessar por meio da API | Nível de acesso à API |
|
Perfil de toda a organização |
Acesso total |
|
|
Sua equipe |
Acesso total |
|
|
Visualizadores e contatos principais |
Perfil de toda a organização |
Somente leitura |
Habilitar ou desabilitar a API
| 🔒 Permissões necessárias: administrador da organização. |
Para habilitar a API:
- Faça login na sua conta da JetBrains.
- No menu à esquerda, clique no nome da sua organização.
- No menu que aparecerá, selecione Administration.
-
Na seção API, clique em Enable API (Habilitar API).
Isso dá acesso à API para todos os administradores, visualizadores e contatos principais. Eles poderão gerar tokens de API pessoais e dependendo de suas funções, acessar o perfil da organização ou da equipe por meio da API.
Desabilitar a API
Para desabilitar a API, siga as etapas de 1 a 3 nas instruções acima e, em seguida, clique em Desabilitar API. Isso desabilitará a API para todos na organização.
A desabilitação da API bloqueia o acesso ao perfil da organização por meio dos métodos da API, mas não invalida os tokens que já foram gerados. Se você habilitar a API novamente mais tarde, esses tokens ainda funcionarão. Consulte Tempo de vida de tokens para obter detalhes.
Gerenciar tokens de acesso à API
Se a sua função no perfil da organização lhe der acesso à API, você poderá gerar um token de acesso pessoal e regenerá-lo ou removê-lo sempre que necessário. Administradores de organizações e equipes também podem gerenciar tokens gerados por outras pessoas em suas organizações ou equipes.
Gerenciar seu token de API pessoal
| 🔒 Permissões necessárias: administração da organização, administrador da equipe ou contato principal para cobrança. |
Para usar a API, você precisará de um token de acesso pessoal. Você pode gerar, regenerar ou remover esse token a qualquer momento. Como o token está vinculado à sua conta, todas as solicitações de API feitas com ele serão vinculadas a você. Outros membros da sua organização com acesso à API também podem gerar seus próprios tokens.
Gerar um token pessoal
- Certifique-se de que a API da conta da JetBrains esteja ativada na sua organização.
- Faça login na sua conta da JetBrains.
- No menu à esquerda, selecione uma das seguintes opções, dependendo da sua função:
- Se você for administrador, visualizador ou contato principal de uma organização, clique no nome da organização:
- Se você for um administrador de equipe, clique no nome da equipe:
- Se você for administrador, visualizador ou contato principal de uma organização, clique no nome da organização:
- Na seção API da página de administração, clique em Generate Token (Gerar token).
-
Quando a caixa de diálogo for exibida, você verá seu token. Por motivos de segurança, somente o mostramos uma vez. Portanto, certifique-se de salvá-lo em um local seguro antes de fechar a caixa de diálogo.
Não compartilhe seu token com ninguém. Se ele ficar comprometido, regenere-o ou remova-o imediatamente.
Regenerar um token pessoal
Talvez você precise regenerar seu token pessoal nos seguintes casos:
- Você perdeu o acesso ao seu token atual.
- Seu token foi comprometido.
Para gerar um novo token:
- Siga as etapas de 1 a 3 nas instruções para gerar um token pessoal.
- Na seção API da página de administração, clique em Re-Generate Token (Regenerar token).
- Quando uma caixa de diálogo de confirmação for exibida, clique novamente em Re-Generate Token (Regenerar token).
- Na próxima caixa de diálogo pop-up, você verá seu novo token. Por motivos de segurança, somente o mostramos uma vez. Portanto, certifique-se de salvá-lo em um local seguro antes de fechar a caixa de diálogo.
Se você regenerar seu token, o antigo será imediatamente invalidado. Certifique-se de atualizar seu token em todos os aplicativos que usam a API.
Remover um token de acesso pessoal
Se você não precisar mais acessar a API, siga estas etapas para remover seu token:
- Siga as etapas de 1 a 3 nas instruções para gerar seu token.
- Na seção API da página de administração, clique em Remove Token (Remover token).
- Quando uma caixa de diálogo de confirmação for exibida, clique novamente em Remove Token (Remover token).
Gerenciar tokens de API gerados por terceiros
Como administrador de uma organização ou equipe, você pode visualizar e revogar tokens de API gerados por outros membros da sua organização ou equipe.
Visualizar e revogar tokens de API em toda a organização
| 🔒 Permissões necessárias: administrador da organização. |
- Siga as etapas de 1 a 3 das instruções acima para abrir a página de administração da organização.
- Na página de administração, role para baixo até Users with access to company licenses (Usuários com acesso a licenças da empresa).
- Na coluna API token (Token de API), você verá todas as pessoas da sua organização que geraram um token.
- Para revogar um token, localize o usuário na tabela e clique em Revoke (Revogar).
Visualizar e revogar tokens de API específicos da equipe
| 🔒 Permissões necessárias: administrador da organização ou administrador da equipe. |
- Siga as etapas de 1 a 3 nas instruções para gerar seu token e abrir a página de administração da equipe.
- Na página de administração, role para baixo até a seção Team Administration (Administração da equipe).
- Na coluna API token (Token de API), você verá todas as pessoas da sua equipe que geraram um token.
- Para revogar um token, localize o usuário na tabela e clique em Revoke (Revogar).
Vida útil do token
Uma vez emitidos, os tokens de API da conta da JetBrains têm uma vida útil indefinida.
Cada usuário recebe um token, mesmo que tenha várias funções. A menos que eles o regenerem ou removam, o token permanecerá ativo enquanto eles mantiverem pelo menos uma função. Se eles perderem todas as funções, o token será revogado automaticamente.
Se você desabilitar a API e ativá-la novamente mais tarde, todos os tokens gerados anteriormente ainda serão válidos, a menos que você os remova ou gere novamente.
Se seu token pessoal ficar comprometido, regenerate or remova-o imediatamente. Se o token de outra pessoa ficar comprometido, revogue-o.
Usar métodos de API
Consulte a Referência da API da conta da JetBrains para obter a lista completa dos métodos disponíveis. Observe que os recursos de gerenciamento de contas apenas estão disponíveis para organizações com um a domínio verificado.
Para usar os métodos da API, você precisará de dois parâmetros:
1. Sua ID de cliente para X-Customer-Code
Seu ID de cliente da JetBrains é um identificador exclusivo vinculado aos pedidos e licenças da sua organização. Você pode encontrá-la na sua conta da JetBrains.
Use esse valor para o parâmetro X-Customer-Code na sua solicitação.
2. Seu token de acesso para X-Api-Key
Siga as etapas acima para gerar seu token pessoal. Use-o para o parâmetro X-Api-Key.