Visibility

Configure and manage API visibility options.

Table of Contents

1. How does the API visibility option work?
2. What API License visibility options are supported for Groups?
3. How do I edit the API visibility scope for a Group (API Administrator)?
4. How do I create an API Context Group?
5. What happens after I accept an invitation to an API Context Group?
6. What about API documentation visibility?

How does the API visibility option work?

The API > Visibility menu option allows API Administrators to control who can see the API and its associated resources such as documentation and downloadable files. The API Admin can invite groups to have visibility of the API resources. The following group visibility scenarios are supported:

Scenario	Description
Visibility: Public No Private Scopes.	API is Public; everyone can see it The API does not include any Scopes that are defined as Private. The Visibility section is available for the API. If "Support Scope Permissions" is not enabled for this API, the "Scope Permissions feature is not enabled for this API" message displays on the Visibility home page. If "Support Scope Permissions" is enabled the "This API is completely public and does not have any private sections. There is no need to invite users or groups to see the API." message displays and a listing of Licenses and Scopes (if applicable) displays on the Visibility home page.
Visibility: Public Some Private Scopes	API is Public but some Scopes of the API are defined as Private. Only invited users can see the documentation related to the private sections of the API. APIs > Visibility page includes a table that displays the Private Scopes with the operations that belong to the Scopes and the Licenses that the Scopes are a part of. When inviting Groups to the Private sections of the API, select the Licenses based on the operations that should be visible to the users.
Visibility: Registered Users No Private Scopes.	All users who are logged in can see the API. The API does not include any Scopes that are defined as Private. The Visibility section is available for the API. If "Support Scope Permissions" is not enabled for this API, the "Scope Permissions feature is not enabled for this API" message displays on the Visibility home page. If "Support Scope Permissions" is enabled the "This API is completely public and does not have any private sections. There is no need to invite users or groups to see the API." message displays and a listing of Licenses and Scopes (if applicable) displays on the Visibility home page.
Visibility: Registered Users Some Private Scopes	All users who are logged in can see the API, but some Scopes of the API are defined as Private. Only invited users can see the documentation related to the private sections of the API. APIs > Visibility page includes a table that displays the Private Scopes with the operations that belong to the Scopes and the Licenses that the Scopes are a part of. When inviting Groups to the Private sections of the API, select the Licenses based on the operations that should be visible to the users.
Visibility: Private No private Scopes	API is Private. Groups must be invited to see the API.
Visibility: Private Some Private Scopes	API is Private. Groups need to be invited to be able to see the API. Parts of the API require specific invitations for users to see these sections. APIs > Visibility page includes a table that displays the Private Scopes with the operations that belong to the resources and the Licenses that the Scopes are a part of.

Back to top

What API License visibility options are supported for Groups?

The APIs > Visibility > Groups screen displays a list of API Groups that are members of the current API.

• If you would like to manage the visibility of Licenses that an API Group can see for an API Version, you can configure the visibility using the Edit Scope function.
• Note that when an API Group is invited to an API Version, only Public Scopes will be included in the scope.

Note that the API Administrator can update the license scope configuration for Group Visibility at any time prior to the API Access Request being approved by the API Administrator. Once the API Access Request is approved the Edit Scope function is disabled.

The following license scope levels are supported.

Scope Level	Description
Unrestricted Access	This option implies all of the API documentation/Downloads will be visible to an API Group. All licenses will be available to select as an API Access Request scope when requesting API access for an app.
Restricted Access	This option gives the API Group a set of licenses as part of the visibility scope. A selection of Licenses are presented that can be made visible to a Group by clicking the checkbox.

To configure license visibility for an API Group:

1. Navigate to API > Visibility > Groups. The Groups Summary page displays.
2. Select a Group you would like to edit the scope for and click Edit Scope. The Edit Scope pop-up menu displays.
3. Based on your visibility requirements, click the Unrestricted Access or Restricted Access radio button. Click OK to commit your changes.

Back to top

How do I edit the API visibility scope for a Group (API Administrator)?

An API Administrator can change the API license visibility for a specific Group.

To edit the license scope for Groups:

1. Go to APIs > Visibility > Groups. The Groups Summary page displays.
2. Select a Group from the listing and click Edit Scope. The Edit Scope page displays.
3. Click the radio button of the License access option you would like to assign to the current Group. The following options are available:

   License Option	Description
   Unrestricted Access	This option implies all of the API documentation/Downloads will be visible to an API Group. All licenses will be available to select as an API Access Request scope when requesting API access for an app.
   Restricted Access	This option gives the API Group a set of licenses as part of the visibility scope. Click the checkbox to select the Licenses you would like to make visible to the current Group.

4. Click Save to commit your changes.

Back to top

Groups:

How do I create an API Context Group?

If you've added a Private API (visibility = Private), the platform provides an API Context Group collaboration function via the API > Groups page. For more information about working with groups, see Groups.

Back to top

What happens after I accept an invitation to an API Context Group?

If you receive an invitation to an API Context Group, and accept the invitation:

• You become an API Context Group member.
• The API will be visible in the My APIs section.
• The Access function will be available on the API > Details page of the API.
• If you are a Leader of the API Context Group, the Groups page in the APIs section will display your group membership (with Leader role), and a list of members you have personally invited to the API Context Group.

Back to top

What about API documentation visibility?

If your API has restricted visibility, users who don't have visibility of the API will not see your API documentation.

If your API uses licenses, users who have visibility of the API as a whole might not have access to certain operations, depending on the licenses they've selected. In this scenario, you'll need to apply special tags to your API documentation to make sure that users will see the documentation they have access to. By default, untagged API doc content is hidden.

For information on tagging your API documentation, including the different types of tags available, implementation suggestions, and examples, see API Documentation Tagging.

Tip: If you don't care about hiding portions of your API documentation, see My API uses licenses, but I just want my documentation to be visible to everyone. What's the easiest way to set that up?

Back to top