Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Visão geral do acesso à API Gateway de API
Nesta página, descrevemos as opções de controle de acesso à API disponíveis no gateway de API.
Visão geral
O API Gateway usa o gerenciamento de identidade e acesso (IAM) para controlar o acesso à API. É possível conceder acesso à API no nível do projeto
e no nível do consumidor de serviço. Por exemplo:
Conceder acesso aos usuários da API para que eles possam ativar a API no próprio
projetoGoogle Cloud .
Permitir que os principais visualizem todos os recursos do gateway de APIs.
Permitir que os principais criem, atualizem ou excluam recursos do gateway de API.
Papéis que controlam o acesso a serviços e recursos
É possível visualizar e conceder papéis usando o painel de permissões nas páginas de detalhes Gateway de API > APIs ou Gateways no Google Cloud console. Os papéis também podem ser concedidos
usando a API ou a CLI do Google Cloud.
Nome do papel do IAM
Título do papel
Descrição
roles/servicemanagement.serviceConsumer
Consumidor de serviço
Permissões para uma Conta do Google, um Grupo do Google ou uma conta de serviço para visualizar
e ativar a API no próprio projeto. Para mais informações sobre esse papel, consulte o tópico Controle de acesso à Service Management API.
roles/apigateway.viewer
Leitor do ApiGateway
Acesso somente leitura a um gateway de API e seus recursos relacionados. Esse papel inclui permissões para receber e listar APIs, configurações de API, gateways e locais.
roles/apigateway.admin
Administrador do ApiGateway
Acesso total a um gateway de API e seus recursos relacionados. Esse papel inclui permissões para receber, criar, atualizar e excluir APIs, configurações de APIs, gateways e locais
Permissões e papéis do gateway de APIs
A tabela a seguir lista os papéis no nível do projeto que concedem acesso aos recursos do gateway de API e as permissões associadas:
Todas as permissões incluídas no papel Visualizador de gateway de API, mais:
apigateway.apiconfigs.create
apigateway.apiconfigs.delete
apigateway.apiconfigs.setIamPolicy
apigateway.apiconfigs.update
apigateway.apis.create
apigateway.apis.delete
apigateway.apis.setIamPolicy
apigateway.apis.update
apigateway.gateways.create
apigateway.gateways.delete
apigateway.gateways.setIamPolicy
apigateway.gateways.update
apigateway.operations.cancel
apigateway.operations.delete
Papéis personalizados
Se os papéis básicos ou predefinidos não atenderem às necessidades específicas, o gateway de API aceitará o uso de papéis personalizados. Use o IAM para criar papéis personalizados para o gateway de API.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-09-03 UTC."],[[["\u003cp\u003eAPI Gateway uses Identity and Access Management (IAM) to control access to APIs, allowing you to grant access at both the project and service consumer levels.\u003c/p\u003e\n"],["\u003cp\u003eThe Service Consumer role permits users to view and enable an API within their own projects.\u003c/p\u003e\n"],["\u003cp\u003eThe API Gateway Viewer role provides read-only access to API gateways and their associated resources, while the API Gateway Admin role grants full access to manage these resources.\u003c/p\u003e\n"],["\u003cp\u003eCustom roles can be created via IAM for more granular control over API Gateway permissions, if the provided roles do not meet your specific needs.\u003c/p\u003e\n"]]],[],null,["# API Gateway API access overview\n===============================\n\nThis page describes the API access control options available to you in API Gateway.\n\nOverview\n--------\n\nAPI Gateway uses\n[Identity and Access Management (IAM)](/iam/docs)\nto control access to your API. You can grant access to your API at the project\nlevel and at the service consumer level. For example,\nyou can:\n\n- Grant access to your API users so they can enable your API in their own Google Cloud project.\n- Allow principals to view all API Gateway resources.\n- Allow principals to create, update, or delete API Gateway resources.\n\nRoles that control access to services and resources\n---------------------------------------------------\n\nYou can view and grant roles using the permissions panel on the **API Gateway** \\\u003e\n**APIs** or **Gateways** detail pages in the Google Cloud console. Roles can also be granted\nusing the API, or with the Google Cloud CLI.\n\n| **Note:** Although you can grant other roles at the service level, we recommend that you use the roles listed in the previous table to manage your API.\n\nAPI Gateway permissions and roles\n---------------------------------\n\nThe following table lists the project-level roles that grant access to API Gateway resources and their associated permissions:\n\n| **Note:** To view pages in the Google Cloud console, you must grant users the **API Gateway Viewer** role or a higher role at the project level.\n\nCustom roles\n------------\n\nIf 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](/iam/docs/creating-custom-roles) for API Gateway."]]
