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 nos próprios projetos do Google 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 Console do Google Cloud. Os papéis também podem ser concedidos usando a API ou a Google Cloud CLI.

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

Observação: embora seja possível conceder outros papéis no nível de serviço, recomendamos usar os papéis listados na tabela anterior para gerenciar a API.

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:

Papel	Permissões
Leitor do ApiGateway	apigateway.apiconfigs.get apigateway.apiconfigs.getIamPolicy apigateway.apiconfigs.list apigateway.apis.get apigateway.apis.getIamPolicy apigateway.apis.list apigateway.gateways.get apigateway.gateways.getIamPolicy apigateway.gateways.lista apigateway.locations.get apigateway.locations.list apigateway.operations.get apigateway.operations.list resourcemanager.projects.get resourcemanager.projects.list
Administrador do ApiGateway	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

Observação: para visualizar páginas no console do Google Cloud, você precisa conceder aos usuários o papel visualizador do API Gateway ou um papel superior no nível do projeto.

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.