API Keys

Overview

To ensure that only authorized users can access sensitive data or perform specific actions using the Onum API, you need to use an API key to generate the required authorization token. This article explains how to create API keys in your tenant.

Click your user icon in the bottom left of the application and select Organization settings. You'll see the API Keys section under the Tenant group.

Create an API Key

Follow these steps to create an API key in your tenant:

1

Access the API Keys area and click Create API Key.

2

In the window that appears, enter the API key Name, an optional Description, and an Expiration date. This is the date you want the token to expire. Choose one of the default dates, or click Custom to set a specific one. You can also select No expiration if you don't want your tokens to expire.

3

Click Create API Key when you're done. The API key will appear so that you can copy it. Remember to copy it here as it will not be visible again.

4

Click Done, and you'll see your API key in the list of the API Keys area.

Authorize your API Requests

Once you have generated an API Key, you can start using the Onum API. With an API key, you'll be able to generate the token required to authorize your API requests. When you request a token, you can indicate the required expiration time in the request (between 30 and 3600 seconds).

Remove an API Key

To remove an API key from your tenant, simply click the ellipsis menu of the required key and select Remove. This will remove the API key permanently, and users won't be able to authorize their API requests using it anymore, so proceed with caution.