Manage APIs - Summary View

Manage APIs - Summary View

Upon successfully creating a new API, the user is redirected to the API Summary Page, which defaults to the Overview tab. This summary view provides a centralized location for managing various aspects of the API including configuration, grant types, subscriptions and scopes.

Overview Tab

The Overview tab displays key information about the API and allows for managing secrets and deleting the application.

• Application Name: The name of the API.
• Client Id: A unique identifier for the API application.
• Client Secret: A secret key used for authentication. Users with a created user or administrator role can manage secrets.
• Delete Application: The application can be deleted only if it meets the following conditions:
  1. No versions exist for the API.
  2. No subscriptions exist for the API Application.

API Configuration Tab

The API Configuration tab is used to manage API versions, deployments and specifications.

• Version Management:
  • For APIs with existing versions, the most recently created version is selected by default.
  • For newly created APIs, a view with a + Add New Version button is displayed. Clicking this button allows users to create a new version, subject to their role permissions Permission Matrix.
• Deployment: After creating a version, publishers can add deployments, configure deployment settings, and upload API specifications.
• API Specification: A section is provided to upload an API specification file.

Grant Types Tab

This tab allows you to configure the application’s grant types.

• Configurable Grant Types: This includes various grant types such as Authorization Code Grant, Client Credentials Grant, Device Code, Use Refresh Tokens and Token Exchange.
• Authorization Code Grant: When configuring this grant type, you can also specify callback and logout URLs.

Subscriptions Tab

The Subscriptions tab is dedicated to managing the subscriptions associated with the selected API Application. Here, you can view existing subscriptions and manage them.

Scopes Tab

The Scopes tab is where the scopes of the API application are configured.

• Default Scope: For any new API application, a default scope is automatically created using the provided ApplicationId/Scope Prefix as the scope name.
• Scope Configuration: You can define new scopes and configure details such as:
  • Scope Name
  • User Consent Message
  • Developer Documentation
  • Always Show Consent

*Note: For more detailed information on managing scopes, please refer to the documentation on Manage Scopes

---

Visibility in Applications Menu

The same API displayed here will also be listed in the Applications Menu. The view in the Applications Menu is a simplified version, showing only the Overview, Grant Types and Subscriptions tabs.