Détails relatifs à API Gateway
Cette rubrique traite des détails relatifs à l'écriture de stratégies visant à contrôler l'accès à API Gateway.
Types de ressource
Type agrégé de ressource
api-gateway-family
Types individuels de ressource
api-gateways
api-deployments
api-definitions
api-workrequests
api-certificates
api-sdks
api-subscribers
api-usage-plans
Commentaires
Une stratégie qui utilise <verb> api-gateway-family
équivaut à écrire une stratégie avec une instruction <verb> <individual resource-type>
distincte pour chaque type individuel de ressource.
Reportez-vous au tableau dans Détails des combinaisons de verbe et de type de ressource afin d'obtenir des détails sur les opérations d'API couvertes par chaque verbe, pour chaque type individuel de ressource inclus dans api-gateway-family
.
Variables prises en charge
API Gateway prend en charge toutes les variables générales (reportez-vous à Variables générales pour toutes les demandes).
Détails des combinaisons de verbe et de type de ressource
Les tableaux suivants indiquent les droits d'accès et les opérations d'API couverts par chaque verbe. Le niveau d'accès est cumulatif à mesure que vous passez d'un verbe à l'autre de la façon suivante :inspect
> read
> use
> manage
. Par exemple, un groupe qui peut utiliser une ressource peut également inspecter et lire cette ressource. La présence d'un signe plus (+) dans une cellule du tableau indique un accès incrémentiel par rapport à la cellule située directement au-dessus, tandis que la mention "aucun élément supplémentaire" indique l'absence d'accès incrémentiel.
Par exemple, le verbe read
pour le type de ressource api-gateways
inclut les mêmes droits d'accès et opérations d'API que le verbe inspect
, plus le droit d'accès API_GATEWAY_READ et plusieurs opérations d'API (par exemple, GetGateway
). Le verbe use
couvre des droits d'accès et des opérations d'API supplémentaires par rapport à read
. Enfin, manage
couvre davantage de droits d'accès et d'opérations que use
.
Verbes | Droits d'accès | API complètement couvertes | API partiellement couvertes |
---|---|---|---|
inspect | API_GATEWAY_LIST |
ListGateways
|
aucun |
read | INSPECT + API_GATEWAY_READ |
INSPECT +
|
GetDeployment (requiert également read api-deployments )
|
use | READ + API_GATEWAY_ADD_DEPLOYMENT API_GATEWAY_REMOVE_DEPLOYMENT |
aucun élément supplémentaire |
|
manage | USE + API_GATEWAY_CREATE API_GATEWAY_DELETE API_GATEWAY_UPDATE API_GATEWAY_MOVE |
USE +
|
|
Verbes | Droits d'accès | API complètement couvertes | API partiellement couvertes |
---|---|---|---|
inspect | API_DEPLOYMENT_LIST |
ListDeployments
|
aucun |
read | INSPECT + API_DEPLOYMENT_READ |
aucun élément supplémentaire |
GetDeployment (requiert également read api-gateways )
|
use | READ + API_DEPLOYMENT_UPDATE |
aucun élément supplémentaire |
UpdateDeployment (requiert également use api-gateways )
|
manage | USE + API_DEPLOYMENT_CREATE API_DEPLOYMENT_DELETE API_DEPLOYMENT_MOVE |
USE + ChangeDeploymentCompartment
|
CreateDeployment et DeleteDeployment (les deux requièrent également use api-gateways )
|
Verbes | Droits d'accès | API complètement couvertes | API partiellement couvertes |
---|---|---|---|
inspect | API_DEFINITION_LIST |
ListApis
|
aucun |
read | INSPECT + API_DEFINITION_READ |
INSPECT +
|
aucun |
use | READ + API_DEFINITION_UPDATE |
READ +
|
aucun |
manage | USE + API_DEFINITION_CREATE API_DEFINITION_DELETE API_DEPLOYMENT_MOVE |
USE +
|
aucun |
Verbes | Droits d'accès | API complètement couvertes | API partiellement couvertes |
---|---|---|---|
inspect | API_WORK_REQUEST_LIST |
ListWorkRequests
|
aucun |
read | INSPECT + API_WORK_REQUEST_READ |
INSPECT +
|
aucun |
use | READ + API_WORK_REQUEST_CANCEL |
READ +
|
aucun |
manage | aucun élément supplémentaire |
aucun élément supplémentaire |
aucun |
Verbes | Droits d'accès | API complètement couvertes | API partiellement couvertes |
---|---|---|---|
inspect | API_CERTIFICATE_LIST |
ListCertificates
|
aucun |
read | INSPECT + API_CERTIFICATE_READ |
INSPECT +
|
aucun |
use | READ + API_CERTIFICATE_APPLY_TO_GATEWAY |
aucun élément supplémentaire |
|
manage | USE + API_CERTIFICATE_CREATE API_CERTIFICATE_DELETE API_CERTIFICATE_UPDATE API_CERTIFICATE_MOVE |
USE + CreateCertificate DeleteCertificate UpdateCertificate ChangeCertificateCompartment |
aucun |
Verbes | Droits d'accès | API complètement couvertes | API partiellement couvertes |
---|---|---|---|
inspect | API_SDK_LIST |
ListSdks
|
aucun |
read | INSPECT + API_SDK_READ |
INSPECT +
|
aucun |
use | READ + API_SDK_UPDATE |
READ +
|
aucun |
manage | USE + API_SDK_CREATE API_SDK_DELETE |
USE +
|
aucun |
Verbes | Droits d'accès | API complètement couvertes | API partiellement couvertes |
---|---|---|---|
inspect | API_SUBSCRIBER_LIST |
ListSubscribers
|
aucun |
read | INSPECT + API_SUBSCRIBER_READ |
INSPECT +
|
aucun |
use | READ + API_SUBSCRIBER_UPDATE |
aucun élément supplémentaire |
UpdateSubscriber (requiert également read api-usage-plans pour mettre à jour les plans d'utilisation souscrits lors de la mise à jour d'abonné) |
manage | USE + API_SUBSCRIBER_CREATE API_SUBSCRIBER_DELETE API_SUBSCRIBER_MOVE |
USE +
|
|
Verbes | Droits d'accès | API complètement couvertes | API partiellement couvertes |
---|---|---|---|
inspect | API_USAGE_PLAN_LIST |
ListUsagePlans
|
aucun |
read | INSPECT + API_USAGE_PLAN_READ |
INSPECT +
|
aucun |
use | READ + API_USAGE_PLAN_UPDATE |
aucun élément supplémentaire |
UpdateUsagePlan (requiert également read api-deployments pour mettre à jour les déploiements d'API cible dans les habilitations lors de la mise à jour de plan d'utilisation) |
manage | USE + API_USAGE_PLAN_CREATE API_USAGE_PLAN_DELETE API_USAGE_PLAN_MOVE |
USE +
|
|
Droits d'accès requis pour chaque opération d'API
Le tableau suivant répertorie les opérations d'API dans un ordre logique, regroupées par type de ressource. Pour plus d'informations sur les droits d'accès, reportez-vous à Droits d'accès.
Opération d'API | Droits d'accès requis pour utiliser l'opération |
---|---|
ListGateways
|
API_GATEWAY_LIST |
CreateGateway
|
API_GATEWAY_CREATE et API_CERTIFICATE_APPLY_TO_GATEWAY |
GetGateway
|
API_GATEWAY_READ |
UpdateGateway
|
API_GATEWAY_UPDATE |
DeleteGateway
|
API_GATEWAY_DELETE |
ChangeGatewayCompartment
|
API_GATEWAY_READ, API_GATEWAY_UPDATE et API_GATEWAY_MOVE |
ListDeployments
|
API_DEPLOYMENT_LIST |
CreateDeployment
|
API_DEPLOYMENT_CREATE, API_GATEWAY_READ et API_GATEWAY_ADD_DEPLOYMENT |
GetDeployment
|
API_DEPLOYMENT_READ et API_GATEWAY_READ |
UpdateDeployment
|
API_DEPLOYMENT_UPDATE, API_GATEWAY_READ et API_GATEWAY_ADD_DEPLOYMENT |
DeleteDeployment
|
API_DEPLOYMENT_DELETE, API_GATEWAY_READ et API_GATEWAY_REMOVE_DEPLOYMENT |
ChangeDeploymentCompartment
|
API_DEPLOYMENT_READ, API_DEPLOYMENT_UPDATE et 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 est nécessaire pour mettre à jour les plans d'utilisation souscrits lors de la mise à jour d'abonné. |
CreateSubscriber |
API_SUBSCRIBER_CREATE API_USAGE_PLAN_READ est nécessaire pour ajouter les plans d'utilisation souscrits lors de la création d'abonné. |
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 est nécessaire pour mettre à jour les déploiements d'API cible dans les habilitations lors de la mise à jour de plan d'utilisation. |
CreateUsagePlan |
API_USAGE_PLAN_CREATE API_DEPLOYMENT_READ est nécessaire pour ajouter des déploiements d'API cible aux habilitations lors de la création de plan d'utilisation. |
DeleteUsagePlan |
API_USAGE_PLAN_DELETE |
ChangeUsagePlanCompartment |
API_USAGE_PLAN_MOVE |