Experience Center
About API Key Management
An API key is required in order to access the publicly available set of Private Applications APIs. An API key consists of a client ID and a client secret. Both are required for authentication prior to accessing the publicly available set of Private Applications APIs.
Generating an API key only occurs in the Admin Portal from the API Keys page. Client IDs are always accessible from the page. Client secrets are only displayed when the key is first created, and they are not available in the saved configuration.
API keys provide the following benefits and enable you to:
- Authenticate and access the Private Applications APIs.
- Generate the Client ID and Client Secret used to access the Private Applications APIs.
About the API Keys Page
On the API Keys page (Administration > API Configuration > Legacy API > Private Access API), you can do the following:
- Copy your customer ID. The customer ID is needed for making API calls.
Copy your Microtenant ID. The Microtenant ID is the unique identifier of the Microtenant, and is needed for making API calls if you're within a Microtenant.
The Copy Microtenant Id action is only visible if you are within a Microtenant. If you are within a Microtenant, then you must pass the
microtenantIdwhen making an API call.- Add an API key.
- Refresh the API Keys page to reflect the most current information.
Go to the Private Applications API Portal.
The URL for the Private Applications API Portal differs depending on your organization’s assigned cloud.
- Filter the information that appears in the table. By default, no filters are applied.
- View a list of API keys. For each key, you can see the following:
- Name: The name of the API key.
- Client ID: The ID for the key. It is needed to access the Private Applications API Portal.
- Status: Indicates whether the key is enabled or disabled.
- Session Validity Interval (In Seconds): The amount of time in seconds that the key remains active before expiring.
- Creation Date: The date and time the API key was created.
- Copy a client ID.
- Edit an API key.
- Delete a key.
- Unlock a locked API client.
Locking occurs automatically after three unsuccessful attempts at API access and persists for 30 minutes.
