Credentials 

Overview

Credentials allow you to connect to external sources (e.g. Databases, Salesforce, Google) in order to successfully execute job runs in Platform, such as imports, exports, and scripts. The credentials index page will show a menu of all of the credentials that you have access to use in Civis Platform.

How to access the Credentials page:

1. Navigate to the Admin drop-down via the top navigation bar in Civis Platform.
2. Click on Credentials.

 

Create Credential

1. To add a new credential, click the Create Credential button at the top-right of the screen.
2. Enter the following information for the credential:

• Name: Display name for the credential
• Credential Type: The service that the credential allows you to access. If you do not see the service named on the dropdown list, select "Custom".
• Username: the username associated with the account.
• Password: the password associated with the account.
• Description (optional): a description of what this credential is used for.
• Owner: Defaults to your Civis Platform user account. 
• Remote Host: A remote host selection is required for a database credential. For all other credential types, leave this field blank unless otherwise specified.

3. Click Save to create the credential or Cancel to disregard the changes.

Edit Credential

Credentials may only be edited by the user who created the credential or by someone with at least edit permissions on the credential as well as manage permissions on the user who created the credential.

1. Navigate to the credential detail page by selecting a credential on the index page.
2. Go to the standard action menu on the top-right of the detail page and select Edit Credential.
3. Edit any of the following parameters:
• Name: Display name for the credential
• Credential Type: The service that the credential allows you to access. If you do not see the service named on the dropdown list, select "Custom".
• Username: the username associated with the account.
• Password: the password associated with the account.
• Description (optional): a description of what this credential is used for.
• Owner: Defaults to your Civis Platform user account. 
• Remote Host: A remote host selection is required for a database credential. For all other credential types, leave this field blank unless otherwise specified.
4. Click Save to create the credential or Cancel to disregard the changes.

Share Credential

1. Navigate to the credential detail page by selecting a credential on the index page.
2. Go to the standard action menu on the top-right of the detail page and select Share.
3. In the search bar, type in the name of the user/group to share the credential with.
4. Specify the permission level for the user/group (i.e. viewer, editor, manager). For more details, refer to sharing permissions levels.
5. (Optional) Check the Notify People box if you’d like to send the user/group an email notification.
6. Click Add.
7.  Click Save to share the credential or Cancel to disregard the changes.

 

Delete Credential

1. Navigate to the credential detail page by selecting a credential on the index page.
2. Go to the standard action menu on the top-right of the detail page and select Delete Credential.
• Note: You must be the owner of a credential or be shared as a manager in order to delete a credential. Deleting a credential will affect any active workloads that depend on it. In addition, any users shared on the credential will no longer have access to it.
3. Select Delete within the confirmation modal.

 

Setting up credentials for specific services

• • Facebook
  • Google Analytics
  • Salesforce

Default Credentials

When your account is created in Civis Platform, a database credential is automatically created. We refer to this credential as your default credential -- it can be edited, but not deleted, and can be used to access the database that Civis Platform is hosting for your organization (ie, Redshift or Postgres).

For example, the screenshot below shows five different credentials. One of them has the "default" tag beside its "Type" field, and no remote host listed below. This is a default credential.

The default credential is most useful for cases in which you have multiple databases hosted in Civis Platform. For example, your Civis instance may have one Redshift database and one PostgreSQL database. In this case, you don't have to maintain credentials for each individual database user because the credential is not attached to any specific Remote Host.

To prevent breakages, you should avoid making changes to the default credential. If you need to update the password for your default credential, you can always do so from the My Profile page in Civis Platform.

Database Default Credentials

If you've integrated your own database with Civis Platform, in addition to or instead of using a Civis-hosted database, you may find it beneficial to create a new default credential specifically for that database. This will allow you to manage credentials for the database independently of any other database. 

Once a Database type credential has been marked as a default, it will be used automatically when interacting with its respective database. You may designate up to one default credential per remote host. Similar to default credentials mentioned above, database default credentials cannot be deleted, but they can be edited. Database default credentials are also denoted by a ‘Default’ tag beside the ‘Type’ field, and their associated database will be shown directly below.

 

 

To toggle the default status of an existing database credential or create a new database default credential, click on the ‘Default Credential’ checkbox in the credential modal: