Managing API Grants
API grants allow you to issue fine-grained permissions to users or groups for specific APIs.
Understanding API Grants
API grants are issued per API.
Users and groups issued grants for a specific API have the privileges to perform the associated actions on that API. See Issuing API Grants to issue API grants.
Grant Name | Description | Can Be Issued To | Associated Actions |
---|---|---|---|
Manage API |
People issued this grant are allowed to modify the definition of and issue grants for this API. |
API Managers |
APIDelete APIViewAllDetails APIViewPublicDetails APIEdit APIEditPublic APIModifyPublishState APIModifyLifecycleState APIDeploy APIGrantManageAPI APIGrantViewAllDetails APIGrantViewPublicDetails APIGrantDeployAPI |
View all details |
People issued this grant are allowed to view all information about this API in the Management Portal. |
API Managers, Gateway Managers, Plan Managers |
APIViewAllDetails |
View public details |
People issued this grant are allowed to view the publicly available details of this API on the Developer Portal. This grant can be issued to users of any role. |
API Managers, Application Developers, Plan Managers |
APIViewPublicDetails |
Entitle API |
Users issued this grant are allowed to entitle this API to a plan for which they have entitle rights. |
API Managers, Plan Managers |
APIEntitlementAdd APIEntitlementEdit APIEntitlementRemove APIEntitlementModifyState APIEntitlementModifyPublishState |
Deploy API |
API Managers with the Manage API grant already have this permission for all gateways they are allowed to view. API Managers without the Manage API grant and Gateway Managers issued this grant are allowed to deploy or undeploy this API to a gateway for which they have deploy rights. This allows Gateway Managers to deploy this API without first receiving a request from an API Manager. |
API Managers, Gateway Managers |
APIDeploy |