Accounts
Learn more about accounts and how they are used to safely manage credentials on the Digibee Integration Platform.
Overview
Accounts provide a secure way to store sensitive information, such as passwords, private keys, and authentication tokens, without exposing these credentials directly in your integrations. By encrypting and centrally managing credentials, accounts help ensure the security of authentication processes.
Furthermore, accounts can be restricted to specific projects, ensuring that sensitive information is only accessible where it is needed. They can then be used in connectors within pipelines and capsules to authenticate and authorize access to external endpoints.
Managing accounts
You can access the Accounts page from the Build page, by clicking the Accounts tab, or by clicking the Digibee logo in the upper-left corner, selecting Settings, and then finding the Accounts page.
The Accounts list shows the Account Name, Account Type, Description, Expiration Date, and Running Pipelines for each account, and can be filtered by Account Type, Deprecated status, and Expiration status (Expired or Expiring soon).
Creating an account
On the Accounts page, click Create new and fill in the fields:
Account name
A unique identifier for the account.
Account type
The type of account. Choose from the available options.
Description
Additional information about the account.
Project Availability
Defines whether the account is available to all projects or only selected ones. On the Accounts listing page, you only see accounts available to all projects or to ones you have access to.
Expiration date
Sets an expiration date for the account as a reminder: it only stops working in the pipelines if this date matches the actual expiration on the external service, in which case you'll need to update the credentials and redeploy.
Enter the date in DD/MM/YYYY format (for example, 30/05/2030). Accounts near expiration show Expires in DD/MM, and expired ones show Expired. Optional; applies only to OAuth Bearer, Private Key, Public Key, OAuth 2, Certificate Chain, Google Key, AWS V4.
Environment configuration
Credentials required for the selected account type. See below how to configure each account type.
Accounts can be permanently removed from pipelines
An Account is removed from a pipeline if it becomes unavailable in the pipeline's project: when the pipeline is moved to a project where the account isn't allowed, or when the pipeline's project is removed from the account's list of allowed projects in its Project Availability setting.
Once removed, moving the pipeline back or re-allowing the project will not restore it, for security reasons. You'll need to manually add the Account back to the pipeline.
Then click Save to create the account.
Configuring each account type
Editing an account
To edit an account, go to the Accounts list and click the row of the account you want to edit.
You can:
Update the description.
Mark the account as deprecated. Learn more about deprecating an account.
Define new rules for Project Availability.
Update credentials for all environments. Sensitive credentials won't be visible, but you can add new ones.
View all pipelines that use the account. If you edit the account, any deployed pipelines must be redeployed to apply the changes.
After editing the account, click Save. A confirmation window appears, and you must click Edit to confirm the changes.
All changes are applied immediately to pipelines that use the account and have not yet been deployed. For deployed pipelines, we recommend redeploying them after editing the account to prevent issues and keep the pipelines up to date.
Deprecating an account
Deprecating an account makes it unavailable for new pipelines or new pipeline versions. Existing deployments will keep working unless redeployed.
To deprecate an account:
In the Accounts list, click the row of the account you want to deprecate.
Enable the Deprecated toggle.
Click Save.
This action is irreversible.
Deleting an account
Deleting an account permanently removes it from the Platform. You cannot delete accounts that are currently used in pipelines, whether deployed or not. To proceed, remove or replace the account in all pipelines before deleting it.
To delete an account:
In the Accounts list, click the three dots of the account you want to delete.
Select Delete.
Confirm the action in the pop-up window.
This action is irreversible.
Using accounts
Accounts provide secure access to external services within pipelines and capsules, through connectors that support the Account field. When a connector requires one, this field appears in its configuration form so you can select the appropriate account for that integration.
Last updated
Was this helpful?