In this Articlearticle
Table of Contents | ||||
---|---|---|---|---|
|
Overview
Permissions grant access to assets in the APIM space. You can set permissions for your APIs at different the three levels of the asset hierarchy . When you create an API, you can set permissions at the API and version level in the API Manager console. Clicking the API opens the API Details page. In the Permissions tab, the owner of the API is automatically added as a user.
...
: 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 to 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 see API Management User Permissions.
Adding Permissions
...
in the APIM Space
- In Manager, click API Management > API Manager on the left pane, and then click to view the Add Permission dialog.
- In the Add Permission dialog. , configure the following settings , and then click Add.
User/Group: Select- Username or group: Choose the user or group.
- Access:
- Choose the
- permission type.
- Apply
- access to APIs and versions: Select the checkbox to give permissions at all three levels
- - the
/apim
space, APIs, and Versions.
- Verify that the correct permissions are set for the target user in the API > Permissions tab.
...
Add Permissions
...
to APIs
- Navigate to API Management > API Manager, then select the target API.
- Click the Permissions tab.
- Click to view the Add Permissions dialog window, then select the following options:
User/Group: Select- Username or group: Choose the user or group.
- Access:
- Choose the Permission type.
- Apply
- access to
- all APIs and
- versions: Select
- the checkbox to give permissions to an API and its versions.
- Verify that the correct permissions are set for the target user in the Permissions tab for that API.
...
Add Permissions
...
to Versions
- Navigate to API Management > API Manager, and select the target version of the API.
- Click the Permissions tab.
- Click to view the Add Permissions dialog window, then make the following selections:
- User/Group: Select Username or group: Choose the user or groupStatus: Select the permission type.
- Access: Choose the permission type.
- Apply access to all APIs and versions: Select the checkbox to give permission to all versions of an API.
- User/Group: Select Username or group: Choose the user or groupStatus: Select the permission type.
- Verify that the correct permissions are set for the target user in the Permissions tab for that API version.
...
As an Org admin, you can delete a permission at any level API Manager hierarchy.
Note |
---|
API developers can only set permissions to APIs or versions they own. |
...
- Navigate to the target permission.
- 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 as other assets in the platformIIP. Only the Org Admin and Owner admin, Owner ,and User with Full Access can edit the permissions. Refer to Managing Your Developer Portal Settings for more information.
Users and Groups are created in Manager. Permissions can apply to both users and groups.:
- UserUsername: The email of the user
- Group: <Group_Name>(Group)
The following table provides a matrix for user access at the different levels of the APIM hierarchy.:
User Type | API Details | Version | Permissions |
---|---|---|---|
Org Admin | Edit | Edit | Edit |
User with Read Read access | Read Only | Read Only | Read Only |
User with Read and Execute | Read Only | Read Only | Read Only |
User with Read and Write | Edit | Edit | Read Only |
User with Full Access | Edit | EditRead | OnlyEdit* |
Owner/Full Access | Edit | Edit | Edit |
Info |
---|
A user has Edit* permission when the Allow users with Full-Access permissions to publish checkbox is enabled by the Org admin. |