In this article

Overview

Permissions grant access to assets in the APIM space. You can set permissions at the three levels of the asset hierarchy in the API Manager console: the /apim space, APIs, and Versions. The Permissions tab for all three levels lists the username or group permission is assigned to, the access type of the permission, and if it applies to all APIs and Versions.

As an Org admin, you can set permissions for users at the /apim space level in addition to the APIs and versions for users and groups. When you create an API, you can set permissions at the API and version levels. The owner of the API is automatically added as a user.

Access Types

The API Manager console has the following permission types:

• Owner/Full Access: Automatically assigned to the creator of an API asset or version. Accordingly, you cannot select this option.
• Read and Execute: Select to give access to view API assets and call API endpoints.
• Read Only: Select to give access to view API assets.
• Read and Write: Select to give read and write access to API assets.
• Full Access: Select to give permissions to view, create, modify, and call API calls.

For details, see API Management User Permissions.

Adding Permissions in the APIM Space

1. In Manager, click API Management > API Manager on the left pane, and then click  to view the Add Permission dialog.
   
   
   
   
2.  In the Add Permission dialog, configure the following settings and then click Add.
   
   • Username or group: The user or group.
   • Access: The Permission type.
   • Apply access to APIs and versions: Global access at all three levels: APIM, APIs, and Versions.
     
     
     
     
3. Verify that the correct permissions are set for the target user in the API > Permissions tab.

Add Permissions to APIs

1. Navigate to API Management > API Manager, then select the target API.
   
   
2. Click the Permissions tab.
   
   
3. Click  to view the Add Permissions dialog window, then select the following options:
   
   • Username or group: Select the user or group.
   • Access: Select the Permission type.
   • Apply access to all APIs and versions: Select to make the permission status global for the user at all three levels: API Manager console, APIs, and versions.
     
     
     
     
4. Verify that the correct permissions are set for the target user in the Permissions tab for that API.

Add Permissions to Versions

1. Navigate to API Management > API Manager, and select the target version of the API.
   
   
2. Click the Permissions tab.
   
   
   
   
3. Click  to view the Add Permissions dialog window, then make the following selections:
   
   • Username or group: Select the user or group
   • Access: Select the permission type.
     
     
     
     
4. Verify that the correct permissions are set for the target user in the Permissions tab for that API version.

Deleting a Permission

As an Org admin, you can delete a permission at any level. 

To delete a permission:

1. Navigate to the target permission.
2. Click  to delete the permission from a version, API, or the API Manager console.
   The following image shows the delete icon at the version level.
   
   
   

API Management User Permissions

In the API Management feature, permissions are based on the same model for other assets in the platform. Only the Org Admin and Owner can edit the permissions. Users and Groups are created in Manager.

Permissions can apply to both users and groups.

• User: The email of the user
• Group: <Group_Name>(Group)

The following table provides a matrix for access at the different levels of the APIM hierarchy.