Nesta página

4 Tokens API

Visão geral

Esta seção permite criar e gerenciar tokens de API.

Você pode filtrar tokens de API por nome, usuários aos quais os tokens estão atribuídos, data de expiração, usuários que criaram tokens ou status (ativado/desativado). Clique no status do token na lista para ativar/desativar rapidamente um token. Você também pode ativar/desativar vários tokens em massa selecionando-os na lista e clicando nos botões Enable/Disable abaixo da lista.

Para criar um novo token, clique no botão Create API token no canto superior direito e preencha os campos obrigatórios na tela de configuração do token:

Parameter Description
Name Nome visível do token.
User Usuário ao qual o token deve ser atribuído. Para selecionar rapidamente um usuário, comece a digitar o nome de usuário, nome ou sobrenome e, em seguida, selecione o usuário desejado na lista de preenchimento automático. Como alternativa, você pode clicar no botão Select e selecionar um usuário na lista completa de usuários. Um token pode ser atribuído a apenas um usuário.
Description Descrição opcional do token.
Set expiration date and time Desmarque esta caixa de seleção se um token não deve ter data de expiração.
Expiry date Clique no ícone de calendário para selecionar a data de expiração do token ou insira a data manualmente no formato YYYY-MM-DD hh:mm:ss
Enabled Desmarque esta caixa de seleção se você precisar criar um token em estado desativado.

Clique em Add para criar um token.

Copie o valor de Auth token e salve-o em um local seguro antes de fechar a página; depois, clique em Close. O token aparecerá na lista.

O valor de Auth token não pode ser visualizado novamente depois. Ele está disponível apenas imediatamente após a criação de um token. Se você perder um token salvo, será necessário regenerá-lo, e isso criará uma nova string de autorização.

Clique no nome do token para editar o nome, a descrição, as configurações da data de expiração ou o status do token. Observe que não é possível alterar para qual usuário o token está atribuído. Clique no botão Update para salvar as alterações. Se um token tiver sido perdido ou exposto, você pode clicar no botão Regenerate para gerar um novo valor de token. Uma caixa de diálogo de confirmação será exibida, solicitando que você confirme esta operação, pois, após prosseguir, o token gerado anteriormente se tornará inválido.

Usuários sem acesso à seção de menu Administration podem ver e modificar os detalhes dos tokens atribuídos a eles na seção User profile → API tokens section somente se Manage API tokens estiver permitido nas permissões de sua user role.