Contact Us 1-800-596-4880
  1. Homepage
  2. API Experience Hub
  3. Discovering and Consuming APIs

  4. My Applications

My Applications

The My Applications page enables you to review the lists of applications that hold a contract with an API. Each client application has a client ID, client secret, description, URL, redirect URIs, and grant types.

APIs that are protected by a client ID enforcement policy require client applications to provide a client ID and optional client secret. The client ID and client secret credentials are automatically created when the client application is registered. For more information about registering an application, see Requesting Access to an API Instance.

Search for Applications

If the My Applications page lists several applications, search for a specific one by using the Search box. Enter the application name or description of the application and press Enter or Return. The number of applications that match your search criteria displays in the list of search results.

View and Copy Client Credentials

To view the details of a client application, from the My Applications page, click the application from the list to display the Application Details page.

You can view and copy client credentials as follows:

  • Click View credentials from the My Applications page.

  • To copy the client ID or client secret to the clipboard, click the Copy to clipboard icon.

  • To show the client secret, click the Show Client Secret icon.

  • To hide the client secret, click the Hide Client Secret icon.

Application Details

To view the details of a client application, from the My Applications page, click the application from the list to display the Application Details page.

You can view the following details about an application:

  • Application URL

    Displays the application’s internet address. Click the link to go to the URL.

  • Client Credentials

    Displays the application’s client ID and client secret.

  • OAuth 2.0 Redirects URIs

    Lists the application’s redirect URIs.

  • OAuth 2.0 Grant Type

    Lists the application’s grant types.

  • API Contracts

    From the API contracts section, you can see the application’s API name, environment and instances, instance URLs, SLA tier, and request access state. The environment can be either a sandbox or development environment. Request access states can be pending, approved, or failed.

From the Application Details page, you can:

  • Reset the client secret.

  • Edit the client applications details.

  • View the instance URL.

  • Add an SLA tier.

  • Change the SLA tier.

  • Delete the client application.

Reset Client Secret

You can reset the client secret for an application on a regular cadence to ensure security when users leave the organization or to ensure that the secret isn’t accidentally exposed to unauthorized users.

From the Application Details page, you can reset the client secret for an application. Applications using the current client secret can’t access any of the APIs with which they were registered.

To reset the client secret:

  1. From the Client Credentials section, click Reset client secret.

  2. Click Confirm.

  3. To view the new client secret, click the View icon.

Edit the Client Application Details

You can edit a client application name, description, OAuth 2.0 grant type, OAuth 2.0 Redirect URIs, and SLA Tier from the Application Details page.

  1. From the My Applications section, click the application name in the list.

  2. Click Edit.

  3. From the Application Details page, edit the corresponding fields.

  4. Click Save.

View and Copy the Instance URL

To view the instance URL for an API by clicking View URL and copy it by clicking the Copy from clipboard icon.

Add an SLA Tier

SLA tiers are defined in API Manager and display as SLA Tier options in the Application Details page. If an application does not have an SLA tier listed, you can request to add an SLA tier. The instance owner must approve the tier.

  1. From the My Applications section, click the application name in the list.

  2. From the SLA Tier column of the API Contracts section, click + Add.

  3. From the Add SLA Tier list, select from the list of tiers.

  4. Click Save.

    When the request access is approved, the Request Access State column displays the Approved state and an email is sent to the member.

Change the SLA Tier

The SLA tier can limit the number of requests an application can make to the API. You can increase or decrease the number of allowed requests. You can change the SLA tier for an application from the Application Details page. The available SLA tiers are set by an admin in API Manager. The owner of the API instance must approve the request to change the tier level.

To edit the SLA tier for a client application:

  1. On the My Applications page, click the name of the application in the list.

  2. From the SLA Tier column of the API Contracts section that you want to change, click the SLA tier edit option.

  3. From the Edit SLA Tier dialog, select from the list of SLA tiers.

  4. Click Save.

  5. Click Okay to close the message.

Delete a Client Application

When you no longer need the contract for an API, you can delete it. Once the application is deleted, there is no longer a contract with the API and you can’t access it. To regain access, you must request access to the API again.

To delete a client application:

  1. On the Application Details page for the application, click Delete.

  2. In the Delete application message, click Delete.

    The application is removed from the My Applications page.