Creating a consumer organization

If you have permission to manage developers, you can create new consumer organizations in a Catalog. consumer organizations contain the application developers that subscribe to use the APIs that are published to the Catalog

Before you begin

Your IBM® API Connect Developer Portal must be enabled to perform this task. For more information, see Creating and configuring Catalogs.

To complete this task, you must be defined as a member in a catalog or space (if spaces are enabled), and you must be assigned a role that has the Consumer-Org > Manage permission. For more information, see Adding provider organization users and assigning roles and Managing catalog membership.

About this task

You can create a consumer organization in either of the following ways:

  • Invite a user to be a consumer organization owner, in which case they receive an invitation email with an activation link, and can complete the creation of the consumer organization and specify the title.
  • Create the consumer organization yourself, specifying the owner and title. There are two ways you can specify the owner:
    • Specify the user ID of an existing user.
    • If you are using a Local User Registry, specify a new user ID; the user is added to the registry and becomes the owner of the consumer organization.

If Spaces are enabled in your Catalog, when you create a consumer organization, it is added to the Catalog and its Spaces. For more information about enabling Spaces, see Using syndication in API Connect.

Procedure

  1. In the navigation pane of the API Manager UI, click Manage icon in the API Manager UI navigation pane Manage, then select the catalog that you want to work with.
  2. Optional: 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.
    For more information about enabling spaces, see Using syndication in API Connect.
  3. In the navigation pane of the API Manager UI, click the Consumers tab.
  4. To invite a user to be a consumer organization owner, complete the following steps:
    1. Click Add > Invite organization owner.
    2. Enter the email address of the organization owner.
    3. Click Invite.
    The new consumer organization is added to the list, and an email invitation is sent to the owner; by using the activation link, the owner specifies the title of the organization. The status is shown as Pending until the recipient of the email clicks the link in the email to complete the creation of their Developer Portal account, after which the status changes to Enabled.
  5. To create the consumer organization yourself, complete the following steps:
    1. Click Add > Create organization.
    2. Enter the organization Title. A Name is entered automatically.
      The value in the Name field is a single string that is used to identify the consumer organization in developer toolkit CLI commands. The title is used for display.

      To view the CLI commands to manage consumer organizations, see the toolkit CLI reference documentation.

    3. Select the required user registry.
    4. Specify the organization owner; complete one or other of the following steps, either to specify an existing user, or to create a new user:
      • To specify the user ID of an existing API Connect user who is in the selected user registry, complete the following steps:
        1. For the Type of user, select Existing.
        2. In the Username field, enter the user ID of the organization owner

          After the consumer organization is created, the specified user can immediately log in to the Developer Portal associated with the Catalog.

      • If you selected a Local User Registry, then to specify a new user ID, complete the following steps:
        1. For the Type of user, select New User.
        2. In the Username field, enter the new user ID.
        3. Enter the Email, First Name, Last Name, and Password.

          After the consumer organization is created, the new user will have been added to the selected registry and can immediately log in to the Developer Portal associated with the Catalog, by using the specified user ID and password.

    5. Click Create to complete the creation of the consumer organization.