Generate a Tenant API Key

We recommend that you use the sandbox environment for accessing the Tenant portal, if you are trying to generate an API Key for the first time.

Whenever you see the term API Key across Duck Creek Payments Orchestrator, it will always refer to a combination of Public and Private Keys. Both types of keys are tied to your identity. Within the Payments Orchestrator application, you will find two sets of API Keys: Account API Keys and Tenant API Keys.

This guide will walk you through the process of generating a Tenant API Key.

Before you Start

Before you start following this guide, you should have access to your Tenant.

What is an API Key Used For?

An API Key has multiple uses within the Payments Orchestrator application but it is mainly used for two purposes:

Verifying the identity of the Key bearer when trying to access Payments Orchestrator APIs
Generating an HMAC Token

See this article on key-based cryptography to learn more about how they work.

How to Generate a Tenant API Key?

For security reasons, you will only are able shown your Private Key once, at the end of this process. Keep it safe as you won't be able to retrieve or restore it again. Do not share it with anyone.

Login to your Tenant Portal.
Click API Keys under Developers menu from the left-sidebar. The API keys page appears.
Click the button on the top-right corner of the page. The Add API key page appears
Fill the available fields in the page with relevant information.

Field	Description	Example
Name	Enter a unique name for the API Key.	Tenant Admin
Roles	Select one (or more) role(s) that will apply to the Key bearer. See the table in Concept: Tenant API Key for more information about each role.	`tenant-admin`

Click the Save button at the bottom of the page.
A new page appears with your newly created API Key. Copy both, Public and Private, Keys and keep them safe.
Click the Okay button to return back to the API keys page.

Troubleshooting

I can't access my Private Key.

For security reasons, a Private Key is only shown once at the end of API Key generation process. If you have lost access to the Key, request your Tenant Administrator to remove your API Key and create a new one.

How do I change the role assigned to an API Key?

Permission to change the roles assigned to an API Key is limited to the Tenant Administrator.

You can change the role assigned to an API Key through API Keys page. Go to the API Keys page and click the Edit button next to the API Key, which you want a new role assigned to.

How do I remove an API Key?

Permission to remove an API Key is limited to the Tenant Administrator.

You can delete an API Key through API Keys page. Goto the API Keys page and click the Delete button next to the API Key, which you want removed.

I can't see my API Key in API Keys page.

There could be multiple reasons why you can't see your API Key.

Ensure you have the right access. Only Tenant Administrators can view API Keys.
Try using the pagination control at the bottom of the API Keys page to locate your API Keys.
Use the filter options available on the top of the API Keys page to locate your API Keys.

If you have tried all of these measures and still couldn't locate the Keys, contact your Implementation Manager or Account Manager.