You're viewing **Apigee Edge** documentation.  
[Go to the
**Apigee X** documentation](http://cloud.google.com/apigee/docs/api-platform/publish/portal/portal-interact). info

> [!NOTE]
> **This topic describes the original version of the portal.** All new portals are based on the [new theme, API docs, and developer identity service](https://docs.apigee.com/api-platform/publish/portal/build-integrated-portal). To migrate an existing portal, see [Migrate to the new version of the portal](https://docs.apigee.com/api-platform/publish/portal/migrate).


> [!NOTE]
> **Note:** The integrated portal is available as an Apigee-managed solution for Apigee Edge for Public Cloud customers only. If you are an Apigee Edge for Private Cloud customer, refer to the customer-managed [Drupal portal solution](https://docs.apigee.com/api-platform/publish/drupal/open-source-drupal).

<br />

Out-of-the-box, the developer portal enables your app developers to register, sign in, and manage the apps that will consume your APIs.

The following sections describe how app developers interact with your portal:

## How app developer registration and sign in are tracked in Edge

Developer registration and portal sign in are tracked using the `_apiportal` custom attribute in Edge.

When a developer self-registers, the `_apiportal` custom attribute is added to the developer configuration and the developer status is set to `unverified` to indicate that the developer has not signed in to the portal. For example: `{"status":"unverified","portals":{}}`

The first time the developer signs in to a portal, the `_apiportal` custom attribute is updated to track the portal name and time of access, and set the developer status to `active`. Each time the developer signs in to the portal, the custom attribute is updated to reset the `lastVisit` value (in epoch format) for that portal. For example: `{"status":"active","portals":{"myorg-myportal":{"lastVisit":1480972935}}}`

## Register an app developer account

Before app developers can use your APIs, they must register by creating an account.

When an app developer registers with your portal:

- App developer information is created and stored on Edge. See [Where developer account information is stored](https://docs.apigee.com/api-platform/publish/portal/build-integrated-portal#apidev-info-stored).
- App developer appears on the list of registered app developers. See [Explore the Developers page](https://docs.apigee.com/api-platform/publish/adding-developers-your-api-product#ui).

Alternatively, you can register app developers on their behalf using the Edge UI, as described in [Registering app developers](https://docs.apigee.com/api-platform/publish/adding-developers-your-api-product).

New app developers can self-register with your portal as follows:

1. Navigate to the portal.
2. Click **Sign in**.
3. Click **Sign up** .  

   The following dialog displays.

   ![Create account](https://docs.apigee.com/static/api-platform/images/portal-create-account.png)
4. Enter the required information (first name, last name, and email address).

5. Click **Create** .  

   The following dialog displays.

   ![Log into portal](https://docs.apigee.com/static/api-platform/images/verification-link.png)
6. Click the secure link in the email to open the portal and establish the authenticated session.

> [!NOTE]
> If a developer attempts to register an account with an email ID that has already been registered, a message displays indicating that the account already exists and the developer is directed to the Login page. When the developer clicks the link to navigate to the Login page, the email ID for the existing account is pre-populated in the email field.

## Sign in to your portal

After app developers have registered with your portal, they sign in using the Sign In page.

Each time an app developer signs in to a portal, rather than using a shared secret like a password to authenticate the developer, a secure link is sent to verify identity and establish a session with the portal.

App developers can sign in to your portal, as follows:

1. Navigate to the portal.
2. Click **Sign In**.
3. Enter the email address associated with the account.
4. Click **Login** .  

   The following dialog displays.

   ![Sign in to portal](https://docs.apigee.com/static/api-platform/images/portal-login-email.png)
5. Click the secure link in the email to open the portal and establish the authenticated session.

## Register apps

After signing into the portal, app developers can register apps to use the API products that you have published, as follows:

1. Select **My Apps** from the user drop-down.
2. Click **+ App** to create a new app.
3. Enter a name and description for the app in the Create App dialog.
4. Click **Create**.
5. Manage the API products in the app, as described below.

## Manage the API products in an app

App developers can manage the API products in their apps. The API products are added to the app details page. For some API products, approval is not automatic. A status of **Pending** indicates an API product for which access has been requested but not yet granted.

App developers can manage the API products in an app from your portal, as follows:

1. Select **My Apps** from the user drop-down.
2. Click the name of the app.
3. Click **Manage Products**.
4. Click the **Access** toggle to enable or disable access to an API product from the app.

   > **Note** : If the app developer disables access to an API product that is Private or Internal only, the API product is removed from the app and must be re-added manually by the portal administrator, as described in [Register apps and manage API keys](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api).
5. Click **Request** to request approval for an API product that is not yet allowed.

6. Click **Save**.

## View the API key for an app

App developers can manage the API key for an app from your portal, as follows:

1. Select **My Apps** from the user drop-down.
2. Click the name of the app.
3. View the API key in the **Keys** section.
4. Click **View Secret** to display the API key secret.
5. Confirm that the status of the API key is Approved.

> [!NOTE]
> If either the developer or developer app has been deactivated/revoked, the key status label is shown with strikethrough text Approved or Revoked). The API key will not be valid until the developer or developer app are re-activated/re-approved. For more information, see [Activating and deactivating an app developer](https://docs.apigee.com/api-platform/publish/adding-developers-your-api-product#status) and [Approving or revoking an app](https://docs.apigee.com/api-platform/publish/creating-apps-surface-your-api#approve-revoke-app).

## Rotate the API key for an app

An app developer can rotate an app's API key periodically or in response to a potential leak or compromise. When an app developer rotates an API key, a new API key is created with the same API product entitlements as the original key. The original API key is marked deprecated, but it remains active while you transition it out of use. You must deactivate a deprecated key to prevent its credentials from being accepted, as described in [Deactivating an API key for an app](https://docs.apigee.com/api-platform/publish/portal/original-theme/portal-interact-v1#deactivate-key).

> [!NOTE]
> Only the current API key can be rotated.

App developers can rotate the primary API key for an app from your portal, as follows:

1. Select **My Apps** from the user drop-down.
2. Click the name of the app.
3. In the Keys section, position the cursor over the current API key to display the actions menu.
4. Click ![Expand icon](https://docs.apigee.com/static/api-platform/images/expand-icon.png) to expand the actions menu.
5. Click **Rotate**.
6. Click **Create** in the dialog box to confirm the operation.
7. Optionally, deactivate the API key, as described below.

## Deactivate an API key for an app

When an app developer rotates an API key, as described in the previous section, the API key is marked as deprecated, but it remains active while you transition it out of use. You must deactivate a deprecated key to prevent its credentials from being accepted.

> [!NOTE]
> You can only deactivate an API key that is both active (status is approved) and deprecated. You cannot deactivate the current API key; you must rotate the current API key before you can deactivate it.

App developers can deactivate an API key for an app from your portal, as follows:

1. Select **My Apps** from the user drop-down.
2. Click the name of the app.
3. In the Keys section, click **Keys history** to display the list of deprecated keys.
4. Position the cursor over the deprecated API key that you want to deactivate to display the actions menu.
5. Click ![Expand icon](https://docs.apigee.com/static/api-platform/images/expand-icon.png) to expand the actions menu.
6. Click **Deactivate**.
7. Click **Deactivate** to confirm the operation.  
   The Status of the key is updated to Revoked.

## Edit app details

App developers can edit the app details, as follows:

1. Select **My Apps** from the user drop-down.
2. Click the name of the app.
3. Edit the Name or Description fields.
4. Click **Save**.

The app is deleted and removed from the My Apps list.

## Delete an app

App developers can delete an app from your portal, as follows:

1. Select **My Apps** from the user drop-down.
2. Click the name of the app.
3. Click **delete** in the upper-right corner of the page.

The app is deleted and removed from the My Apps list.