Gerenciar Secrets

As Secrets podem ser cadastradas para uso em perfis pessoais, permitindo que informações sensíveis, como chaves de acesso, tokens e credenciais, sejam utilizadas de forma segura em contextos individuais.

Confira um exemplo:

Existem momentos em que você precisa que a StackSpot acesse um repositório privado no GitHub para realizar deploys ou clonar o código. Para isso, você pode cadastrar um Personal Access Token (PAT) como uma Secret no seu perfil pessoal. Esse token será usado pela StackSpot para autenticar o acesso ao repositório.

Siga os passos a seguir para cadastrar uma Secret:

Pré-requisitos

Você precisa ter uma das seguintes permissões: developer, creator ou ai_developer. Para mais informações, acesse a página de Permissões.

Passo a passo para cadastrar uma Secret

Passo 1. Acesse o Portal da StackSpot. Você tem duas opções para acessar o Portal:

Acessar diretamente o Portal da Conta;
Após fazer login no Portal StackSpot EDP, clicar no seu avatar de perfil.

Passo 2. Acesse o Perfil. No menu exibido, selecione a opção 'Meu Perfil';

Passo 3. Clique na seção 'Gerenciamento de Secrets';

Passo 4. Clique no botão 'Cadastrar Secret' para iniciar o cadastro;

Passo 5. Selecione o tipo de Secret que deseja cadastrar e preencha as informações específicas de acordo com o tipo escolhido. Confira os detalhes a seguir:

Tipos de Secrets e campos necessários

1. API Key: usado para autenticar solicitações de aplicações clientes para APIs. Preencha os campos:

Nome da Secret
Nome do Header
Valor
Data de Expiração (Opcional)

2. Bearer Tokens (OAuth): Tokens são emitidos como parte do framework de autorização OAuth2, permitindo que clientes acessem recursos protegidos. Preencha os campos:

Nome da Secret
Nome do Header
Valor do Header
Data de Expiração (Opcional)

3. Client Credentials: comumente usado para comunicação de servidor para servidor, uma aplicação do cliente deve se autenticar usando credenciais de cliente. Preencha os campos:

Nome da Secret
Client ID
Client Secret
Scopes (Opcional): adicione múltiplos, como profile, edit, email, iam.role, etc.
Data de Expiração (Opcional)

4. Certificado: certificados de cliente são utilizados para autenticação mútua TLS, garantindo validação de identidade e comunicação criptografada. Preencha os campos:

Nome da Secret
Certificado: arraste e solte os arquivos.
Chave Privada (Opcional): arraste e solte os arquivos. Suporta apenas arquivos .key.
Data de Expiração: preenchida automaticamente ao adicionar o certificado.

5. Chave/Valor (Key/Value). Preencha os campos:

Nome da Secret
Método de Cadastro: escolha entre adicionar um arquivo ou inserir manualmente (adicione a chave e o valor).
Data de Expiração (Opcional)

Passo 6. Clique no botão 'Cadastrar Secret';

Passo 7. Após o cadastro, confira sua Secret na tela de listagem. Você poderá visualizar informações como:

Tipo de Credencial
Data de Criação
Data de Expiração
Status da Secret

Como editar uma Secret

Atenção!

Certifique-se de copiar e salvar as informações da Secret ao cadastrá-la, pois alguns dados podem não ser exibidos novamente.
Utilize a funcionalidade de edição para verificar onde a Secret está sendo utilizada antes de realizar alterações ou exclusões.

Você pode editar uma Secret cadastrada seguindo os passos a seguir:

Passo 1. No Portal da StackSpot, vá até a seção 'Secrets';

Passo 2. Clique no botão 'Mais Opções' ao lado da Secret que deseja editar;

Passo 3. Clique no botão 'Editar' para editar a secret. Preencha os campos necessários:

Novo Nome do Header
Novo Valor
Data de Expiração (Opcional)

Como desativar ou excluir uma Secret

Desativar uma Secret

Quando uma Secret é desativada no nível perfil pessoal, ela se torna indisponível para uso. Se você tentar utilizar Aplicações ou recursos que dependem dessa Secret, uma mensagem de erro será exibida.

Para desativar, siga as instruções a seguir:

Na seção 'Secrets', clique no botão 'Mais Opções';
Clique no botão 'Desativar'.

Você pode reativar a Secret, se necessário.

Excluir uma Secret