How portal users interact with your portal

Out-of-the-box, the developer portal enables your portal users to create a developer account, sign in, and manage the apps that will consume your APIs.

The following sections describe how portal users interact with your portal.

Sign in to the portal

The following sections describe how portal users sign in to the integrated portal using their user credentials (built-in identity provider) or using SAML.

If you enable both the built-in and SAML identity providers, then portal users will be able to choose their preferred method for signing in. For example:

Sign in to the portal using user credentials (built-in identity provider)

When the built-in identity provider is enabled, portal users can sign in to the integrated portal using their user credentials (username and password), as described in the following sections:

Create a developer account on the integrated portal

With the built-in identity provider, before portal users can use your APIs, they must create a developer account on the integrated portal.

Portal users create a developer account on the integrated portal as follows:

  1. Navigate to the portal.
  2. Click Sign in.
    The Sign In page displays.
  3. Click Create account.
    The Create your account page displays.

    Create account

    Note: You can add custom registration fields to the account creation page, as described in Add custom registration fields to the account creation page.

  4. Complete the form. You must enter values for all required fields. Passwords must be at least 8 characters and contain at least one of each of the following: number, lowercase letter, uppercase letter, and special character.

  5. Review and agree to the terms and conditions.

  6. Click Create Account.

    Note: If an attempt is made to create an account with an email ID that has already been registered, a message displays indicating that the account already exists, and the portal user will be encouraged to sign in instead.

  7. Complete the CAPTCHA form and click Verify (if displayed).
    The developer account is created and a confirmation email is sent.

    Note: You can configure the confirmation email, as described in Configure email notifications. Apigee recommends that you configure the SMTP server used for the email notifications originating from the portal prior to launching, as described in Configure the SMTP server.

  8. Within 10 minutes, click the link in the confirmation email to complete the registration process. If you do not click the link within 10 minutes, you must repeat the steps in this procedure to create an account and be re-prompted.

  9. Sign in to the integrated portal (described below).

Sign in to the integrated portal

With the built-in identity provider, after portal users have registered on the integrated portal and are approved, they sign in using their credentials (username and password).

Portal users sign in as follows:

  1. Navigate to the portal.
  2. Click Sign In.
  3. Enter the email address and password.
  4. Click Sign In.

Change the password

With the built-in identity provider, portal users change the password as follows:

  1. Navigate to the portal.
  2. Click Sign In.
  3. Click Reset Password.
  4. Enter the email address for the account to be reset.
  5. Click Send Reset Password Link.
    A reset password link is sent to the email.

    Note: To configure the SMTP server, see Configure the SMTP server.

  6. Click the link in the confirmation email.

  7. Enter the new password and confirm it.
    Passwords must be at least 8 characters and contain at least one of each of the following: number, lowercase letter, uppercase letter, and special character.

  8. Click Create New Password.

Sign in to the portal using SAML authentication

When the SAML identity provider is enabled, portal users sign in to the integrated portal using SAML authentication, as follows:

  1. Navigate to the portal.
  2. Click Sign In.
  3. Click login with SAML. You are redirected to the SAML provider.
  4. If prompted, enter your credentials for your SAML identity provider.

How developer account registration and sign in are represented in Edge

Developer account registration and portal sign in are represented with the _apiportal custom attribute in Edge.

When a portal user self-registers (built-in identity provider only), the _apiportal custom attribute is added to the portal user configuration and the 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 portal user signs in to a portal, the _apiportal custom attribute is updated to reflect the portal name and time of access, and set the status to active. Each time the portal user 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}}}

View API documentation

Portal users can view the API reference documentation that you have published to your portal, as follows:

  1. Navigate to the portal.
  2. Click APIs in the top navigation bar.
  3. Click an API card to view the API reference documentation.

The API reference documentation is displayed. Portal users can learn about and try the APIs. See Publish your APIs.

Share responsibility for an app using developer teams (beta)

Developer teams allow portal users to share responsibility for an app with other portal users. The following sections describe how to create and manage developer teams.

About the developer team roles

The following table summarizes the roles that can be assigned to developer team members:

Role Description
App Admin
  • Read-only privileges for developer team members and developer team details.
  • Read and write privileges for apps.
Owner Full read and write privileges for developer team members, developer team details, and apps.
Viewer Read-only privileges for developer team members, developer team details, and apps.

View the Teams page

The Teams page displays the developer teams for which you are a member.

To access the Teams page:

  1. Sign in to the portal.
  2. Select Teams from the developer account drop-down in the portal.

The Teams page is displayed enabling you to:

Add developer teams

