API Gateway API access overview
This page describes the API access control options available to you in API Gateway.
API Gateway uses Identity and Access Management (IAM) to control access to your API. You can grant access to your API at the project level and at the service consumer level. For example, you can:
- Grant access to your API users so they can enable your API in their own Google Cloud project.
- Allow principals to view all API Gateway resources.
- Allow principals to create, update, or delete API Gateway resources.
Roles that control access to services and resources
You can view and grant roles using the permissions panel on the API Gateway > APIs or Gateways detail pages in the Google Cloud console. Roles can also be granted using the API, or with the Google Cloud CLI.
|IAM role name||Role title||Description|
||Service Consumer||Permissions for a Google Account, Google group, or service account to view and enable the API in their own project. See the Service Management API access control topic for information about this role.|
||API Gateway Viewer||Read-only access to an API gateway and its related resources. This role includes permissions to get and list APIs, API configs, gateways, and locations.|
||API Gateway Admin||Full access to an API gateway and its related resources. This role includes permissions to get, create, update, and delete APIs, API configs, gateways, and locations.|
API Gateway permissions and roles
The following table lists the project-level roles that grant access to API Gateway resources and their associated permissions:
|API Gateway Viewer||apigateway.apiconfigs.get
|API Gateway Admin||All permissions included in the API Gateway Viewer role, plus:
If basic or predefined roles do not meet your specific needs, API Gateway supports the use of custom roles. You can use IAM to create custom roles for API Gateway.