Portal Applications
A Portal Application is the record created by a Portal account/developer to subscribe to API products and obtain API keys. This page describes managing Portal Applications from the Identity menu.
Portal Applications can be reached from two different menus:
- Identity > Applications: A view focused on the credential/API key side of applications. This view does not show API product/plan information.
- Portal > Applications: The same records in the context of Portal management; API product subscriptions are also shown here.
Both menus lead to the same application records; the creation, editing, deletion, and metadata operations described below apply to both views.
Application List
The list shows the application name, the linked account/developer, organization, creation date, and reference id. Clicking an application in the list opens its detail page.
Creating / Editing an Application
Use the Create button above the list to create a new application. Use the Edit option in the row actions menu to edit an existing application.
| Field | Description |
|---|---|
| Name | The name of the application. Required. |
| Reference Id | A reference value used to uniquely identify the application in external systems. It is generated automatically when the application is created and can be changed manually if needed. Required. |
| Description | A description of the application. |
| Account | The Portal account/developer the application belongs to. Required. |
Application Detail
The application detail page has two tabs: Overview and Metadata.
Overview
This tab shows the application's name, reference id, linked account/developer, organization, and creation date. It also lists the API keys defined for the application: the key itself, its enabled/disabled state, its creation date, and its expiration date (if any). From the edit screen you can generate a new API key for the application or revoke an existing one.
The view opened from the Portal menu additionally lists the API Products the application is subscribed to, along with their plan/approval status. This information is not shown in the view opened from the Identity menu.
Metadata
This tab lets you define application-specific key-value entries. Complex data types are not supported; only plain text values can be entered.
| Field | Description |
|---|---|
| Key | The key of the metadata entry. Required, and unique within the application; the same key cannot be used more than once. |
| Value | The value corresponding to the key. |
| Secret | When enabled, the value is stored encrypted and masked in lists. |
Use the + button at the start of a row to add a new entry, and the delete button at the end of a row to remove one. Changes are applied with the Save button.
Deleting an Application
When an application is deleted, its API keys and subscription records are removed along with it. Deletion is confirmed with a confirmation dialog.
Creating, editing, and deleting applications is available to roles with system administrator or portal management/developer authority.
Related Pages
For the credentials granted access to the application and their API Proxy-based access settings, see Access Control. For the credential records of the account the application belongs to, see Credentials.