Skip to content

Credentials

Exposing sensitive data directly in an automation's code is not a good practice.

The Credentials menu allows you to securely store restricted data, such as passwords, logins, emails, or any other sensitive information used in your automations.

Snippet Generator

When accessing a credential, explore the Snippet Generator button to get code examples that make it easier to handle credentials, and learn how to create a credential and retrieve a credential via code.

The generated snippets are available in Python, Java, JavaScript, and TypeScript.

Snippet Generator icon of the BotCity Orchestrator.

View Credentials

On this screen, you can view the credentials summary in the following card:

  • Total Credentials: total number of credentials created.

Below the summary, you can view the credentials in a list with the following columns:

  • Label: the credential's identifier.
  • Date: the credential's creation date.
  • Repository: the repository the credential is associated with.
  • Actions: actions menu available for each credential:

Screenshot of the BotCity Orchestrator, showing the Credentials menu. The page has the title 'Credentials', the menu description with the 'See more' link, and the 'New Credential' button in the top right corner. Below, the 'Filter by' and 'Order by' filters, the 'Total credentials' card with the total count, and the credentials list with the columns Label, Date, and Repository, plus an actions menu for each credential.

Create credential

To create a new credential store, go to the Credentials menu and click the + New Credential button.

Fill in the fields:

  • Label: unique identifier for the credential store.
  • Repository: select the repository where the credential is located.
  • Secrets: section for adding the credential's keys and values:
    • + Add: button to add a new key.
    • Key: the key's identifier.
    • Value: the value corresponding to the key, with an option to show or hide the content.
    • Trash icon: removes the added key.

Once the fields are filled in, click Create to finish.

Screenshot of the BotCity Orchestrator, showing the form for creating a new credential. The page displays the Basic Information section, with the Label and Repository fields, and the Secrets section, with the Key and Value fields, the button to add a new secret, and the trash icon to remove it. At the bottom, the Cancel and Create buttons.

Edit credential

You can edit an existing credential by accessing its options menu in the list or by clicking its Label to access the details. You can change:

  • Repository: change the repository the credential is located in.
  • Secrets: change, add, or remove keys and values.

Irreversible action

Once the changes are saved, this action cannot be undone.

If keys are changed, they must also be updated in the code.

Delete Credential

Credentials can be deleted at any time, through the actions menu of each credential in the list.

Permanent deletion

The deletion action is permanent and cannot be undone.

GIF of the BotCity Orchestrator, showing the Credentials menu. The user opens the actions menu of a credential in the list, selects the delete option, and confirms the deletion in a confirmation window.

Move to repository

You can move a credential to another repository at any time, through the actions menu of the credential in the list.

Select the Move to repository option, choose the destination repository, and confirm the move.

GIF of the BotCity Orchestrator, showing the Credentials menu. The user opens the actions menu of a credential in the list and selects the option to move the credential to another repository.

Search and Filters

You can combine search and filters to find credentials according to your needs.

Available filters:

  • Name: selects a specific credential.
  • Repository: selects a specific repository.

Sorting:

  • Newest first
  • Oldest first
  • Alphabetically

Next to the filters, you'll also find Bulk Actions, which allow you to:

  • Bulk delete credentials: permanently deletes the selected credentials.
  • Bulk move to repository: moves all selected credentials to a specific repository.