Ir para o conteúdo

Credenciais

As Credenciais podem armazenar dados sensiveis de forma segura que podem ser utilizados em tempo de execução de automações, sem risco de manter dados expostos diretamente no código.

Esses dados são armazenados em cofres, cada cofre pode conter inumeras chaves.

Orquestrador BotCity

Você pode utilizar a funcionalidade de Credenciais diretamente na plataforma do Orquestrador BotCity.

Veja mais em:

Criar cofres de credenciais

Além da ação pela interface do Orquestrador BotCity, os cofres de credenciais podem ser criadas também via SDK.

Os valores armazenados ficam criptografados e só podem retornar para usuários autorizados.

Você precisa das seguintes informações:

  • Label: Identificador do cofre de credenciais.
  • Chave: Identificador da chave.
  • Valor: Valor correspondente à chave.

Criar mais chaves

Para criar mais chaves para o mesmo cofre, mantenha a identificação do Label e adicione Chave e Valor diferentes.

Exemplo de criação:

maestro.create_credential(label="vault", key="key1", value="key_value_1")
maestro.create_credential(label="vault", key="key2", value="key_value_2")
maestro.createCredential("vault", "key1", "key_value_1");
maestro.createCredential("vault", "key2", "key_value_2");
await maestro.createCredential("vault", "key1", "key_value_1")
await maestro.createCredential("vault", "key2", "key_value_2")
await maestro.createCredential("vault", "key1", "key_value_1")
await maestro.createCredential("vault", "key2", "key_value_2")
await maestro.CreateCredentialAsync("vault", "key1", "key_value_1");
await maestro.CreateCredentialAsync("vault", "key2", "key_value_2");

Obter credencial do Orquestrador

Para utilizar os valores armazenados nas credenciais diretamente no código, você precisa das seguintes informações:

  • Label: Identificador do cofre de credenciais.
  • Chave: Identificador da chave.

Retorno

O retorno do método serão os valores armazenados correspondentes ao cofre e chave escolhidas. Somente usuários com permissão de acesso à credencial podem retornar o valor.

Exemplo de uso:

key1 = maestro.get_credential(label="vault", key="key1")
String key1 = maestro.getCredential("vault", "key1");
const key1 = await maestro.getCredential("vault", "key1")
const key1: string = await maestro.getCredential("vault", "key1")
string key1 = await maestro.GetCredentialAsync("vault", "key1");

Atualizar valores

Você pode fazer a atualização dos valores armazenados nos cofres existentes tanto diretamente pela interface do Orquestrador BotCity quanto via SDK.

Você precisa das seguintes informações:

  • Label: Identificador do cofre de credenciais.
  • Chave: Identificador da chave.
  • Valor: Valor correspondente à chave.

Atenção!

Esta operação altera o valor da chave cadastrada e não poderá ser revertido.

Exemplo de atualização de valor:

maestro.update_credential(label="vault", key="key1", new_value="new_key_value_1")
// Ainda não implementado
// Ainda não implementado
// Ainda não implementado
// Ainda não implementado

Remover chave de credencial no Orquestrador

Você pode remover as chaves que não serão mais utilizadas do cofre de credenciais, essa ação pode ser feita diretamente pela interface do Orquestrador BotCity e também via SDK.

Você precisa das seguintes informações:

  • Label: Identificador do cofre de credenciais.
  • Chave: Identificador da chave.

Atenção!

Esta operação exclui o valor da chave cadastrada e não poderá ser revertido.

Exemplo de exclusão de chave:

maestro.remove_credential(label="vault", key="key1")
// Ainda não implementado
// Ainda não implementado
// Ainda não implementado
// Ainda não implementado