Visibility Rules

The visibility rules which are part of Manager features aim to restrict or give access to specific Manager objects, in terms of viewing or editing them.

These objects are APIs, environments, and custom interceptors.

Visibility options

Although the objects (APIs, environments, custom interceptors) contain specificities regarding visibility (we go through them below), the options and the way their work in general apply to all cases.

There are three visibility options, found on object settings pages: Organization, Teams and Only me. Each of them defines a different access scope for the object at hand:

  • Organization: the object will be visible to all users. This option is set by default when creating any new object.

  • Teams: the object will be visible only to the team selected. When this option is chosen, a field to select a team will be enabled and the selection is required (to learn more about creating teams, click here).

  • Only me: the object will be visible only to the user who created it.

If you select the options Teams or Only me when you configure the access scope of any object, the Add Users button will be enabled. Clicking it will bring up a window to select individual users who will also have access to the object (see images below).

visibility add users button
visibility add users
The Super Admin role has permission to view and edit all features (and objects) of the Platform, regardless of the visibility option defined for a given object. You can read more about roles here.

You can see below the specificities of visibility rules for each type of object and some details of the inner workings of the Platform that have to do with visibility options.


Visibility options for APIs are applied in the Context field, on API creation and editing screens.

visibility api

For APIs, visibility rules regard the permission of viewing and editing registered objects.

When the Add Users button is used to give access to individual users (which is enabled when the options Teams or Only me are selected), you can grant permission to either view (Can view) or view and edit (Can edit) the API.

visibility add users api
visibility add users api1


On the Environments page, visibility rules apply to two different fields of environment creation and editing screens: Environment Deployment Permission and Environment Trace Visibility.

visibility environment

The Environment Deployment Permission field is related to the permission to deploy APIs into an environment. Its visibility options can only restrict a user’s capacity to deploy an API into the environment at hand, not affecting viewing the environment or editing its settings.

The Environment Trace Visibility field allows restricting access to tracing logs regarding calls to APIs deployed into a given environment (see more about tracing here).

Custom interceptors

Visibility rules for custom interceptors are applied into the Visibility field, found in the creation/editing modal window in the case of Java interceptors and on the creation/editing screens of JavaScript interceptors.

visibility js interceptor
visibility java interceptor

The visibility section of Custom Interceptor settings can only be accessed via the main menu (Interceptors page). When the interceptor is edited from inside the Flows section of API settings, visibility rules are not displayed for modification.

When users are added individually to the access scope (which can be done when the Teams or Only me options are selected), they will have permission to edit the interceptor.

Special cases

There are specific cases whose behaviour regarding visibility rules is worth noting.

  • Only Me permissions: when an object is registered with the Only me option, other users that have access to it (granted optionally via the Add Users button) may edit the visibility option — changing it to Organization, Teams, or adding other individual users to the access scope — but cannot choose the option Only me. This is to prevent other users from taking hold of the object, becoming its owner.

  • Exclusion of a team linked to a visibility rule: if an object has the Team visibility option selected and its associated team is deleted from the Manager, the visibility option will automatically be set to Only me and only the object’s original creator will be allowed access to it.

  • Exclusion of users who own an object: if the creator of an object is deleted from the Manager by another user, the user who performed the exclusion will become the object’s owner.

Thanks for your feedback!

Share your suggestions with us!
Click here and then [+ Submit idea]