Manage the audiences for your portal (beta)

You're viewing Apigee Edge documentation.
Go to the Apigee X documentation. info

Enroll in the beta release of the audience management feature

To manage audiences, you must enroll in the beta release of the audience management feature. From the landing page of your portal, in the beta enrollment banner click Enroll.

Understand 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 Beta Users audience and is able to access the resources available through this restricted API program.

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 Edge 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.

Explore the Audiences page

To access the Audiences page:

  1. Select Publish > Portals in the side navigation bar to display the list of portals.
  2. Click the row of the portal for which you want to view audiences.
  3. Click Audiences on the portal landing page.
    Alternatively, you can select Audiences in the portal drop-down in the top navigation bar.
  4. Click the Audiences tab.

The Audiences page is displayed.

As highlighted in the figure, the Audiences page enables you to:

  • 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.

Add an audience

To add an audience:

  1. Access the Audiences page.
  2. Click +.
  3. Enter the name and description of the audience.
  4. Click OK.
  5. 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:

    a. Click + in the Assignments section.
    b. Select one or more developer teams or individual portal users in the Add assignments dialog.
    Enter a string in the Search box to filter the list. Click All to select all items on the list or None to deselect all items.
    c. Click Add.

  4. To delete an audience assignment, click .

Manage 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 Restricted Access, access is limited to the audiences to which the resource is assigned.

For more information, see:

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

Edit an audience

To edit an audience:

  1. Access the Audiences page.
  2. Click the row of the audience that you want to edit.
  3. To edit the audience details:
    1. In Audience details section, click .
    2. Edit the name and description of the audience.
    3. Click Save.
  4. Manage the developer teams and individual portal users assigned to an audience.
  5. In the Entitlements section, view the resource entitlements for an audience. See Manage the resource entitlements for an audience.

Delete an audience

To delete an audience:

  1. Access the Audiences page.
  2. Position the cursor over the audience that you want to delete to display the actions menu.
  3. Click
  4. Click Delete to confirm the operation.