This topic explains how to register and manage apps by using the Apigee Edge management UI.

Overview

Developers register apps to access your API products. When a developer registers an app, the developer selects the API products to associate with the app and Edge generates an API key. Each app has a single API key that provides access to all API products associated with the app.

Apps allow you to control who can access your APIs. You can revoke an app's key, preventing it from accessing all API products. Or you can revoke access to a single API product associated with the app.


You can see all of your organization's apps in the Edge management UI on the Publish > Developer Apps summary page. This page displays performance data for each app, and general information on app keys. You can select a specific app from the table to get more detailed information, including the API products that app can access and the resources those products expose. You can also see the key associated with the app.

Registering an app in the Edge management UI

Often, developers register their apps through your developer portal. See What is a developer portal? for more on developer portals.

However, if you do not use a portal or if you want to maintain complete control over the app registration process, you can register apps by using the Edge management UI. For example, you want to register apps for your internal development teams or on behalf of a developer without access to your portal.  When you register an app, you decide which API products to associate with it. When the app is registered, Edge automatically generates an API key to grant access to the selected API products. It is then up to you to determine how to pass that key to the app developer.

Any additional API products you associate with the app use the same key.

To register an app:

  1. Login to the Edge management UI at https://enterprise.apigee.com.
  2. Click the Publish tab, then Developer Apps.
  3. Click (+) Developer App on the Developer Apps page.
  4. Enter an application name in the Display name field.
  5. Select a developer from the Developer list.
    An app must be associated with a registered developer. If the developer does not appear in the list, you can register them. See Adding developers to your organization for more.
  6. If necessary, enter the Callback URL.
    A callback URL is the location of a resource that belongs to the app. For example, if you are using OAuth, this could be the location of a login screen where users enter their username and password. This value s not required for all API products.
  7. Optionally, add a descriptive note for the app.
  8. Add any custom attributes for the app. For each custom attribute:
    • Click (+) Add Custom Attribute.
    • Add the attribute name and value.
  9. Click Save.
    Your app is added to the apps list on the Developer Apps page.

Editing an app in the Edge management UI

To edit an app:

  1. Login to the Edge management UI at https://enterprise.apigee.com.
  2. Click the Publish tab, then Developer Apps.
  3. Select an app in the Developer Apps summary table.
  4. Click Edit.
  5. Edit the app's display name and callback URL, as needed.
  6. Add, remove, or change a note, as needed.
  7. Add, remove, or change any custom attributes, as needed.
    Note: Be careful when you edit custom attributes. If you have a system that has dependencies on custom attributes, it might be impacted if you edit the custom attributes using the Edge management UI.
  8. Click Save.

Controlling access to products in the Edge management UI

You give an app access to your APIs by associating API products with the app. If you want to limit an app's access, you can temporarily revoke access to an API product, or permanently cut off access to a product by deleting the API product from the app.

When you create an API product, you can also set its access mode to Internal only or Private. API products marked Internal only or Private do not appear to developers on the developer portal. To get access to these products, you manually add them to a developer's app from the Edge management UI.

Adding access to an API product

You can expand the app's access to your APIs by associating the app with additional API products:

  1. Login to the Edge management UI at https://enterprise.apigee.com.
  2. Click the Publish tab, then Developer Apps.
  3. Select an app in the Developer Apps summary table.
  4. On the Developer App page, click Edit
  5. In the Products section of the Edit Developer App page, click + Product, select the product you want to add to the app, and click the check mark icon.
  6. Click Save. The product is added to the app.

Revoking access to an API product

In this procedure, you revoke access to this product and the resources it contains. You can re-enable access at any time.

  1. Login to the Edge management UI at https://enterprise.apigee.com.
  2. Click the Publish tab, then Developer Apps.
  3. Select an app in the Developer Apps summary table.
  4. On the Developer App page, click Edit.
  5. In the Products section of the Edit Developer App page, click Revoke next to the product.
    The Revoke button changes to Approve in case you want to make the app part of that product again.
  6. Click Save.

Deleting a product from an app

In this procedure, you remove a product from an app.

  1. Login to the Edge management UI at https://enterprise.apigee.com.
  2. Click the Publish tab, then Developer Apps.
  3. Select an app in the Developer Apps summary table.
  4. On the Developer App page, click Edit.
  5. In the Products section of the Edit Developer App page, click Remove next to the product.
  6. Click Save.

Manually approve keys

If you specified automatic key approval when you created the API product, a key is automatically approved for use by an app. If you specified manual key approval when creating the API product, you need to approve the key manually in the Edge management UI before the key can be used by the app to access the product.

In this procedure, you manually approve a product in an app.

  1. Login to the Edge management UI at https://enterprise.apigee.com.
  2. Click the Publish tab, then Developer Apps.
  3. If any app is waiting for key approval, Key requested appears in the Key column of the page.
  4. Select an app in the Developer Apps summary table with a pending key request.
  5. On the Developer App page, click Edit.
  6. In the Products section of the Edit Developer App page, click Approve next to the product.
  7. Click Save.

Regenerating a new key

In some cases, you may need to regenerate a new consumer key for an app. For instance, you might do this if the security of the original keys is compromised. Note that if you simply remove products from an app, and then add the products back, the old consumer keys are reused. To regenerate new consumer keys:
  1. Login to the Edge management UI at https://enterprise.apigee.com.
  2. Click the Publish tab, then Developer Apps.
  3. Select the app in the Developer Apps summary table for which you want to generate new consumer keys.
  4. On the Developer App page, click Regenerate Key.
  5. In the pop-up, click Regenerate Consumer Key
  6. Click Save.

 

Help or comments?

  • Something's not working: See Apigee Support
  • Something's wrong with the docs: Click Send Feedback in the lower right.
    (Incorrect? Unclear? Broken link? Typo?)