Aura App API Keys

Aura App API keys allow you to programmatically interact with your Aura environment. These keys are used to authenticate requests to Aura App APIs, which enables automation, integration with CI/CD pipelines, and secure service-to-service communication. An Aura App API key can be created for and used to access any Aura App, such as Cloud Functions and Dashboard Apps. The API key is unique and only enables access to the Aura App for which it is created.

Create an Aura App API Key

To create an API key, perform the following steps:

In the Cloud Portal, under the Develop section, navigate to an Aura App.
Select an App instance. An example with a Cloud Function App is demonstrated.
Select View API Keys in the upper right corner.
Select Create API Key.
In the Create API key for <Aura_App> - <Aura_App_name> dialog,
1. Enter the name in the API Key Name field.
2. In Expiration, select the expiration date.
3. Select Create API Key.
Once the API key is generated, select Copy API Key to copy it or Save As Secret to store it securely in Secrets. The API key is displayed only once.
If Save As Secret is selected:
1. In the New Secret dialog, enter the name for the secret in the Name field.
2. Select Create Secret. The API key is stored in a secret.
Select Close.

Types of Aura App API Keys

There are two types of Aura App API keys:

Active API key: An API key that is currently valid, associated with an existing App instance or user, and has not been revoked. It can successfully authenticate requests to the Aura App APIs.
Orphaned API key: An API key that is not associated with an existing App instance, as the App or user that created it, was deleted. Orphaned keys are inactive and cannot be used to authenticate API requests.

Note

Orphaned API keys pose a potential security risk and should be identified and revoked promptly.

Manage an Aura App API Key

You can manage an Aura App API key in two ways:

Using the App instance
Using the Aura App interface

Using the App Instance

Navigate to the Aura App.
Under the Name column, select the App instance for which you want to manage the Aura App API key.
Select View API Keys in the upper right corner. You can view the total number of API keys for the App instance on the View API Keys button.
To revoke an active or orphaned Aura App API key, perform the following tasks:
1. Revoke an Active Aura App API key:
  1. Navigate to the Active tab.
  2. Select the delete icon under the Actions column next to your API key.
  3. In the Revoke API key dialog, enable the agreement and select Revoke.
2. Revoke an Orphaned Aura App API key:
  1. Navigate to the Orphaned tab.
  2. Select the delete icon under the Actions column next to your API key.
  3. In the Revoke API key dialog, enable the agreement and select Revoke.
    
    Note
    
    Orphaned keys can only be revoked by the Aura Owner or Owner of the organization.

Using the Aura App interface

Navigate to the Aura App.
Select View API Keys in the upper right corner.
To revoke an active or orphaned Aura App API key, perform the following tasks:
1. Revoke an Active Aura App API key:
  1. Navigate to the Active tab.
  2. Select the delete icon under the Actions column next to your API key.
  3. In the Revoke API key dialog, enable the agreement and select Revoke.
2. Revoke an Orphaned Aura App API key:
  1. Navigate to the Orphaned tab.
  2. Select the delete icon under the Actions column next to your API key.
  3. In the Revoke API key dialog, check the agreement and select Revoke.
    
    Note
    
    Orphaned keys can only be revoked by Aura Owner or Owner of the organization.