

Control API Visibility, Subscription Availability and API documentation visibility in the Developer Portal

By default, the APIs created in the API Publisher Portal are visible to anyone (even anonymous users) who visits the Developer Portal. However, API Publishers can control the visibility of APIs using two approaches. API Publishers can select as to which users can view their APIs and which users can subscribe to their APIs.

Control API visibility in the Developer Portal

Visibility settings prevent certain user roles from viewing and modifying APIs created by another user role. API visibility can be one of the following options:

• Public: The API is visible to all users who are registered and anonymous (who use APIs without signing in to the Developer Portal, for example testing and demonstration), and can be advertised in multiple Developer Portals (central and non-ESB stores).
• Restricted by roles: The API is visible to it's tenant domain and only to the user roles that you specify. You should provide the roles separated by commas in the UI or as a cURL parameter when creating or editing the API.
• Visible to my domain: The API is visible to all users who are registered to the API's tenant domain. This option is available only in a multi-tenanted environment. It's not applicable when there is only one active tenant (super tenant) in the system.

Given below is how visibility levels work for users in different roles:

• The API Creator and Publisher roles can see all APIs in their tenant Developer Portal even if you restrict access to them. This is because those roles have permission to view and edit all APIs in the API Publisher, and therefore, do not have to be restricted in the Developer Portal.
• Anonymous users can only see APIs that have the visibility set as Public.
• Registered users can see,
  • public APIs of all tenant domains.
  • all APIs in the registered user's tenant domain as long as the API is not restricted to a role that the user is assigned to.

Control API visibility using the API Publisher

1. Sign in to the API Publisher as an API creator using the following URL:

   https://<localhost>:9443/publisher

2. Create a new API or edit an existing API.

3. Go to Portal Configurations from the left menu and click Basic Info. Then under Developer Portal Visibility select the desired visibility option.

   

4. Save the API.

Control API visibility using the REST API

You can use the existing REST API to control the visibility of the API. Add the following element to the request body, including the relevant visibility,

"visibility" : "PUBLIC"

When using the REST API directly, the visibility options are available as public, private, and restricted.

API visibility level specified in the UI	API visibility level specified in the REST API
Public	public Example: "visibility": "PUBLIC"
Restricted by roles	restricted Example: "visibility" :"RESTRICTED" , visibleRoles :["role1","role2", "role3"]
Visible to my domain	private Example: "visibility": "PRIVATE"

Control Subscription Availability in Developer Portal

Subscription availability can be one of the following options:

• Available to current Tenant Only: only users in the current organization/tenant domain can subscribe to the API.
• Available to All the Tenants: users of all organizations/tenant domains can subscribe to the API.
• Available to Specific Tenants: users of the organizations/tenant domains that you specify, as well as the current tenant domain, can subscribe to the API.

The diagram below depicts the relationship between the API's visibility and subscription availability:

Note

The experience of cross tenant subscriptions is different to what it was in previous versions. For example, if a tenant named "A" visits the Developer Portal of a tenant named "B", the tenant "A" user will need to generate keys again with the key manager of tenant "B". Therefore, a given application created in the Developer Portal by tenant "A" can have different consumer keys for a given key manager type as they generate keys in different tenants.

Info

When using cross-tenant subscriptions, if you are generating access tokens with the Password grant or Code grant, add the following configuration to the <API-M_HOME>/repository/conf/deployment.toml file

[oauth.access_token]
generate_with_sp_tenant_domain = "true"

Control subscription availability using the API Publisher

Note

The subscription availability option will only be displayed if there are tenants in your environment.

Important

By default, the Subscription Availability dropdown list is not displayed in the publisher portal. Add the following configuration to the <API-M_HOME>/repository/conf/deployment.toml file in order to display the Subscription Availability dropdown list.

[apim.devportal]
enable_cross_tenant_subscriptions = true

1. Sign in to the API Publisher as an API creator using the following URL:

   https://<localhost>:9443/publisher

2. Create a new API or edit an existing API.

3. Go to Portal Configurations from the left menu and click Subscriptions, click the Subscription Availability dropdown, and select the desired subscription availability option.

   

4. Save the API.

Control subscription availability using the REST API

You can use the existing REST API to control the subscription availability of the API. Add the following element to the request body including the relevant subscription availability.

"subscriptionAvailability" : "ALL_TENANTS"

When using the REST API directly, the subscription availability options are available as follows:

Subscription visibility level specified in the UI	Subscription visibility level specified in the REST API
Available to current tenant only	CURRENT_TENANT Example: "subscriptionAvailability": "CURRENT_TENANT"
Available to all the tenants	ALL_TENANTS Example: "subscriptionAvailability" :"ALL_TENANTS"
Available to specific tenants	SPECIFIC_TENANTS Example: "subscriptionAvailability": "SPECIFIC_TENANTS", subscriptionAvailableTenants : ["tenant1.com","tenant2.com", "tenant3.com"]

Top