Creating a developer account to customize API properties

You can allow specific users in the Developer Portal to customize the properties for certain APIs, including APIs that are not viewable by the administrator, or other customizable features, by creating an internal Consumer organization.

Before you begin

You must have administrator access to the Developer Portal to complete this task.

About this task

Every user in the Developer Portal must be a member of a Consumer organization. To enable additional users to be editors of particular content in the Developer Portal, you can create an internal Consumer organization. You can then invite these additional editors to this organization, and assign them a specific role that grants certain editing permissions. For example, the following API properties can be customized by any member of the new Consumer organization that have been assigned the Administrator or Content Author role:
  • Image uploading
  • Tag assignment
  • File attachment
  • Custom field editing

Procedure

To create a new Consumer organization within the Developer Portal, complete the following steps:

  1. Log in to the Developer Portal as an administrator or Content Author.
  2. Click the arrow next to your_organization_name from the Developer Portal home page, and select Create organization.
  3. In the Organization Title field, type the name of the organization that you want, then click Submit.

To invite the editor users to your new organization, complete the following steps:

  1. Switch to your newly created organization by clicking the arrow next to your_current_organization_name, and select your new organization name from the list.
  2. Click the arrow next to your_new_organization_name and select My organization.
    Your new organization page is displayed.
  3. For each new user, click Invite, complete their Email details, and click Submit. Note that you can leave the default role of Developer selected and then change the role later, or you can select the Administrator role now. However, be aware that an administrator is able to perform any task within the Developer Portal that does not involve the creation of APIs, Products, and Apps. You should be careful to ensure that only trusted users are given this access and level of control of your site.
    Each new user will receive an invitation email, and they need to click on the link in the email to activate their Developer Portal account.

To assign the required permissions to the users of your organization, you must log in as an administrator and complete the following steps:

  1. Log in to the Developer Portal as an administrator.
  2. If the administrator dashboard is not displayed, click Manage to display it.
  3. Click People on the administrator dashboard.
  4. Select the check box for the user, or users, to whom you want to give new permissions.
  5. Under the Action heading, select the relevant role from the drop-down list.
    For example, selecting Add the Content Author role to the selected user(s) means they can edit images and content within the Developer Portal.
  6. Click Apply to selected items to update the roles.

What to do next

If you want specific Products or APIs to be customized by the editor users, you must ensure that the relevant Products are visible to the internal Consumer organization that you have created. For more information on how to make a plan visible in API Manager, see Changing the availability of a Product.

Note that you can also create new roles and assign specific permissions to those roles. For more information, see Creating a new role and Assigning permissions to a role.