Settings and Permissions

On the Settings and Permissions tab, you can:

Enable App registration and allow the API to be displayed in the Catalog.
Configure the API to allow developers to make calls directly from the documentation (tryout).
Define the roles for access control.
Choose the environment for tryout.

Settings and Permissions tab

This configuration is only available for APIs automatically imported with the connection.

See how to:

Accessing the Settings and Permissions tab

Follow these steps to access the Settings and Permissions tab:

Access the API DOCS page by clicking the left side menu or the card on the Developer Portal home screen.
Locate the API you want to test.
If necessary, use the search tool.

In the ACTIONS column of the API list, click the for the desired API.

The AVAILABILITY column indicates whether:

the API is available for display in the catalog and for app creation;
the API is not available for display in the catalog or (exclusive or) for app creation.
the API is not available for display in the catalog and (conjunction) for app creation.

To allow developers to register their applications in the Developer Portal, simply select the Enable Apps Registration option.

Keep the Enable Apps Registration button disabled if you want to block App registration.

location of the toggle to enable Apps registration

This option is only available for APIs with native connections.

To allow the API to be displayed in the Catalog, simply select the Enable in Portal Catalog option.

If you prefer that the API is not displayed in the Catalog, keep the Enable in Portal Catalog button disabled.

location of the toggle to enable API display in the Catalog

You can define one or more roles that can have access to the API documentation listed in API Docs.

Follow these steps to edit role permissions:

Access the API Docs page by clicking the left side menu or the card on the home screen.
Find the desired API and click the in the ACTIONS column.
Click the SETTTINGS & PERMISSIONS tab.
In the ROLES field, select one or more roles.
To view the API documentation, the user will need to have one of these roles.
A user who has a role that is not listed here will not be able to access the API.

api docs update screen with settings and permissions tab and roles field highlighted

With tryout, you can make calls to the API directly from the documentation. See how to use tryout.

To define the environment for the tryout:

Access the API Docs page by clicking the left side menu or the card on the home screen.
Find the desired API and click the in the ACTIONS column.
Click the SETTTINGS & PERMISSIONS tab.
Click the SELECT TRYOUT ENVIRONMENTS button.
Select one or more environments.
If desired, you can define a default environment. Simply select the option in the DEFAULT column.

Thanks for your feedback!

EDIT