This documentation is for WSO2 API Manager 2.1.0. View documentation for the latest release.

All docs This doc
Skip to end of metadata
Go to start of metadata

Visibility settings prevent certain user roles from viewing and modifying APIs created by another user role. This feature allows you to restrict the ability to view and modify APIs for a set of users. 

This is available only as a  WUM update and is effective from 6th December 2017 (2017-12-06). For more information on updating WSO2 API Manager, see Updating WSO2 Products.

Enabling Access Control

Shut down WSO2 API Manager before doing the following configurations.

Skip step 1 if you are using WSO2 API Manager 2.1.0 - Update 2 or later

  1. To enable this feature, open the <API-M_HOME>/repository/conf/api-manager.xml file. Add the code given below under <APIPublisher> .


    Follow step 2 and step 3 only if you are enabling this feature for the first time.

  2. Download the Access Control Migration Client from here and copy it to the <API-M_HOME>/repository/components/dropins directory.

  3. Start the server with -DmigrateAccessControl=true. The sample command is given below.

    sh -DmigrateAccessControl=true

Using the API Publisher UI

  1. Log in to API Publisher as an API Creator. For more information on User Roles, see Managing Users and Roles.
  2. Create an API. Select Restricted by roles for Access Control in the Design tab.
  3. Add the roles that have permission to view or modify this API.

    Ensure that the roles you add are valid. If the current creator is not an APIM admin, there should be at least one role of the current creator.

Users with APIM admin permission are treated differently. Even if an API is restricted to certain set of creators of publishers, it will be visible to all the API creators and publishers with the API-M admin permission.

Using the REST API

You can use the existing REST API to add a new API. To create an API with publisher access control restriction, add the two elements shown below in your request body,

"accessControl" : "RESTRICTED",
"accessControlRoles" : ["admin"]

Note that the roles should be valid. If the API creator is not an API-M admin he/she should at least have one of his/her roles in the accessControlRoles field.

This feature is available and enabled by default in WSO2 API Manager - Update 2 or later

The publisher role cache is enabled by default in API Manager. This is to avoid sending repeated requests to the Key Manager node in a distributed deployment, to authenticate user roles.

This WUM update allows you to disable the feature by disabling <EnablePublisherRoleCache> under <CacheConfigurations>. We recommend enabling the elements shown in the example below.


Note that if disabled it results in lowering performance due to repeatedly accessing the Key Manager.

  • No labels