Skip to main content
Version: v2 ⚡

Manage Credentials

You can view the Credentials related to a Project under the Project Settings > Credentials page. In this article, you'll learn how to manage your credentials related to a project.

View all Project Credentials​

Via this Credentials page, you can see a list of all Credentials, including the name, type, and owner, and whether they are for a production environment.

Credentials Overview

Viewing credential secrets

All Project Collaborators can view the credential name, type, and owner, but only the Credential Owner can view the credential secrets (username, password, etc.).

Create a new Credential​

  1. Click on the New Credential button, and choose the type of app you want to connect.
  2. If your app is not listed, choose "Raw JSON" to create your own custom credential or "configuration" input. For example:
{ "loginUrl": "https://random-app.com", "username": "test", "password": "pwd" }

Credential Type

  1. Click Configure Credentials and add the authentication details for your app. The credential form will indicate which fields are required.

Add Credential

Not sure how to fill in all credential details?

While creating a new credential form, if you're not sure what some of these fields require (e.g., "security token"), then head over to the relevant Adaptors docs page to learn more and read about the "configuration schema" or ask on Community.

  1. Click Save and you'll see it listed in your Credentials page. You can now use it across the Project when building and running Workflows.

New Credential Ready

Share Credentials​

If you own a Credential, you can choose which Project has access to it. To update which Projects your Credential is shared with, follow the steps on the User Credentials docs page.

Raw JSON Credentials​

Raw credentials are valid JSON documents which are passed into a job's runtime state. Note that owners of these credentials will be able to view them, in their entirety, in the clear.

Raw credentials will work with any adaptor, so long as that adaptor's required configuration keys (e.g., baseUrl) are specified in your credential. See the "configuration schema" docs for each adaptor to see what is required for that app.

Use Raw JSON to specify custom credential inputs

Use the Raw JSON credential type if you would like to store secrets that are not standard inputs in an adaptor's credential form. For example, if my REST API requires a client_id instead of a username, then my configuration schema might look like the below code snippet. Because client_id isn't an option in the default Http credential form, I can create my own custom credential using the Raw JSON type.

Example Raw JSON credential body or configuration:

{
  "baseUrl": "https://myapp.com/api",
  "client_id": "test-j01",
  "password": "testing123",
  "customInput": "whateverYouWant"
}