Controlling access to your APIs by registering apps

You're viewing Apigee X documentation.
View Apigee Edge documentation.

This section describes how to register apps and manage API keys.

Overview

The primary way to control who can access your APIs is through application registration.

As an API provider, you create one or more API products that bundle your APIs into service tiers. API products let you limit traffic and access levels at very granular levels. When you create an API product, you can set the access level to Public, Private, or Internal only. For more information, see Access level.

When registering an app, the app developer selects which API products to use and Apigee provides a single API key that the developer uses to access those API products. The app developer passes the API key in each call to the API proxies contained in the API products. At any time, you can revoke an app's API key, preventing an app developer from accessing all or a subset of API products referenced by that app.

Typically, app developers register to use your API products using your developer portal. The steps to build your portal and publish your API products are described in Build your portal.

You can have more control over the app registration process by registering your apps using the Apigee UI or Apigee APIs instead. For example, you may want to register apps for your internal development teams or for a developer that cannot access to your portal.

The following sections describe how to register apps and manage API keys using the UI and API.

Exploring the Apps page

To register apps and manage API keys in the Apigee UI you use the Apps view.

To access the Apps view using the Apigee UI:

  1. Sign in to the Apigee UI.
  2. Select Publish > Apps.

    The Apps pane is displayed:

    Apps pane in Apigee UI

    As highlighted in the example, the Apps view lets you do the following:

Registering an app

An app can be registered in the following ways:

  • By an app developer: An app developer can register the app via your portal, as described in How app developers interact with your portal.
  • By an administrator: You can register an app in Apigee, as described below. It is up to you to determine how to provide the key to the app developer.

Registered apps are added to the following:

To register an app in Apigee:

  1. Access the Apps page.
  2. Click + App.
  3. Specify the App Details, as described in the following table:
    Field Description Required?
    Name Name of the app. You can't change the name once the app is created. This name is used in Apigee APIs calls. Required
    Display Name Display name for the app that appears in the Apigee UI and the developer portal. Optional
    Company/Developer

    Note: Apigee hybrid does not support company apps; this field does not apply.

    Select Company or Developer and select a company or developer name from the drop-down.
    Note: For performance reasons, not all companies or developers are displayed in the drop-down. Start typing the company name or developer name or email in the search box. See also Register app developers.

    Required
    Callback URL Typically specifies the URL of an app that is designated to receive an authorization code on behalf of the client app. This value is not required for all API products. Optional
    Notes Descriptive notes for the app. Optional
  4. Specify the Credentials, including the API key expiration and status and the associated API products. In the Credentials section, click and enter the following information:
    Field Description
    Expiry Configure an expiration duration or date, or set the API key to never expire, and click OK.
    Products Associate one or more API products with the API key:
    1. Click Add product.
    2. Select one or more API products from list.
    3. Click Add.
    4. Set the Status to Approved or Revoked for each API product.
    5. Repeat steps to add more API products.
  5. Specify the Custom Attributes:
    1. In the Custom Attributes section, click .
    2. Enter the name and value.
    3. Click Add or Add & Start another. The maximum number of custom attributes that you can add is 18.
  6. Click Create.

If the API products you associated with the app required manual approval for their API keys, approve them, as described in Approving or revoking API keys.

Viewing apps registered for a developer

To view apps registered for a specific developer, use one of the following methods:

Viewing and editing an app

To view and edit an app:

  1. Access the Apps page.
  2. Click anywhere in the row of the app that you want to view and edit. Apigee displays the app details.
  3. To edit an app, click Edit.
  4. Perform one or more of the following tasks:
  5. Click Save.

Managing credentials

When editing an app, you can manage its credentials in the Credentials section, as shown in the following figure:

As highlighted in the previous figure, in the Credentials section you can perform the following tasks using the UI:

To use the API to manage credentials, see the following sections:

Viewing an API key and secret

To view an API key and secret:

  1. Access the Apps page.
  2. Click in the row of the app for which you want to view the API key and secret.
  3. In the Credentials section, click Show associated with the API key or secret that you want to view.

Approving or revoking an API key

API calls to API proxies usually require an API key. Apigee allows the calls only if the API key is approved, valid, and meets the conditions defined by the API product containing the API.

You can configure an API product for automatic approval of API keys, as described in Managing API products. However, if the API product requires manual approval of API keys, you need to manually approve the key.

You can revoke an API key for all or a single API product. In this case, the API key and secret are invalid and cannot be used to accessing APIs in the associated API product(s). You can re-approve an API key at any time.

To approve or revoke an API key:

  1. Access the Apps page.
  2. Click in the row of the app that you want to view and edit.
  3. Click Edit.
  4. Perform one of the following tasks:
    • To approve or revoke an API key for all API products associated with an API key, select Approved or Revoked associated with the API key.
    • To approve or revoke an API key for a specific API product, select Approved or Revoked in the Status column for the API product.
  5. Click Save.

Managing API products in an app

Manage API products in your app by performing the following tasks:

Adding an API product to an app

To add an API product to an app:

  1. Access the Apps page.
  2. Click in the row of the app that you want to view and edit.
  3. Click Edit.
  4. Perform one of the following tasks:
    • To add an API product to a new API key, click to generate a new credential, select an experation, and add the API product to the API key.
    • To add an API product to an existing API key, in the Credential section click Add product and select the API product from the drop-down list.
  5. Click Save.

Removing an API product from an app

If you want to keep an API key active but not allow it to be used by an API product, you can remove it from the associated credential.

  1. Access the Apps page.
  2. Click in the row of the app that you want to view and edit.
  3. Click Edit.
  4. Click adjacent to the API product.
  5. Click Save.

You can re-add a removed product.

Generating new credentials

You can generate new credentials for an app. For instance, if you're using API key rotation, you can generate new keys whose expiration overlaps keys that will be out of rotation when they expire. You might also generate a new key/secret if the security of the original key/secret is compromised. If you generate a new key, any existing API keys will continue to work until they expire or you explicitly revoke them.

To generate a new API key:

  1. Access the Apps page.
  2. Click in the row of the app that you want to view and edit.
  3. Click Edit.
  4. In the Credentials section, click .
  5. Specify the expiration, add the API products, and set their status.
  6. Optionally, revoke any of the other API keys, as required.
  7. Click Save.

Approving or revoking an app

Approve or revoke an app, as described below. When you revoke an app, any approved API keys can no longer be used in API calls to Apigee. When you re-approve an app, all approved and valid API keys can be used to make API calls.

If the app is registered in other organizations, you must revoke it in each of those organization. It may take a few minutes for the changes to be recognized by all message processors.

To approve or revoke an app:

  1. Access the Apps page.
  2. Click in the row of the app that you want to view and edit.
  3. Click Edit.
  4. Select Approve or Revoke in the App Status field to approve or revoke the app, respectively.
  5. Click Save.

Deleting an app

When you delete an app, all client keys associated with the apps become invalid. Using an invalid key on a request causes the request to fail.

If you think you may want to reinstate a developer app in the future, an alternative to deletion is revoking an app.

To delete an app:

  1. Access the Apps page.
  2. Position the cursor in the row of the app that you want to delete.
  3. Click in the actions column.

Registering apps and managing API keys using the API

To register and manage apps using the Apigee APIs, use the following APIs:

See also Import existing consumer keys and secrets.