Working with consumer organization groups

A consumer organization group is a collection of consumer organizations, and provides an efficient way of controlling who can see, and subscribe to, the APIs in your Products. By using a consumer organization group, you can define this access for all the developers in the organizations in that group in a single operation, rather than having to define access for the organizations separately.

About this task

A consumer organization group might represent particular business partners, internal organizations, or other groups of application developers.

When you create a Product, you can define which application developers can access the APIs in that Product. You can configure the following types of access:

Visibility, which specifies the application developers who can see the APIs in the Developer Portal.
Subscribability, which specifies the application developers who can create subscribe to use the APIs.

You configure this access by selecting the required consumer organizations, and Consumer organization groups. You can also change the visibility and subscribability settings for a Product after it has been published. For more information, see Creating a draft Product and Changing the availability of a Product.

Procedure

To work with consumer organization groups, you first navigate to the Consumer organization groups page. You then create new groups, send an email to the owners of the consumer organizations in a group, and edit or delete existing groups.

Navigating to the required consumer organization groups page.
1. In the navigation pane of the API Manager UI, click Manage, then select the Catalog that you want to work with.
2. If Spaces are enabled in the Catalog, select the Space that you want to work with by completing the following steps:
  1. Click the Spaces tab.
  2. Select the Space that you want to work with.
3. Click the Consumers tab, then click the options menu in the page header and select Manage Groups.
Creating a consumer organization group.
1. Click Add.
2. Enter a Title for the new group and, optionally, a Summary. A Name is entered automatically. The title is used for display.
3. Use the Search orgs/groups field to search for, and select, the consumer organizations that you want to add to the group.
  
  Note: To prevent excessive search results lists, only the first 10 matches are displayed when you begin typing in the field; lengthen your search string to shorten the list for locating the required consumer organization.
4. Click Save to create the group.
Editing a consumer organization group.
1. Click the options icon for the consumer organization group that you want to work with, then click Edit.
2. Make the required updates, then click Save.
Note: If you remove a consumer organization from a group, and that group is specified in the custom visibility settings for a Product, applications in that consumer organization can no longer subscribe to the Product. However, any existing subscriptions are not affected. For information on managing visibility and subscribability settings, see Editing a draft Product.
Deleting a consumer organization group.
1. Click the options icon for the consumer organization group that you want to work with, then click Delete.
2. Click Confirm to delete the group.
Sending an email to the owners of the consumer organizations in a consumer group
1. Click the options icon for the consumer organization group that you want to work with, then click Message owners.
  The Send message window opens, and the email addresses of the consumer organization owners are displayed as the recipients.
2. Enter the subject of the message in the Subject field.
3. Enter the content of the message in the Message field, then click Send.