Detalhes do API Gateway

Este tópico abrange detalhes de gravação de políticas para controlar o acesso ao serviço API Gateway.

Tipos de Recursos

Agregar Tipo de Recurso

api-gateway-family

Tipos de Recursos Individuais

api-gateways
api-deployments
api-definitions
api-workrequests
api-certificates
api-sdks
api-subscribers
api-usage-plans

Comentários

Uma política que usa <verb> api-gateway-family é equivalente a gravar uma instrução <verb> <individual resource-type> separada para cada um dos tipos de recursos individuais.

Consulte a tabela em Detalhes para Combinações de Verbo + Resource-Type para obter um detalhamento das operações da API abrangidas por cada verbo, para cada resource-type individual incluído em api-gateway-family.

Variáveis Suportadas

O serviço API Gateway suporta todas as variáveis gerais (consulte Variáveis Gerais para Todas as Solicitações).

Detalhes para Combinações de Verbo + Tipo de Recurso

As tabelas a seguir mostram as permissões e operações de API abrangidas por cada verbo. O nível de acesso é cumulativo à medida que você vai de inspect > read > use > manage. Por exemplo, um grupo que pode usar um recurso também pode inspecionar e ler esse recurso. Um sinal de mais (+) em uma célula da tabela indica o acesso incremental comparado à célula diretamente acima dela, enquanto "sem extra" indica acesso incremental.

Por exemplo, o verbo read do tipo de recurso api-gateways inclui as mesmas permissões e operações de API que o verbo inspect, além da permissão API_GATEWAY_READ e diversas operações de API (por exemplo, GetGateway etc.). O verbo use abrange permissões adicionais e operações de API em comparação com read. Por último, manage abrange mais permissões e operações em comparação com use.

api-gateways


Verbos	Permissões	APIs Totalmente Abrangidas	APIs Parcialmente Abrangidas
inspect	API_GATEWAY_LIST	`ListGateways`	none
read	INSPECT + API_GATEWAY_READ	INSPECT + `GetGateway`	`GetDeployment` (também precisa de `read api-deployments`)
use	READ + API_GATEWAY_ADD_DEPLOYMENT API_GATEWAY_REMOVE_DEPLOYMENT	sem extra	`CreateDeployment` e `DeleteDeployment` (também precisam de `manage api-deployments`) `UpdateDeployment` (também precisa de `use api-deployments`)
manage	USE + API_GATEWAY_CREATE API_GATEWAY_DELETE API_GATEWAY_UPDATE API_GATEWAY_MOVE	USE + `DeleteGateway` `UpdateGateway` `ChangeGatewayCompartment`	`CreateGateway` (também precisa de `use api-certificates`)

api-deployments


Verbos	Permissões	APIs Totalmente Abrangidas	APIs Parcialmente Abrangidas
inspect	API_DEPLOYMENT_LIST	`ListDeployments`	none
read	INSPECT + API_DEPLOYMENT_READ	sem extra	`GetDeployment` (também precisa de `read api-gateways`)
use	READ + API_DEPLOYMENT_UPDATE	sem extra	`UpdateDeployment` (também precisa de `use api-gateways`)
manage	USE + API_DEPLOYMENT_CREATE API_DEPLOYMENT_DELETE API_DEPLOYMENT_MOVE	USE + `ChangeDeploymentCompartment`	`CreateDeployment` e `DeleteDeployment` (também precisam de `use api-gateways`)

api-definitions


Verbos	Permissões	APIs Totalmente Abrangidas	APIs Parcialmente Abrangidas
inspect	API_DEFINITION_LIST	`ListApis`	none
read	INSPECT + API_DEFINITION_READ	INSPECT + `GetApi` `GetApiContent` `GetApiDeploymentSpecification` `GetApiValidations`	none
use	READ + API_DEFINITION_UPDATE	READ + `UpdateApi`	none
manage	USE + API_DEFINITION_CREATE API_DEFINITION_DELETE API_DEPLOYMENT_MOVE	USE + `CreateApi` `DeleteApi` `ChangeApiCompartment`	none

