---
title: Settings and Permissions
description: Understand how to configure API access, visibility, and testing (tryout).
documentId: developer-portal-settings-permissions
locale: en-US
---

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_](#try-out)).
- Define the roles for access control.
- Choose the environment for _tryout_.

![Settings and Permissions tab](https://creative-ball-51b3fc85c0.media.strapiapp.com/api_docs_settings_permissions_a71954ac45.png)

<Callout type="NOTE" title="NOTE">
This configuration is only available for APIs automatically imported with the [connection](/docs/catalogs).
</Callout>

<Callout type="IMPORTANT" title="IMPORTANT">
***Enable Apps Registration** unavailable for HTTP APIs*

If you are configuring an API of type **HTTP**, the **Enable Apps Registration** button will be disabled due to limitations of the current version of the AWS Gateway. Therefore, it is not possible to generate credentials or create Apps for this type of API in the Developer Portal.
</Callout>

See how to:

- [Navigate to the **API Settings** screen](#api-settings).
- [Allow App registration](#enable-registration) for the API.
- [Allow the API to be displayed in the Catalog](#enable-list).
- [Configure the roles](#access-role).
- [Choose environment for _tryout_](#select-tryout).

<a id="dev-portal-api-settings"></a>
<a id="_accessing_the_settings_and_permissions_tab"></a>
## Accessing the Settings and Permissions tab

Follow these steps to access the **Settings and Permissions** tab:

<Steps>
  <Step>
    ### Step 1

    Access the [API Catalog](/docs/developer-portal/api-docs) page by clicking the left side menu or the card on the Developer Portal home screen.
  </Step>
  <Step>
    ### Step 2

    Locate the API you want to test. If necessary, use the search tool.
  </Step>
  <Step>
    ### Step 3

    In the ACTIONS column of the API list, click the ![pencil icon](https://creative-ball-51b3fc85c0.media.strapiapp.com/icon_edit_2_e029ead2c4.png) for the desired API.

    <Callout type="NOTE" title="NOTE">
    The AVAILABILITY column indicates whether:

    - ![icon with a check](https://creative-ball-51b3fc85c0.media.strapiapp.com/icon_available_864a1b0c46.png) the API is available for display in the catalog and for app creation;
    - ![yellow icon with the letter i](https://creative-ball-51b3fc85c0.media.strapiapp.com/icon_unavailable1_51ab43ac53.png) the API is **not** available for display in the catalog **or** (exclusive or) for app creation.
    - ![red icon with the letter i](https://creative-ball-51b3fc85c0.media.strapiapp.com/icon_unavailable2_81a637a941.png) the API is **not** available for display in the catalog **and** (conjunction) for app creation.
    </Callout>
  </Step>
</Steps>

<a id="enable-registration"></a>
<a id="_allowing_app_registration"></a>
## Allowing App Registration

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](https://creative-ball-51b3fc85c0.media.strapiapp.com/enable_registration_bc95158a88.png)

<Callout type="NOTE" title="NOTE">
This option is only available for APIs with native connections.
</Callout>

<a id="enable-list"></a>
<a id="_allowing_the_api_to_be_displayed_in_the_catalog"></a>
## Allowing the API to be Displayed in the Catalog

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](https://creative-ball-51b3fc85c0.media.strapiapp.com/enable_list_577e00f2ed.png)

<a id="access-role"></a>
<a id="_roles"></a>
## Roles

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

Follow these steps to edit role permissions:

<Steps>
  <Step>
    ### Step 1

    Access the **API Catalog** page by clicking the left side menu or the card on the home screen.
  </Step>
  <Step>
    ### Step 2

    Find the desired API and click the ![pencil icon](https://creative-ball-51b3fc85c0.media.strapiapp.com/icon_edit_2_e029ead2c4.png) in the **ACTIONS** column.
  </Step>
  <Step>
    ### Step 3

    Click the **SETTINGS & PERMISSIONS** tab.
  </Step>
  <Step>
    ### Step 4

    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.
  </Step>
</Steps>

<a id="try-out"></a>
<a id="_select_environment_for_tryout"></a>
## Select environment for _tryout_

With _tryout_, you can make calls to the API directly from the documentation. See [how to use _tryout_](/docs/developer-portal/general-info#try-out).

To define the environment for the _tryout_:

<Steps>
  <Step>
    ### Step 1

    Access the **API Catalog** page by clicking the left side menu or the card on the home screen.
  </Step>
  <Step>
    ### Step 2

    Find the desired API and click the ![pencil icon](https://creative-ball-51b3fc85c0.media.strapiapp.com/icon_edit_2_e029ead2c4.png) in the **ACTIONS** column.
  </Step>
  <Step>
    ### Step 3

    Click the **SETTINGS & PERMISSIONS** tab.
  </Step>
  <Step>
    ### Step 4

    Click the **SELECT TRYOUT ENVIRONMENTS** button.
  </Step>
  <Step>
    ### Step 5

    Select one or more environments.
  </Step>
  <Step>
    ### Step 6

    If desired, you can define a default environment. Simply select the option in the **DEFAULT** column.
  </Step>
</Steps>

<Callout type="IMPORTANT" title="IMPORTANT">
The environments available for tryout are named in a standardized way, regardless of the provider, based on the API contract's technical specifications:

- For **OpenAPI 3.x**: the information is obtained from the `servers.url` (address) and `servers.description` (environment name) fields.

- For **Swagger 2.0**: the URL is formed by combining the `scheme`, `host`, and `basePath` fields.

If the contract does not provide an explicit description for the environment, the system uses the URL host as the identifier or automatically searches for keywords (such as prod, dev, or test) to name the environment.
</Callout>