Use contas de serviço para se autenticar com as APIs HTTP da Grafana

Você pode usar uma conta de serviço para executar cargas de trabalho automatizadas no Grafana, como provisionamento de painéis, configuração ou geração de relatórios. Crie contas de serviço e tokens para autenticar aplicativos, como o Terraform, com o console Grafana ou a API Amazon Managed Grafana.

nota

As contas de serviço estão disponíveis no Grafana 9.x e versões mais recentes e estão substituindo as chaves de API como a principal forma de autenticar aplicativos que interagem com o Grafana.

Um caso de uso comum para criar uma conta de serviço é realizar operações em tarefas automatizadas ou acionadas. Você pode usar contas de serviço para:

• Defina alertas em seu sistema para serem usados na Grafana

• Interaja com o Grafana sem fazer login como usuário

nota

Cada conta de serviço é considerada um usuário para fins de cobrança.

Tokens de contas de serviço

Um token de conta de serviço é uma string aleatória gerada que atua como alternativa a uma senha ao se autenticar com a API HTTP do Grafana.

Ao criar uma conta de serviço, você pode associar um ou mais tokens de acesso a ela. Você pode usar tokens de acesso ao serviço da mesma forma que as chaves de API, por exemplo, para acessar as APIs HTTP da Grafana programaticamente.

Você pode criar vários tokens para a mesma conta de serviço. Talvez você queira fazer isso se:

• vários aplicativos usam as mesmas permissões, mas você gostaria de auditar ou gerenciar suas ações separadamente.

• você precisa rotacionar ou substituir um token comprometido.

Os tokens de acesso à conta de serviço herdam as permissões da conta de serviço.

Benefícios da conta de serviço

Os benefícios adicionais das contas de serviço às chaves de API incluem:

• As contas de serviço se assemelham aos usuários da Grafana e podem ser ativadas/desativadas, receber permissões específicas e permanecer ativas até serem excluídas ou desativadas. As chaves de API só são válidas até a data de expiração.

• As contas de serviço podem ser associadas a vários tokens.

• Ao contrário das chaves de API, os tokens da conta de serviço não estão associados a um usuário específico, o que significa que os aplicativos podem ser autenticados mesmo se um usuário da Grafana for excluído.

• Você pode conceder permissões às contas de serviço da mesma forma que concede permissões aos usuários.

  Para obter mais informações sobre permissões, consulte Usando permissões.

Criação de uma conta de serviço

nota

O usuário que cria uma conta de serviço também pode ler, atualizar e excluir a conta de serviço que criou, bem como as permissões associadas a essa conta de serviço.

Pré-requisito

Certifique-se de ter permissão para criar e editar contas de serviço. Por padrão, a função de administrador da organização é necessária para criar e editar contas de serviço. Para obter mais informações sobre permissões, consulte Usando permissões.

Para criar uma conta de serviço

1. Faça login no seu espaço de trabalho Amazon Managed Grafana e selecione Administração no menu do lado esquerdo.

2. Selecione Contas de serviço.

3. Selecione Adicionar conta de serviço.

4. Insira um nome de exibição.

5. O nome de exibição deve ser exclusivo, pois determina a ID associada à conta de serviço.

   • Recomendamos que você use uma convenção de nomenclatura consistente ao nomear contas de serviço. Uma convenção de nomenclatura consistente pode ajudar você a escalar e manter contas de serviço no futuro.

   • Você pode alterar o nome de exibição a qualquer momento.

6. Escolha Criar.

nota

Você também pode criar contas de serviço usando as APIs Amazon Managed Grafana AWS . Use o CreateWorkspaceServiceAccountpara criar uma conta de serviço programaticamente.

Adicionar um token a uma conta de serviço

Um token de conta de serviço é uma string aleatória gerada que atua como alternativa a uma senha ao se autenticar com a API HTTP do Grafana.

Pré-requisito

Certifique-se de ter permissão para criar e editar contas de serviço. Por padrão, a função de administrador da organização é necessária para criar e editar contas de serviço. Para obter mais informações sobre permissões, consulte Usando permissões.

Para adicionar um token a uma conta de serviço

1. Faça login no Grafana e escolha Administração no menu do lado esquerdo.

2. Escolha Contas de serviço.

3. Selecione a conta de serviço à qual você deseja adicionar um token.

4. Escolha Adicionar token de conta de serviço.

5. Insira um nome para o token.

6. Selecione Definir data de expiração e insira uma data de expiração para o token.

   • A data de expiração especifica por quanto tempo você deseja que a chave seja válida.

   • Você pode definir uma data de expiração em até 30 dias no futuro.

   • Se você não tiver certeza da data de validade, recomendamos que você defina o token para expirar após um curto período de tempo, como algumas horas ou menos. Isso limita o risco associado a um token válido por muito tempo.

7. Escolha Gerar token.

nota

Você também pode criar tokens de conta de serviço usando as APIs Amazon Managed Grafana. AWS Use o CreateWorkspaceServiceAccountTokenpara criar um token de conta de serviço programaticamente.

Atribuir funções a uma conta de serviço

Você pode atribuir funções a uma conta de serviço da Grafana para controlar o acesso aos tokens da conta de serviço associada. Você pode atribuir funções a uma conta de serviço usando a interface do Grafana ou por meio da API.

Pré-requisito

Certifique-se de ter permissão para criar e editar contas de serviço. Por padrão, a função de administrador da organização é necessária para criar e editar contas de serviço. Para obter mais informações sobre permissões, consulte Usando permissões.

Para atribuir uma função a uma conta de serviço

1. Faça login no Grafana e escolha Administração no menu do lado esquerdo.

2. Escolha Contas de serviço.

3. Selecione a conta de serviço à qual você deseja atribuir uma função. Como alternativa, encontre a conta de serviço na exibição em lista.

4. Atribua uma função usando o seletor de funções para atualizar.