api-workrequests


Verbos	Permissões	APIs Totalmente Abrangidas	APIs Parcialmente Abrangidas
inspect	API_WORK_REQUEST_LIST	`ListWorkRequests`	none
read	INSPECT + API_WORK_REQUEST_READ	INSPECT + `GetWorkRequest` `ListWorkRequestErrors` `ListWorkRequestLogs`	none
use	READ + API_WORK_REQUEST_CANCEL	READ + `CancelWorkRequest`	none
manage	sem extra	sem extra	none

api-certificates


Verbos	Permissões	APIs Totalmente Abrangidas	APIs Parcialmente Abrangidas
inspect	API_CERTIFICATE_LIST	`ListCertificates`	none
read	INSPECT + API_CERTIFICATE_READ	INSPECT + `GetCertificate`	none
use	READ + API_CERTIFICATE_APPLY_TO_GATEWAY	sem extra	`CreateGateway` (também precisa de `manage api-gateways`)
manage	USE + API_CERTIFICATE_CREATE API_CERTIFICATE_DELETE API_CERTIFICATE_UPDATE API_CERTIFICATE_MOVE	USE + CreateCertificate DeleteCertificate UpdateCertificate ChangeCertificateCompartment	none

api-sdks


Verbos	Permissões	APIs Totalmente Abrangidas	APIs Parcialmente Abrangidas
inspect	API_SDK_LIST	`ListSdks`	none
read	INSPECT + API_SDK_READ	INSPECT + `GetSdk`	none
use	READ + API_SDK_UPDATE	READ + `UpdateSdk`	none
manage	USE + API_SDK_CREATE API_SDK_DELETE	USE + `CreateSdk` `DeleteSdk` `ListSdkLanguageTypes`	none

api-subscribers


Verbos	Permissões	APIs Totalmente Abrangidas	APIs Parcialmente Abrangidas
inspect	API_SUBSCRIBER_LIST	`ListSubscribers`	none
read	INSPECT + API_SUBSCRIBER_READ	INSPECT + `GetSubscriber`	none
use	READ + API_SUBSCRIBER_UPDATE	sem extra	`UpdateSubscriber` (também precisa de `read api-usage-plans` para atualizar planos de uso assinados durante a atualização do assinante)
manage	USE + API_SUBSCRIBER_CREATE API_SUBSCRIBER_DELETE API_SUBSCRIBER_MOVE	USE + `DeleteSubscriber` `ChangeSubscriberCompartment`	`CreateSubscriber` (também precisa de `read api-usage-plans` para adicionar planos de uso assinados durante a criação do assinante)

api-usage-plans


Verbos	Permissões	APIs Totalmente Abrangidas	APIs Parcialmente Abrangidas
inspect	API_USAGE_PLAN_LIST	`ListUsagePlans`	none
read	INSPECT + API_USAGE_PLAN_READ	INSPECT + `GetUsagePlan`	none
use	READ + API_USAGE_PLAN_UPDATE	sem extra	`UpdateUsagePlan` (também precisa de `read api-deployments` para atualizar implantações de API de destino em direitos durante a atualização do plano de uso)
manage	USE + API_USAGE_PLAN_CREATE API_USAGE_PLAN_DELETE API_USAGE_PLAN_MOVE	USE + `DeleteUsagePlan` `ChangeUsagePlanCompartment`	`CreateUsagePlan` (também precisa de`read api-deployments` para adicionar implantações de API de destino a direitos durante a criação do plano de uso)

Permissões Exigidas para Cada Operação de API

A tabela a seguir lista as operações de API em uma ordem lógica, agrupadas por tipo de recurso.


