Manage Gateway Grants

Gateway grants allow you to issue fine-grained permissions to users or groups for specific gateways.

Understand Gateway Grants

Gateway grants are issued per gateway.

Users issued grants for a specific gateway have the privileges to perform the associated actions on that gateway.

Grant Name Description Can be Issued To Associated Actions

Manage Gateway

People issued this grant are allowed to manage API deployments to this gateway and manage the gateway itself.

Gateway Managers

GatewayManage

GatewayViewAllDetails

GatewayDeploy

GatewayRequestDeploy

GatewayApproveDeployRequest

GatewayGrantManageGateway

GatewayGrantViewGateway

GatewayGrantDeployAPI

GatewayGrantRequestDeployAPI

View all details

People issued this grant are allowed to view all information about this gateway

Gateway Managers, API Managers, Plan Managers

GatewayViewAllDetails

Deploy to Gateway

People issued this grant are allowed to deploy or undeploy APIs to this gateway.

Gateway Managers, API Managers

GatewayDeploy

GatewayRequestDeploy

Request Deployment to Gateway

People issued this grant are allowed to request API deployments to this gateway. Requests must be approved by a Gateway Manager

API Managers

GatewayRequestDeploy

Entitle Gateway In Plan

People issued this grant are allowed to entitle this gateway to a plan.

Plan Manager

GatewayEntitle

Node Service Account

Gateway Runtime service accounts are issued this grant to allow them to download configuration and upload statistics.

GatewayRuntime

GatewayRetrieveConfiguration

GatewayUploadStatistics

Issue Gateway Grants

Issue gateway grants to users or groups to determine what actions assignees can perform with that gateway. Grants are issued per gateway; repeat this task for each gateway you want to issue grants for.
Gateway Managers must be issued the Manage Gateway grant to a gateway to issue grants for it.
  1. From the Gateways List page, click the name of the gateway for which you want to manage grants.
  2. Click the Grants icon (Grants) tab.
  3. Click the tab that corresponds to the grant you want to issue to users or groups:
    • Manage Gateway: Gateway Manager users issued this grant are allowed to manage API deployments to this gateway and manage the gateway itself.
    • View All Details: API ,Gateway, an Plan Manager users issued this grant are allowed to view all information about this gateway.
    • Deploy to Gateway: API and Gateway Manager users issued this grant are allowed to deploy or undeploy APIs to this gateway.
    • Request Deployment to Gateway: API Manager users issued this grant are allowed to request API deployments to this gateway. Requests must be approved by a Gateway Manager.
    • Entitle Gateway in Plan: Users issued this grant are allowed to entitle this gateway to a plan.
    • Node Service Account: Gateway Runtime service accounts are issued this grant to allow them to download configuration and upload statistics.
  4. Click Add Grantee.
    The Add Grantee dialog appears.
  5. From the Add Grantee dialog, select the user(s) or group(s) to which you want to issue the grant. You can select multiple users and groups.

    You cannot select users or groups that already have this grant; they are greyed out in the Add Grantee dialog.

  6. Click Add.