Control access to your API docs
Last updated on
31 May 2019
Control access to API Doc pages
You can allow anonymous users to view published API documentation pages in your developer portal, or restrict documentation to registered users, by controlling access through user permissions. To enable or restrict access:
- Log in to your portal as a user with admin or content creation privileges.
- Navigate to People > Permissions > Apigee API Catalog > View published API docs in the Drupal admin menu.
- Select the desired permissions for each user role.
- Click Save permissions.
Control access to the API Catalog page
You can also implement role-based access to the APIs landing page, which displays all of the published API Docs in your portal. To enable or restrict access:
- Log in to your portal as a user with admin or content creation privileges.
- Navigate to Structure > Views > API Catalog in the Drupal admin menu.
- In the Page Settings section, click Access: Permission to configure access to the page based on permission or role.
- Click Apply.
- Click Save.
Help improve this page
Page status: No known problems
You can:
You can:
- Log in, click Edit, and edit this page
- Log in, click Discuss, update the Page status value, and suggest an improvement
- Log in and create a Documentation issue with your suggestion