> For the complete documentation index, see [llms.txt](https://wiki.datadike.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.datadike.com/pt/sonar/administration/settings/key-store.md).

# Repositório de chaves

Settings › Key Store guarda valores nomeados, como uma URL de download ou o nome de uma conta de serviço, que scripts, ações de URL e webhooks leem pelo nome em vez de repeti-los.

## O que é e quando usar

O repositório de chaves é uma lista global de valores nomeados. Um argumento de script, uma variável de ambiente de script, uma ação de URL ou um webhook se refere a um valor pelo nome, com `{{global.NAME}}`, e o SONAR coloca o valor no lugar quando o script ou a ação é executado.

Use-o para qualquer valor que muitos scripts compartilhem e que possa mudar: uma URL de download, o endereço de um serviço interno, um identificador de locatário, o nome de uma conta de serviço. Quando o valor muda, você edita uma única chave, e todos os scripts e ações que se referem a ela passam a usar o novo valor na execução seguinte.

O repositório de chaves é global: as chaves dele são as mesmas para todos os clientes e sites.

## Antes de começar

* Seu papel precisa de **View Core Settings** para abrir **Settings**, de **View Global Keystore** para ver as chaves e de **Edit Global Keystore** para adicioná-las, editá-las ou excluí-las (grupos **Settings** e **Security** em **Admin Center › Roles**).
* Qualquer pessoa cujo papel tenha **View Global Keystore** pode exibir os valores com **Show values**. Guarde nele apenas o que esses usuários podem ler.

## Passos

### Adicionar uma chave

1. Abra **Admin Center › Settings** e a aba **Key Store**.
2. Clique em **Add key**.
3. Em **Add Global Key**, digite o **Name**, por exemplo `API_BASE`.
4. Digite o **Value**. O ícone de olho mostra o que você digita.
5. Clique em **Submit**.

### Usar uma chave

Digite `{{global.NAME}}` onde o valor deve entrar:

* em um argumento ou uma variável de ambiente de script, ao executar um script em um dispositivo, em uma ação em massa, em uma tarefa automatizada ou em uma ação de modelo de alerta;
* na URL de uma ação de URL; veja [Ações de URL](https://wiki.datadike.com/pt/sonar/administration/settings/url-actions.md);
* na URL, nos cabeçalhos ou no corpo de um webhook; veja [Webhooks](https://wiki.datadike.com/pt/sonar/administration/settings/webhooks.md).

Por exemplo, com uma chave `API_BASE` cujo valor é `https://api.example.com`, o argumento `-Url {{global.API_BASE}}` chega a um script PowerShell como `-Url 'https://api.example.com'`. As regras de uso de aspas e as demais variáveis estão em [Variáveis de script](https://wiki.datadike.com/pt/sonar/reference/script-variables.md).

### Editar ou excluir uma chave

1. Clique duas vezes na chave para abrir **Edit Global Key**, altere o **Name** ou o **Value** e clique em **Submit**.
2. Para excluí-la, clique na chave com o botão direito, escolha **Delete** e confirme com **Delete** em **Delete key: NAME?**.

As alterações valem a partir da próxima execução de cada script ou ação. Os scripts e ações que ainda se referem a uma chave excluída ou renomeada deixam de receber o valor dela.

## O que você deve ver

O quadro **Global Key Store** lista cada chave com o **Name** e o **Value** oculto como `****`. **Show values** exibe os valores e **Hide values** volta a ocultá-los. Sem nenhuma chave, a tabela mostra **No Keys added yet**.

Adicionar, editar e excluir uma chave exibem **Key was added!**, **Key was edited!** e **Key NAME was deleted!**.

## Como verificar se funcionou

1. Crie um script de teste que imprima o primeiro argumento, por exemplo `Write-Output $args[0]` em PowerShell; veja [Biblioteca de scripts](https://wiki.datadike.com/pt/sonar/administration/automation/scripts.md).
2. Execute-o em um dispositivo de teste com o argumento `{{global.NAME}}`, aguardando a saída; veja [Executar um comando ou um script em um dispositivo](https://wiki.datadike.com/pt/sonar/administration/automation/run-commands-and-scripts.md).
3. A saída precisa mostrar o valor da chave, e não o texto `{{global.NAME}}`.
4. Em **Reports & Audits › Audits**, uma entrada **Add Object** ou **Modify Object** cuja mensagem cita a chave registra quem a alterou; veja [Trilha de auditoria](https://wiki.datadike.com/pt/sonar/administration/audit/audit-trail.md).

## Erros comuns

| Sintoma                                                      | Causa                                                                  | Correção                                                               |
| ------------------------------------------------------------ | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
| O script recebe `{{global.NAME}}` como texto                 | Nenhuma chave tem exatamente esse nome                                 | Confira a grafia e as maiúsculas e minúsculas do nome em **Key Store** |
| **Failed to add key** com uma mensagem sobre o tamanho       | **Name** tem mais de 25 caracteres                                     | Use um nome mais curto                                                 |
| **\*Required** sob **Name** ou **Value**                     | O campo está vazio                                                     | Preencha os dois campos                                                |
| **Failed to load key store**                                 | O papel não tem **View Global Keystore**                               | Conceda essa permissão em **Admin Center › Roles**                     |
| **Add key** falha para um usuário que consegue ver as chaves | O papel tem **View Global Keystore**, mas não **Edit Global Keystore** | Conceda **Edit Global Keystore**                                       |
| Um script recebe o valor errado                              | Duas chaves têm o mesmo nome                                           | Mantenha cada nome único; renomeie ou exclua a duplicada               |

## Referência de campos

| Campo     | O que faz                             | Valores aceitos                                                                                       | Padrão |
| --------- | ------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------ |
| **Name**  | O nome usado em `{{global.NAME}}`     | Até 25 caracteres. Use letras, dígitos, sublinhados e hífens, e mantenha cada nome único. Obrigatório | Vazio  |
| **Value** | O texto colocado no lugar da variável | Qualquer texto. Obrigatório                                                                           | Vazio  |

## Páginas relacionadas

* [Variáveis de script](https://wiki.datadike.com/pt/sonar/reference/script-variables.md): todas as variáveis que os scripts podem usar, e como os valores são postos entre aspas
* [Biblioteca de scripts](https://wiki.datadike.com/pt/sonar/administration/automation/scripts.md): scripts que recebem argumentos
* [Ações de URL](https://wiki.datadike.com/pt/sonar/administration/settings/url-actions.md): links que podem incluir valores do repositório de chaves
* [Webhooks](https://wiki.datadike.com/pt/sonar/administration/settings/webhooks.md): requisições que podem incluir valores do repositório de chaves
* [Papéis e permissões](https://wiki.datadike.com/pt/sonar/administration/identities/roles.md): **View Global Keystore** e **Edit Global Keystore**
