Credencial de Serviço
Nesta página, você encontra os passos para gerar, revogar e editar Credenciais de Serviço.
O que é Credencial de Serviço
A Credencial de Serviço permite que Contas Enterprise criem tokens de serviço vinculados a Grupos e com permissões (escopos) personalizadas para finalidades específicas. Desta forma, as ações executadas em pipelines passam a ser realizadas pela Organização, garantindo mais segurança e controle.
As operações a nível de Conta incluem as seguintes ações:
-
Criação de recursos;
-
Execução de tarefas específicas via pipeline, sem a necessidade de intervenção direta de um usuário específico.
Por exemplo, é possível gerar um token com as informações a seguir:
- Nome de um grupo chamado Tech Products.
- Permissões de escopo para apenas criar e gerenciar Estúdios.
- Equipes responsáveis pelos Tech Products.
Confira a seguir as diferenças entre a Credencial de Serviço e o [Token de Acesso Pessoal (PAT)](home/account/profile/access-token.md):
-
Credencial de Serviço: criada para Contas Enterprise, permite definir escopos (permissões) e grupos personalizados. É ideal para automatizar tarefas e integrações em nome da organização, com mais controle sobre as permissões.
-
Token de Acesso Pessoal (PAT): criado para uso individual, está vinculado diretamente a pessoa usuária. Serve para acessar recursos e executar comandos na StackSpot em nome da própria pessoa.
Pré-requisito
-
Somente pessoas com a permissão de Account Holder ou Sys_Admin podem criar e gerenciar Credenciais de Serviço.
-
Você pode criar uma Credencial de Serviço a qualquer momento no Portal da StackSpot.
Criar Credenciais de Serviço
Por segurança, credenciais como o Personal Access Token (PAT) são armazenadas de forma criptografada na StackSpot. Após serem salvos, não é possível consultar ou visualizar novamente essas informações pela plataforma.
Passo 1. Acesse o Portal de Contas da StackSpot;
Passo 2. Clique no seu avatar de perfil. Em seguida, clique na opção 'Organização';
Passo 3. Em 'Configurações Gerais', clique na seção 'Identidade e Segurança' e depois, clique em 'Credenciais de Serviço';
Passo 4. Clique no botão 'Criar Credencial de Serviço';
Passo 5. Preencha os campos a seguir:
- Nome: nomeie a sua Credencial.
- Descrição: dê uma descrição para ela.
Em seguida, clique no botão 'Próximo'.
Passo 6. Em 'Expiração', selecione os campos a seguir:
-
Validade da Credencial de Serviço: escolha o período em que a Credencial vai expirar:
- 30 dias
- 90 dias
- 180 dias
- 365 dias
- Nunca expira
-
Tempo de expiração do token:
- 15 minutos
- 1 hora
- 2 horas
- 8 horas
- 24 horas
Para continuar, clique no botão 'Próximo'.
Passo 7. (Opcional) Em 'Permissões', adicione, no mínimo, um grupo ou recurso:
-
Para adicionar um grupo:
- Clique no botão 'Adicionar grupo';
- Selecione os grupos que você quer que a credencial herde as permissões;
- Para confirmar, clique no botão 'Adicionar grupo'.
-
Para adicionar um recurso:
- Clique no botão 'Adicionar recurso';
- Selecione os recursos que terão permissões granulares;
- Para continuar, clique no botão 'Próximo'.
- Agora, configure as permissões para cada recurso que você selecionou no passo anterior;
- Para concluir, clique no botão 'Confirmar'.
Agora, clique no botão 'Próximo'.
Passo 8. Na aba 'Revisar e Concluir', revise suas informações e clique no botão 'Concluir'.
Em 'Client ID e Client Key', copie e salve as informações a seguir:
- Client Id
- Client Key
- Realm
- Exemplo de como usar
Depois que você clicar no botão 'Fechar', não será possível visualizar estes dados novamente.
Se você não salvar os dados de Client Secret, não será possível usar essa credencial para autenticar novas sessões ou obter novos tokens de acesso. Por segurança, o Client Secret não pode ser recuperado. Se você perder essa informação, será necessário revogar a credencial e criar uma nova para continuar usando a integração.
Pronto, você gerou uma Credencial de Serviço.
Editar Credenciais de Serviço
Grupos e Recursos são as únicas opções que você pode editar depois que uma Credencial de Serviço é criada.
Para editar uma Credencial de Serviço, siga os passos a seguir:
Passo 1. Ainda na seção de 'Credenciais de Serviço', clique na Credencial que você quer editar;
Passo 2. Para remover Grupos da sua Credencial, clique no botão com ícone de lixeira na linha do Grupo que você quer remover. Para confirmar, clique no botão 'OK';
Passo 2.1. Para remover Recursos da sua Credencial, clique no botão com ícone de lixeira na linha do Recurso que você quer remover. Para confirmar, clique no botão 'OK';
Passo 3. Para adicionar Grupos, clique no botão 'Adicionar' e selecione quais Grupos você quer adicionar. Para confirmar, clique no botão 'Adicionar'.
Passo 3.1. Para adicionar Recursos, clique no botão 'Adicionar' e selecione quais Recursos você quer adicionar. Para confirmar, clique no botão 'Adicionar'.
Revogar Credenciais de Serviço
Quando você revoga uma credencial, os tokens já emitidos por ela perdem a validade imediatamente. Isso significa que qualquer sessão ou integração usando esses tokens será interrompida e precisará de uma nova autenticação com uma credencial válida.
Apenas pessoas com permissão de Account Holder e Sys_Admin podem revogar Credenciais.
É recomendado criar uma nova Credencial antes de revogar a atual.
Passo 1. Ainda em 'Credenciais de Serviço', clique na Credencial que você quer revogar;
Passo 2. Agora clique no botão 'Revogar';
Passo 3. Insira o nome da Credencial no campo 'Nome da credencial';
Passo 4. Para confirmar, clique no botão 'Revogar'.
Pronto, você revogou uma Credencial de Serviço.