To add a developer team:

  1. Sign in to the portal.
  2. Select Teams from the developer account drop-down in the portal.
  3. Click + New Team.
  4. Enter a name, description, and primary point of contact (defaults to your email address).
  5. To add a member to the developer team, click + Add another member, enter the portal user's email address, and select a developer team role. Repeat to add additional members.
    Note: You are added automatically as an owner of the developer team.
  6. To delete a member from the developer team, click adjacent to the developer team member you wish to delete.
  7. Click Create.

Edit developer team membership and roles

To edit developer team membership and roles:

  1. Sign in to the portal.
  2. Select Teams from the developer account drop-down in the portal.
  3. Click in the row of the developer team that you want to edit and for which you are an owner.
  4. Perform one or more of the following steps:

    • Edit the name, description, and primary contact.
    • Add or remove developer team members.
    • Update developer team member roles.
  5. Click Save.

Remove yourself from a developer team

To remove yourself from a developer team:

  1. Sign in to the portal.
  2. Select Teams from the developer account drop-down in the portal.
  3. Click in the row of the developer team from which you want to remove yourself.
  4. Click Leave Team.

Delete a developer team

Note: When you delete a developer team, all apps owned by the developer team are deleted.

To delete a developer team:

  1. Sign in to the portal.
  2. Select Teams from the developer account drop-down in the portal.
  3. Click in the row of the developer team that you want to delete.
  4. Click .
  5. Click Confirm to confirm the deletion.

Register apps

Register developer apps and developer team apps, as described in the following sections.

Register developer apps

Portal users can register apps to use the API products that you have published, as follows:

  1. Select Apps from the developer account drop-down.
  2. Click + New App to create a new app.
  3. Enter a name and description for the app in the New App dialog.
  4. Select the owner of the App in the Owner drop-down list.
    By default, you are the owner of the app. If desired, select a developer team from the drop-down menu to share responsibility for the app with other developer team members. See Share responsibility for an app using developer teams (beta).
    Note: In beta, app ownership cannot be transferred after the app is created.
  5. Select one or more APIs in the APIs section.
    You must select at least one API in order to create an app.
  6. Click Create.

Register developer team apps

Developer team members can register apps for a developer team to use the API products that you have published, as described below.

To learn more about how:

To register developer team apps:

  1. Select Teams from the developer account drop-down.
  2. Click the row of the developer team for which you want to register an app.
  3. Click + New App to create a new app.
  4. Enter a name and description for the app in the New App dialog.
  5. Select the owner of the App in the Owner drop-down list.
    By default, the developer team is the owner of the app. If desired, select a different developer team or yourself as owner from the drop-down menu.
    > Note: In the beta release, app ownership cannot be transferred after the app is created.
  6. Select one or more APIs in the APIs section.
    You must select at least one API in order to create an app.
  7. Click Create.

Manage the API products in an app

Portal users 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.

Portal users can manage the API products in an app from your portal, as follows:

  1. Select Apps from the developer account drop-down.
  2. Click the app in the list.
  3. In the APIs section, click the access toggle to enable or disable access to an API product from the app.

View the API key and secret for an app

Portal users can manage the API key for an app from your portal, as follows:

  1. Select Apps from the developer account drop-down.
  2. Click the app in the list.
  3. View the API keys in the API Keys section.
  4. Confirm that the status of the API key is Active.
  5. Click Show to view the secret.
  6. Position your cursor over the API key or secret and click to copy it to the clipboard.

Rotate the API key for an app

A portal user can rotate an app's API key periodically or in response to a potential leak or compromise. When a portal user rotates an API key, a new API key is created with the same API product entitlements as the original key. The original API key remains active while you transition it out of use. You must revoke the old API key to prevent its credentials from being accepted, as described in Revoke an API key for an app.

Portal users can rotate an API key for an app from your portal, as follows:

  1. Select Apps from the developer account drop-down.
  2. Click the app in the list.
  3. In the API Keys section, click Add Key.
  4. Click Confirm in the dialog box to confirm the operation.
  5. Optionally, revoke the old API key, as described below.

Revoke an API key for an app

When a portal user rotates an API key, as described in the previous section, the API key remains active while you transition it out of use. You must revoke an API key to prevent its credentials from being accepted.

Portal users can revoke an API key for an app from your portal, as follows:

  1. Select Apps from the developer account drop-down.
  2. Click the name of the app.
  3. On the App Details tab, click .
  4. Click Confirm to confirm the operation.
    The Status of the key is updated to Revoked.

Edit app details

Portal users can edit the app details, as follows:

  1. Select Apps from the developer account drop-down.
  2. Click the app in the list.
  3. Edit the Name or Description fields on the App Details tab.
  4. Click Save.

Delete an app

Portal users can delete an app from your portal, as follows:

  1. Select Apps from the developer account drop-down.
  2. Click the app in the list.
  3. Click DELETE.
  4. Click Confirm to confirm the operation.

The app is deleted and removed from the Apps list.