Managing your portals

This page applies to Apigee and Apigee hybrid.

View Apigee Edge documentation.

Create and manage your portals, as described in the following sections.

About the portal roles

You need one of the following roles to manage your portals. To assign roles to a user, see Change user roles in the UI.

Role	Description
Portal Administrator	Full CRUD permissions for integrated portals. Note: The Portal Administrator role is not currently visible in the UI. In order to assign the role to a user, use the following gcloud command: gcloud projects add-iam-policy-binding <project-id> --member=user:<user-email> --role=roles/apigee.portalAdmin
Organization Administrator	Super user. Has full CRUD access to resources in the organization. This is a Apigee-specified role.
Read-only Organization Administrator	Has read-only access to resources in the organization. This is a Apigee-specific role.

Exploring the Portals page

To access the Portals page:

Cloud Console UI

In the Apigee in Cloud console, go to the Distribution > Portals page.

Go to Portals

The portals page opens and lists the current portals.

The Portals page enables you to:

• Create a portal
• Build your portal and its contents
• View the live portal
• Edit portal details
• Delete a portal

Classic UI

Use one of the following methods:

• Select Publish > Portals in the side navigation bar.
• When editing a portal, click Portals in the top navigation bar.

The portals page opens and lists the current portals.

As highlighted in the previous figure, the Portals page enables you to:

• Quickly determine which portals are using the new portal front-end
• Create a portal
• Build your portal and its contents
• View the live portal
• Edit portal details
• Delete a portal

Creating a portal

Create multiple portals for your organization, as required.

When you create a new portal, a set of starter pages is provided for you to use as a jump-off point. See About the sample portal and Quick tips for customizing the sample portal.

Note: You can create a maximum of 10 portals in your organization.

To create a new portal:

1. Access the Portals page.

2. Open Create a portal :

   Cloud Console UI

   Click + Create.

   Classic UI

   Click + Portal.

3. Enter the following information in Create a portal:

   Field	Description
   Name	Name of portal. The name can contain only letters, numbers, spaces, and the following special characters: period (.), comma (,), dash (-), or underscore (_). Must be unique across all organizations. Note: If you delete a portal, you cannot immediately create a portal with the same name as the deleted portal will be stored temporarily in the Trash folder.
   Domain	(Read only) As you enter the portal name, the default domain for the portal is displayed. For example: 'orgname-portalname.apigee.io', where 'orgname' is the organization name and 'portalname' is defined using the portal name converted to all lowercase and with spaces removed. Note: You can customize the domain name, as described in Customizing your domain.
   Description	Description of your portal. This information is for internal use only. It will not be displayed on your live portal.

4. Click Create.

Building your portal

To build your portal and its contents:

1. Access the Portals page.
2. Click the name of the portal you want to build. The portal landing page is displayed.
3. Build the portal and its contents, as described in steps to build your portal.

Editing the portal name and description

To edit portal details, including name and description:

Note: You cannot modify the default URL once the portal is created. However, you can create a custom domain.

Cloud Console UI

1. Access the Portals page.
2. On the portal row you want to edit, click More > Edit
3. Edit the portal name and description.
4. Click Save.

Classic UI

1. Access the Portals page.
2. Position your cursor over an existing portal to display the actions menu.
3. Click .
4. Edit the portal name and description.
5. Click Update.

Viewing the live portal

To view the live portal:

Cloud Console UI

1. Access the Portals page.
2. On the portal row you want to view, click More > View live portal.

Classic UI

1. Access the Portals page.
2. Position your cursor over an existing portal to display the actions menu.
3. Click .

The live portal opens in a new browser tab.

Deleting a portal

There are times when you may need to delete a portal. For example, if you have created a test portal to try out features in your local environment, you may delete it after the testing phase is complete.

Note: Existing app registrations and API keys of individual developers won't be impacted when you delete a portal, but all Team related app registrations and API Keys will be deleted. See Where app registration and API keys are stored.

To delete a portal:

Cloud Console UI

1. Access the Portals page.
2. On the portal row you want to delete, click More > Delete
3. To confirm the delete operation:
   1. Type DELETE in the text field.
   2. Click Confirm.

Classic UI

1. Access the Portals page.
2. Position your cursor over an existing portal to display the actions menu.
3. Click .
4. To confirm the delete operation:
   1. Type DELETE in the text field.
   2. Click Delete.