Introduction
This section guides the Administrator on how to set default global options for the visibility of certain entities of the Platform in their Catalogs: APIs, other Digital Products and Documents. These defaults can always be overridden within each entity, in its Visibility tab.
Entities of the Platform are always associated with an Organization. For example, by default, members of an internal Organization have complete visibility of the API Products exposed in the catalogs, while members of external Organizations will only be able to view in the catalog the API Products included in their visibility cone.
The settings in the following chapters explain how to edit such default visibility cones by:
Different stakeholder types: this cone is the broadest, and allows you to extend visibility to whole user types without having to specify the Organizations they may belong to or their categories.
Internal: Users who belong to internal Organizations. They are involved in the end-to-end governance of the entities of the Platform (digital products, Apps…).
Partner: Users who belong to Partner Organizations.
Citizen: Users who belong to Citizen Organizations.
Guests (Full Access): Users who belong to no organization, but have registered on the Platform. NOTE: Entities that are given Full Access are going to be visible to such users.
Visitors (Full Access): Users who are not logged into the Platform. NOTE: This applies only if the Public Showcase is enabled for your installation. Entities that are given Full Access are going to be visible to such users.
Users in Organizations with certain Categories: this is useful if you expect more Organizations to be onboarded and you want to extend visibility to them as soon as they are categorized, without having to specify them each time.
Users of specified Organizations: specifies the exact Organizations to whom to extend visibility, if you want to be careful not to overextend visibility of an entity.
NOTE: The settings for the three visibility cones add up (they follow an "OR" logic).
These configurations can be found from the sidebar menu, under Administration > Access Management > Visibility, with one tab for each kind of entity: API, Digital Product and Documentation.
API Default Visibility
This configuration allows for management and full control over the default visibility that will be inherited by all API Products in the Catalog. There are two different sections to configure: Organizations and Statuses and Environments.
Organizations: define which organization types, organization categories or specific organizations can see APIs in the Catalog by default. Choosing from:
Full Access: APIs will be public, all users will be able to see them, including Guests and Visitors.
Custom Access: the API visibility will be restricted by organization type, category or specific selected organizations.
Statuses and Environments: the admin can set the visibility of API Products displayed in the catalog by explicitly indicating which lifecycle status should be visible for each user type. Additionally, for published statuses, it is possible to specify the environments in which the API must have been deployed to be visible in the catalog.
NOTE: The selection of access type in Organizations also influences the Statuses and Environments section.
NOTE2: These settings can always be overridden for each API in the related section and changing these settings in the Administration will not clear the overrides already in place on specific APIs. If not overridden and set to Default, the visibility of APIs will follow the default if it changes.
Steps – Full Access:
Navigate to Administration > Access Management > Visibility.
Select the API visibility tab.
Choose API Visibility Settings access type Full.
Click Save.
Steps – Custom Access:
Navigate to Administration > Access Management > Visibility.
Select the API visibility tab.
Choose API Visibility Settings access type Custom.
In the Organizations settings:
Organization Types: click on the edit button in the section titled "Organization Types", add or remove any number of organization types from the drop-down menu, and save.
Organization Categories: click on the edit button in the section titled "Organization Categories", select any number of organization categories from those listed in the available side (you can find any organization category by using the search bar), and save.
Specific Organizations: click on the edit button in the section titled "Specific Organizations", select any number of organization names from those listed in the available side (you can find any organization by using the search bar), and save.
In Statuses and Environments, choose for each organization type the lifecycle statuses and the environments in which APIs appear in the catalog.
Click Save.
Digital Product Default Visibility
NOTE: Digital products other than APIs (such as MCP servers, AI Agents and custom types) are available only if enabled for your installation.
This configuration provides management and control over the default visibility that will be inherited by all digital products other than APIs. It works like the API Default Visibility, with two sections: Organizations (Full Access or Custom Access, by organization type, organization category or specific organization) and Statuses, where you choose in which lifecycle statuses (Idea, In Progress, Published, Retired) the digital products appear in the catalog for each organization type.
NOTE: These settings can be overridden for each digital product in its own Visibility tab, where the visibility of its documentation can also be set.
Steps:
Navigate to Administration > Access Management > Visibility.
Select the Digital Product visibility tab.
Choose the access type Full or Custom.
With Custom access, edit the Organization Types, Organization Categories and Specific Organizations sections as described for APIs.
In Statuses, choose the visible statuses for each organization type.
Click Save.
Documentation Default Visibility
This section provides management and control over the default visibility that will be inherited by all Global Documentation and its specific Pages.
You may define which organization types, organization categories or specific organizations can see the documentation by default. Choosing from:
Full Access: documentation will be public, all users will be able to see it, including guests.
Custom Access: the documentation visibility will be restricted by:
Organization Types: types of organizations that can access the documentation on its dedicated page.
Organization Categories: categories of organizations that can access the documentation on its dedicated page.
Specific Organizations: specific organizations to which access to the documentation on its dedicated page is provided.
These three sections ensure that the Documentation is visible if the organization to which the user attempting to access it belongs meets at least one of the specified conditions.
NOTE: These settings can always be overridden for each Document and Page in the related section and changing these settings in the Administration will not clear the overrides already in place on specific documents. If not overridden and set to Default, the visibility of documents will follow the default if it changes. On a single document, an additional Public access type makes it visible also to Visitors, if the Public Showcase is enabled for your installation.
Steps – Full Access:
Navigate to Administration > Access Management > Visibility.
Select the Documentation visibility tab.
Choose Documentation Visibility Settings access type Full.
Click Save.
Steps – Custom Access:
Navigate to Administration > Access Management > Visibility.
Select the Documentation visibility tab.
Choose Documentation Visibility Settings access type Custom.
Edit the Organization Types, Organization Categories and Specific Organizations sections as described for APIs.
Click Save.