Manage the audiences for your portal (Preview)

This page applies to Apigee and Apigee hybrid.

View Apigee Edge documentation.

Preview — Apigee integrated portal

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

Enrolling in the Preview release of the audience management feature

To manage audiences, you must enroll in the Preview release of the audience management feature.

To enroll in the audience management feature:

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

   Go to Portals

2. Click a portal name.

3. Click Audiences.

4. Click Enroll.

Understanding audiences

Using audiences, you can segment portal users or developer teams to control access to the following resources:

• Pages in your portal
• Published API products

The following figure shows how audiences are used to control access to a set of resources.

As shown in the figure, as an authenticated portal user, User A is able access the resources available through the public API program. In addition, as a member of Team A, User A inherits the entitlements from the Preview Users audience and is able to access the resources available through this restricted API program.

For restricted API programs, the API provider is responsible for advertising the program and processing access requests from portal users.

The following sections describe how to manage audiences and configure audience entitlements, and the audiences that are available by default.

About the default audiences

The following two audiences are defined, by default.

Audience	Assignments
Anonymous users	All users that are not signed in to the portal. Note: This audience is not displayed in the Apigee UI as an audience.
Authenticated users	All users that are registered and signed in to the portal. Note: You can customize the entitlements for the authenticated users audience, but audience assignment is defined by default.

Exploring the Audiences page

To access the Audiences page:

1. Display the list of portals:

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

   Go to Portals

2. Click the row of the portal for which you want to view audiences.

3. Click Audiences.

4. Click the Audiences tab.

The Audiences page is displayed.

The Audiences page lets you:

• View details for all audiences, including:
  • Name
  • Description
  • Total number of team and individual portal user assignments
  • Creation date
• Add an audience
• Edit and delete an audience

You can also manage the resource entitlements for an audience when creating resources and manage the default visibility for specific portal resources.

Adding an audience

Note: The maximum number of audiences that you can add is 16.

To add an audience:

1. Access the Audiences page.
2. Add an Audience.
   1. Click + Audience.
   2. Enter the name and description of the audience.
   3. Click Save.
3. Manage the assignments for an audience.

Manage the assignments for an audience

When adding or editing an audience, you can manage the developer teams and individual portal users assigned.

To manage the assignments for an audience:

1. Access the Audiences page.
2. Click the row of the audience for which you want to manage audience assignments.

3. To add a team or individual portal user to an audience:

   1. Click Edit.
   2. Select members in the drop-down list.
   3. Click Save.

4. To delete an audience assignment:

   Click Delete.

Managing the resource entitlements for an audience

When creating a portal page or publishing an API product, you can restrict access to the resource by assigning one or more audiences. When the visibility of that resource is set to Selected audiences, access is limited to the audiences to which the resource is assigned.

For more information, see:

• Manage the audience for a page in your portal
• Manage the audience for an API on your portal

When viewing and editing an audience, you can view the resource entitlements assigned.

Editing an audience

To edit an audience:

1. Access the Audiences page.
2. Click the row of the audience that you want to edit.

3. Edit the audience details.

   1. Click Edit.
   2. Edit the name, description, or members.
   3. Click Save.

4. Manage the developer teams and individual portal users assigned to an audience.

5. In the Content visibility entitlements section, view the resource entitlements for an audience. See Manage the resource entitlements for an audience.

Deleting an audience

To delete an audience:

1. Access the Audiences page.

2. Delete the audience.

   1. Click Delete.
   2. Click Delete to confirm the operation.