Skip to main content
Feedback

Managing Portal Access Group Interactive Documentation

This page displays the Portal Access Group Interactive Documentation. On the Developer Portal, the users in a specific Portal Access Group can view and interact with the Interactive Documentation listed on this page.

An Administrator and an API Manager can add or remove Interactive Documentation items to the Portal Access Group, as follows:

  • Area Administrator and API Manager: They can add Interactive Documentation to the Portal Access Groups that belong to specific Organizations and their Sub-Organizations. To add Interactive Documentation to the Portal Access Group, the APIs for which the Interactive Documentation is created and the Portal Access Group must be owned by the same Organization or its Sub-Organization.

  • Organization Administrator and API Manager: They can add Interactive Documentation to the Portal Access Groups that belong to specific Organizations and their Sub-Organizations. To add Interactive Documentation to the Portal Access Group, the APIs for which the Interactive Documentation is created and the Portal Access Group must be owned by the same Organization or its Sub-Organization.

  • Sub-Organization Administrator and API Manager: They can add Interactive Documentation to the Portal Access Groups that belong to the Sub-Organization. To add Interactive Documentation to the Portal Access Group, the APIs for which the Interactive Documentation is created and the Portal Access Group must be owned by the same Sub-Organization.

Adding, Modifying, and Deleting Portal Access Group Interactive Documentation

You can add Interactive Documentation to the Portal Access Group. The users in the Portal Access Groups can then view and interact with the Interactive Documentation on the Developer Portal.

note

You cannot add Interactive Documentation items of different Organizations in the same Portal Access Groups. To add Interactive Documentation to the Portal Access Group, the APIs for which the Interactive Documentation is created and the Portal Access Group must be owned by the same Organization. For the Portal Access Group of the parent Organization, you can add Interactive Documentation of the APIs that are owned by the Sub-Organization. However, Interactive Documentation of the APIs owned by the parent Organization cannot be added to the Portal Access Group of its Sub-Organization.

Procedure

  1. Click Portal Access Group on the Get Started page or navigate to Manage > Portal Access Group. This opens the Manage your Portal Access Groups page.

  2. In the Portal Access Groups Name column, click the portal access group name link or Actions (>) icon next to the row you want to view or add Interactive Documentation to Portal Access Group. This opens the Portal Access Groups Overview:<your pag name> page.

  3. Navigate to Interactive Documentation. This opens the Portal Access Group Interactive Documentation: <your pag name> page.

  4. Click Add Interactive Documentation. This opens the Add Interactive Documentation to Portal Access Group: <your pag name> pop-up window.

    1. In Interactive Documentation that can be added:, select an interactive documentation.

    2. Click the Add (+) icon. The interactive documentation is added to the list. Repeat the above steps to add multiple interactive documentation to build a list for the Portal Access Group.

      You can also remove the added Interactive Documentation from the list by clicking the Remove (-) icon.

  5. Click Apply. The Interactive Documentation is added to the Portal Access Group.

  6. You can also modify Interactive Documentation from Portal Access Group Interactive Documentation: <your pag name> page.

    To modify an Interactive Documentation:

    1. In the Action column, click the Settings icon next to the row you want to modify the Interactive Documentation. This opens Edit Interactive Documentation: <your interactive documentation> page.
    2. Modify the file as required.
    3. Click Save.

    You can also import and edit interactive documentation. Refer to Creating and Editing Interactive Documentation for API Definitions for more information.

  7. You can also delete Interactive Documentation from the Portal Access Group Interactive Documentation: <your pag name> page.

    To remove an Interactive Documentation:

    important

    Only the following roles can delete Interactive Documentation from Portal Access Groups:

    • An Area Administrator and API Manager.

    • An Organization Administrator and API Manager.

    • A Sub-Organization Administrator and API Manager.

    1. In the Title column, select the Interactive Documentation you would like to remove using the checkboxes next to Title, and then click Remove Interactive Documentation.

    2. Click Confirm. The Interactive Documentation is deleted from the Portal Access Group.

On this Page