You're viewing **Apigee Edge** documentation. [Go to the **Apigee X** documentation](http://cloud.google.com/apigee/docs/api-platform/publish/creating-apps-surface-your-api). info Register apps and manage API keys, as described in the following sections. ## Introduction App registration provides the primary mechanism for controlling who can access your APIs. As an API provider, you create one or more API products to bundle your APIs, as explained in [Manage API products](https://docs.apigee.com/api-platform/publish/create-api-products). When registering an app, the app developer selects which API products to use and Edge provides a single [API key](https://docs.apigee.com/api-platform/security/api-keys) that the developer can use 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. ![](https://docs.apigee.com/static/api-platform/images/Apps.png) 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](https://docs.apigee.com/api-platform/publish/portal/developer-services-portal). Alternatively, as an API provider, you might want more control over the app registration process and choose to register apps in Edge, as described in the following sections. For example, you may want to register apps for your internal development teams or on behalf of a developer without access to your portal. > [!NOTE] > You must be an organization administrator or be assigned a role with the appropriate permissions to register apps and manage API keys. The following sections describe how to register apps and manage API keys using the [UI](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#ui) and [API](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#api). ## Exploring the Apps page Access and explore the Apps page, as described below. ### Edge To access the Apps page using the Edge UI: 1. Sign in to [apigee.com/edge](https://apigee.com/edge). 2. Select **Publish \> Apps** in the left navigation bar. The Apps page is displayed. ![](https://docs.apigee.com/static/api-platform/images/register-apps.png) As highlighted in the figure, the Apps page enables you to: - [Register an app](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#register) - [View and edit an app](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#edit) - [Manage credentials](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#manage-credentials) - [Approve or revoke an app](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#approve-revoke-app) - [Delete an app](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#delete) - Search the list of apps by name, developer, app ID, consumer API key, or all content ### New Edge UI (Private Cloud) > [!NOTE] > **Note:** The New Edge UI is available with Edge for Private Cloud only. To access the Apps page using the New Edge UI: 1. Sign in to the New Edge UI at `http://host:3001/edge`, where host is the IP address or DNS name of the host running the New Edge UI. 2. Select **Publish \> Apps** in the left navigation bar. The Apps page is displayed. ![Apps page in the New Edge UI](https://docs.apigee.com/static/api-platform/images/register-apps.png) As highlighted in the figure, the Apps page enables you to: - [Register an app](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#register) - [View and edit an app](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#edit) - [Manage credentials](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#manage-credentials) - [Approve or revoke an app](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#approve-revoke-app) - [Delete an app](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#delete) - Search the list of apps by name, developer, app ID, consumer API key, or all content ## Registering an app > [!WARNING] > Always be sure your app includes at least one > [API product](https://docs.apigee.com/api-platform/publish/create-api-products) in which at least one > API proxy and/or resource > path is specified. If the API product does not include an API proxy and/or resource path, > the app's key can be used to call any API proxy > in your Edge organization. In most situations, you do not want to create a > so-called > [skeleton key](https://discuss.google.dev/t/making-sense-of-api-product-configuration/17610)--a key that can open any door in your house! An app can be registered using one of the following methods: - An app developer can register the app via your portal, as described in [How app developers interact with your portal](https://docs.apigee.com/api-platform/publish/portal/portal-interact). - You can register an app in Edge, as described below. It is up to you to determine how to provide the key to the app developer. Registered apps are added to: - List of registered apps in Edge. See [Viewing and editing developer details](https://docs.apigee.com/api-platform/publish/adding-developers-your-api-product#edit). - Apps page in the [developer portal](https://docs.apigee.com/api-platform/publish/portal/developer-services-portal). > [!NOTE] > When you create an API product, as describe in [Managing API products](https://docs.apigee.com/api-platform/publish/create-api-products), you can set the access level to Public, Private, or Internal only. For more information, see [Access level](https://docs.apigee.com/api-platform/publish/what-api-product#access-levels). To register an app in Edge: 1. [Access the Apps page.](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#ui) 2. Click **+ App**. 3. Specify the **App Details** : | Field | Description | Required? | |---|---|---| | Name | Name of the app. You can't change the name once the app is created. This name is used in management API calls. > [!NOTE] > **Note:** The App names must use a unique sequence of characters, regardless of the case. For example, you will get an error if you create an App named `appB` and subsequently attempt to create another App named `AppB`. | Yes | | Display Name | Display name for the app that appears in the Edge management UI and the developer portal. | No | | 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](https://docs.apigee.com/api-platform/publish/adding-developers-your-api-product). | Yes | | 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. | No | | Notes | Descriptive notes for the app. | No | 4. Specify the **Credentials** , including the API key expiration and status and the associated API products. In the Credentials section, click ![](https://docs.apigee.com/static/api-platform/images/add.png) 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 ![](https://docs.apigee.com/static/api-platform/images/add.png). 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](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#approve-revoke-key). ## Viewing apps registered for a developer To view apps registered for a specific developer, use one of the following methods: - [View all registered apps](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#ui), select **Developer** in the Search drop-down, and enter the name of the developer in the search field. - [View all registered app developers](https://docs.apigee.com/api-platform/publish/adding-developers-your-api-product#ui) and click the row associated with the developer. ## Viewing and editing an app > [!NOTE] > **NOTES** : > > Before editing custom attributes, make sure that there are no system dependencies on the existing attribute settings. > - To update the app custom attributes, please use the [Apigee Edge APIs](https://apidocs.apigee.com/docs/developer-apps/1/routes/organizations/%7Borg_name%7D/developers/%7Bdeveloper_email%7D/apps/%7Bapp_name%7D/attributes/post) or the UI. > - To update the app key custom attributes, please use the [Apigee Edge APIs](https://apidocs.apigee.com/docs/developer-app-keys/1/routes/organizations/%7Borg_name%7D/developers/%7Bdeveloper_email%7D/apps/%7Bapp_name%7D/keys/%7Bconsumer_key%7D/post). > - With **Apigee Edge for Public Cloud** , Edge keeps the following entities in cache for a minimum of 180 seconds after the entities are *accessed*. > - OAuth access tokens. This means that a revoked token may still succeed for up to three minutes, until its cache limit expires. > - Key Management Service (KMS) entities (Apps, Developers, API Products). > - Custom attributes on OAuth tokens and KMS entities. > To view and edit an app: 1. [Access the Apps page.](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#ui) 2. Click in the row of the app that you want to view and edit. App details are displayed. 3. To edit an app, click **Edit**. 4. Perform one or more of the following tasks: - Modify the app details, including the name, callback URL, or notes. - [Manage the credentials](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#manage-credentials). - Add or delete custom attributes. The maximum number of custom attributes that you can add is 18. - [Approve or revoke the app](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#approve-revoke-app). 5. Click **Save**. ## Managing credentials When [editing an app](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#edit), you can manage its credentials in the **Credentials** section, as shown in the following figure: ![](https://docs.apigee.com/static/api-platform/images/manage-credentials.png) As highlighted in the previous figure, in the Credentials section you can perform the following tasks using the UI: - [View an API key and secret](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#view-api-key) - [Approve or revoke an API key](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#approve-revoke-key) for all associated API products or for a single API product. - [Manage API products in an app](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#manage-api-products) - [Generate new credentials](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#generate-credentials) To use the API to manage credentials, see the following sections: - [Managing consumer keys for apps](https://docs.apigee.com/api-platform/publish/using-edge-management-api-publish-apis#managingconsumerkeysforapps) - [Import existing consumer keys and secrets](https://docs.apigee.com/api-platform/publish/import-existing-consumer-keys-and-secrets) > [!NOTE] > **Note:** When you create an API product, you can also set its [access level](https://docs.apigee.com/api-platform/publish/what-api-product#access-levels) 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. ### Viewing an API key and secret To view an API key and secret: 1. [Access the Apps page.](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#ui) 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](https://docs.apigee.com/api-platform/security/api-keys). Edge 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 [Manage API products](https://docs.apigee.com/api-platform/publish/create-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.](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#ui) 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: - [Add an API product to an app](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#managingapikeys-addproduct) - [Remove an API product from an app](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#managingapikeys-revokingorremovinganapiproductfromanapikey) #### Adding an API product to an app To add an API product to an app: 1. [Access the Apps page.](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#ui) 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 ![](https://docs.apigee.com/static/api-platform/images/add.png) 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.](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#ui) 2. Click in the row of the app that you want to view and edit. 3. Click **Edit**. 4. Click ![](https://docs.apigee.com/static/api-platform/images/delete-x.png) 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.](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#ui) 2. Click in the row of the app that you want to view and edit. 3. Click **Edit**. 4. In the Credentials section, click ![](https://docs.apigee.com/static/api-platform/images/add.png). 5. Specify the expiration, add the API products, and set their status. 6. Optionally, [revoke](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#approve-revoke-key) any of the other API keys, as required. 7. Click **Save**. ## Approving or revoking an app > [!NOTE] > **Note** : You can approve or revoke apps that are associated with a particular user, as described in [Manage portal users](https://docs.apigee.com/api-platform/publish/portal/api-portal-users) 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 Edge. 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.](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#ui) 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](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#revokingadeveloperapp). **To delete an app:** 1. [Access the Apps page.](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#ui) 2. Position the cursor in the row of the app that you want to delete. 3. Click ![](https://docs.apigee.com/static/api-platform/images/delete-icon.png) in the actions column. **Note**: With Apigee Edge for Public Cloud, deletion of the developer app and associated artifacts happens asynchronously. The developer app is deleted immediately, but the resources associated with that developer app, such as app keys or access tokens, may take anywhere from a few seconds to a few minutes to be automatically deleted. ## Registering apps and managing API keys using the API To register and manage apps using the API, see [Registering developer apps](https://docs.apigee.com/api-platform/publish/using-edge-management-api-publish-apis#registeringdeveloperapps). See also the following sections in the API reference documentation: - [Apps](https://apidocs.apigee.com/docs/apps/1/overview) - [Apps: Company](https://apidocs.apigee.com/docs/company-apps/1/overview) - [Apps: Developer](https://apidocs.apigee.com/docs/developer-apps/1/overview) - [Company App Keys](https://apidocs.apigee.com/docs/company-app-keys/1/overview) - [Developer App Keys](https://apidocs.apigee.com/docs/developer-app-keys/1/overview) See also [Import existing consumer keys and secrets](https://docs.apigee.com/api-platform/publish/import-existing-consumer-keys-and-secrets).