Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Vista geral do acesso à API do API Gateway
Esta página descreve as opções de controlo de acesso à API disponíveis no API Gateway.
Vista geral
O API Gateway usa a
gestão de identidade e de acesso (IAM)
para controlar o acesso à sua API. Pode conceder acesso à sua API ao nível do projeto e ao nível do consumidor de serviços. Por exemplo,
pode:
Conceda acesso aos seus utilizadores da API para que possam ativar a sua API no respetivo
Google Cloud projeto.
Permitir que os diretores vejam todos os recursos do gateway da API.
Permitir que os diretores criem, atualizem ou eliminem recursos do gateway da API.
Funções que controlam o acesso a serviços e recursos
Pode ver e conceder funções através do painel de autorizações nas páginas de detalhes de API Gateway > APIs ou Gateways na Google Cloud consola. As funções também podem ser concedidas através da API ou da CLI Google Cloud.
Nome da função de IAM
Título da função
Descrição
roles/servicemanagement.serviceConsumer
Consumidor de serviços
Autorizações para uma Conta Google, um grupo Google ou uma conta de serviço para ver
e ativar a API no respetivo projeto. Consulte o tópico
Controlo de acesso da API Service Management para ver informações sobre esta função.
roles/apigateway.viewer
Visualizador do API Gateway
Acesso só de leitura a um gateway da API e aos respetivos recursos relacionados. Esta função inclui autorizações para obter e listar APIs, configurações de APIs, gateways e localizações.
roles/apigateway.admin
Administração do API Gateway
Acesso total a um gateway da API e aos respetivos recursos relacionados. Esta função inclui autorizações para obter, criar, atualizar e eliminar APIs, configurações de APIs, gateways e localizações.
Autorizações e funções do API Gateway
A tabela seguinte apresenta as funções ao nível do projeto que concedem acesso aos recursos do gateway da API e as respetivas autorizações associadas:
Todas as autorizações incluídas na função Leitor do API Gateway, além das seguintes:
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
Funções personalizadas
Se as funções básicas ou predefinidas não satisfizerem as suas necessidades específicas, o API Gateway suporta a utilização de funções personalizadas. Pode usar o IAM para criar funções personalizadas para o API Gateway.
[[["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-08-19 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."]]