Operação da API	Permissões Necessárias para Usar a Operação
`ListGateways`	API_GATEWAY_LIST
`CreateGateway`	API_GATEWAY_CREATE e API_CERTIFICATE_APPLY_TO_GATEWAY
`GetGateway`	API_GATEWAY_READ
`UpdateGateway`	API_GATEWAY_UPDATE
`DeleteGateway`	API_GATEWAY_DELETE
`ChangeGatewayCompartment`	API_GATEWAY_READ e API_GATEWAY_UPDATE e API_GATEWAY_MOVE
`ListDeployments`	API_DEPLOYMENT_LIST
`CreateDeployment`	API_DEPLOYMENT_CREATE e API_GATEWAY_READ e API_GATEWAY_ADD_DEPLOYMENT
`GetDeployment`	API_DEPLOYMENT_READ e API_GATEWAY_READ
`UpdateDeployment`	API_DEPLOYMENT_UPDATE e API_GATEWAY_READ e API_GATEWAY_ADD_DEPLOYMENT
`DeleteDeployment`	API_DEPLOYMENT_DELETE e API_GATEWAY_READ e API_GATEWAY_REMOVE_DEPLOYMENT
`ChangeDeploymentCompartment`	API_DEPLOYMENT_READ e API_DEPLOYMENT_UPDATE e API_DEPLOYMENT_MOVE
`ListApis`	API_DEFINITION_LIST
`CreateApi`	API_DEFINITION_CREATE
`GetApi`	API_DEFINITION_READ
`GetApiContent`	API_DEFINITION_READ
`GetApiDeploymentSpecification`	API_DEFINITION_READ
`GetApiValidations`	API_DEFINITION_READ
`UpdateApi`	API_DEFINITION_UPDATE
`DeleteApi`	API_DEFINITION_DELETE
`ChangeApiCompartment`	API_DEFINITION_MOVE
`ListWorkRequests`	API_WORK_REQUEST_LIST
`GetWorkRequest`	API_WORK_REQUEST_READ
`CancelWorkRequest`	API_WORK_REQUEST_CANCEL
`ListWorkRequestErrors`	API_WORK_REQUEST_READ
`ListWorkRequestLogs`	API_WORK_REQUEST_READ
`ListCertificates`	API_CERTIFICATE_LIST
`CreateCertificate`	API_CERTIFICATE_CREATE
`GetCertificate`	API_CERTIFICATE_READ
`UpdateCertificate`	API_CERTIFICATE_UPDATE
`DeleteCertificate`	API_CERTIFICATE_DELETE
`ChangeCertificateCompartment`	API_CERTIFICATE_MOVE
`ListSdks`	API_SDK_LIST
`GetSdk`	API_SDK_READ
`UpdateSdk`	API_SDK_UPDATE
`CreateSdk`	API_SDK_CREATE
`ListSdkLanguageTypes`	API_SDK_CREATE
`DeleteSdk`	API_SDK_DELETE
`ListSubscribers`	API_SUBSCRIBER_LIST
`GetSubscriber`	API_SUBSCRIBER_READ
`UpdateSubscriber`	API_SUBSCRIBER_UPDATE API_USAGE_PLAN_READ é necessária para atualizar planos de uso assinados durante a atualização do assinante.
`CreateSubscriber`	API_SUBSCRIBER_CREATE API_USAGE_PLAN_READ é necessária para adicionar planos de uso assinados durante a criação do assinante.
`DeleteSubscriber`	API_SUBSCRIBER_DELETE
`ChangeSubscriberCompartment`	API_SUBSCRIBER_MOVE
`ListUsagePlans`	API_USAGE_PLAN_LIST
`GetUsagePlan`	API_USAGE_PLAN_READ
`UpdateUsagePlan`	API_USAGE_PLAN_UPDATE API_DEPLOYMENT_READ é necessária para atualizar implantações de API de destino em direitos durante a atualização do plano de uso.
`CreateUsagePlan`	API_USAGE_PLAN_CREATE API_DEPLOYMENT_READ é necessária para adicionar implantações de API de destino a direitos durante a criação do plano de uso.
`DeleteUsagePlan`	API_USAGE_PLAN_DELETE
`ChangeUsagePlanCompartment`	API_USAGE_PLAN_MOVE

Documentação do Oracle Cloud Infrastructure