Skip to content

Credentials

Credentials can securely store sensitive data that can be used at automation runtime, without the risk of keeping data exposed directly in the code.

This data is stored in vaults, and each vault can contain numerous keys.

BotCity Orchestrator

You can use the Credentials functionality directly on the BotCity Orchestrator platform.

See more at:

Create credential vaults

In addition to the action through the BotCity Orchestrator interface, credential vaults can also be created via SDK.

The stored values are encrypted and can only be returned to authorized users.

You need the following information:

  • Label: Identifier of the credential vault.
  • Key: Identifier of the key.
  • Value: Value corresponding to the key.

Creating more keys

To create more keys for the same vault, keep the same Label identifier and add different Key and Value pairs.

Creation example:

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");

Get credential from the Orchestrator

To use the values stored in credentials directly in the code, you need the following information:

  • Label: Identifier of the credential vault.
  • Key: Identifier of the key.

Return

The method return will be the stored values corresponding to the chosen vault and key. Only users with access permission to the credential can return the value.

Usage example:

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");

Update values

You can update the values stored in existing vaults either directly through the BotCity Orchestrator interface or via SDK.

You need the following information:

  • Label: Identifier of the credential vault.
  • Key: Identifier of the key.
  • Value: Value corresponding to the key.

Attention!

This operation changes the value of the registered key and cannot be undone.

Value update example:

maestro.update_credential(label="vault", key="key1", new_value="new_key_value_1")

// Not yet implemented

// Not yet implemented

// Not yet implemented

// Not yet implemented

Remove a credential key from the Orchestrator

You can remove keys that will no longer be used from the credential vault. This action can be performed directly through the BotCity Orchestrator interface and also via SDK.

You need the following information:

  • Label: Identifier of the credential vault.
  • Key: Identifier of the key.

Attention!

This operation deletes the value of the registered key and cannot be undone.

Key deletion example:

maestro.remove_credential(label="vault", key="key1")

// Not yet implemented

// Not yet implemented

// Not yet implemented

// Not yet implemented