Informations détaillées sur la passerelle d'API
Cette rubrique présente des informations détaillées sur l'écriture de politiques permettant de contrôler l'accès au service Passerelle d'API.
Types de ressource
Type de ressource agrégé
api-gateway-family
Types de ressource individuels
api-gateways
api-deployments
api-definitions
api-workrequests
api-certificates
api-sdks
api-subscribers
api-usage-plans
Commentaires
Une politique utilisant <verb> api-gateway-family
équivaut à une politique ayant un énoncé <verb> <individual resource-type>
distinct pour chacun des types de ressource individuels.
Voir le tableau sous Informations détaillées sur les combinaisons Verbe + Type de ressource pour plus de détails sur les opérations d'API couvertes par chaque verbe, pour chaque type de ressource individuel inclus dans api-gateway-family
.
Variables prises en charge
Le service de passerelle d'API prend en charge toutes les variables générales (voir Variables générales pour toutes les demandes).
Informations détaillées sur les combinaisons Verbe + Type de ressource
Les tableaux suivants présentent les autorisations et les opérations d'API couvertes par chaque verbe. Le niveau d'accès est cumulatif depuis inspect
> read
> use
> manage
. Par exemple, un groupe qui peut utiliser une ressource peut également inspecter et lire cette ressource. Un signe plus (+) dans une cellule de tableau indique un accès incrémentiel comparé à la cellule directement au-dessus, alors que "aucun accès supplémentaire" indique qu'il n'y a aucun accès incrémentiel.
Par exemple, le verbe read
pour le type de ressource api-gateways
inclut les mêmes autorisations et opérations d'API que le verbe inspect
verb, plus l'autorisation API_GATEWAY_READ et un certain nombre d'opérations d'API (par exemple, GetGateway
, etc.). Le verbe use
couvre d'autres autorisations et opérations d'API par rapport à read
. Enfin, manage
couvre d'autres autorisations et opérations par rapport à use
.
Verbes | Autorisations | API entièrement couvertes | API partiellement couvertes |
---|---|---|---|
inspect | API_GATEWAY_LIST |
ListGateways
|
aucune |
read | INSPECT + API_GATEWAY_READ |
INSPECT +
|
GetDeployment (requiert également read api-deployments )
|
use | READ + API_GATEWAY_ADD_DEPLOYMENT API_GATEWAY_REMOVE_DEPLOYMENT |
aucun accès supplémentaire |
|
manage | USE + API_GATEWAY_CREATE API_GATEWAY_DELETE API_GATEWAY_UPDATE API_GATEWAY_MOVE |
USE +
|
|
Verbes | Autorisations | API entièrement couvertes | API partiellement couvertes |
---|---|---|---|
inspect | API_DEPLOYMENT_LIST |
ListDeployments
|
aucune |
read | INSPECT + API_DEPLOYMENT_READ |
aucun accès supplémentaire |
GetDeployment (requiert également read api-gateways )
|
use | READ + API_DEPLOYMENT_UPDATE |
aucun accès 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 | Autorisations | API entièrement couvertes | API partiellement couvertes |
---|---|---|---|
inspect | API_DEFINITION_LIST |
ListApis
|
aucune |
read | INSPECT + API_DEFINITION_READ |
INSPECT +
|
aucune |
use | READ + API_DEFINITION_UPDATE |
READ +
|
aucune |
manage | USE + API_DEFINITION_CREATE API_DEFINITION_DELETE API_DEPLOYMENT_MOVE |
USE +
|
aucune |
Verbes | Autorisations | API entièrement couvertes | API partiellement couvertes |
---|---|---|---|
inspect | API_WORK_REQUEST_LIST |
ListWorkRequests
|
aucune |
read | INSPECT + API_WORK_REQUEST_READ |
INSPECT +
|
aucune |
use | READ + API_WORK_REQUEST_CANCEL |
READ +
|
aucune |
manage | aucun accès supplémentaire |
aucun accès supplémentaire |
aucune |
Verbes | Autorisations | API entièrement couvertes | API partiellement couvertes |
---|---|---|---|
inspect | API_CERTIFICATE_LIST |
ListCertificates
|
aucune |
read | INSPECT + API_CERTIFICATE_READ |
INSPECT +
|
aucune |
use | READ + API_CERTIFICATE_APPLY_TO_GATEWAY |
aucun accès supplémentaire |
|
manage | USE + API_CERTIFICATE_CREATE API_CERTIFICATE_DELETE API_CERTIFICATE_UPDATE API_CERTIFICATE_MOVE |
USE + CreateCertificate DeleteCertificate UpdateCertificate ChangeCertificateCompartment |
aucune |
Verbes | Autorisations | API entièrement couvertes | API partiellement couvertes |
---|---|---|---|
inspect | API_SDK_LIST |
ListSdks
|
aucune |
read | INSPECT + API_SDK_READ |
INSPECT +
|
aucune |
use | READ + API_SDK_UPDATE |
READ +
|
aucune |
manage | USE + API_SDK_CREATE API_SDK_DELETE |
USE +
|
aucune |
Verbes | Autorisations | API entièrement couvertes | API partiellement couvertes |
---|---|---|---|
inspect | API_SUBSCRIBER_LIST |
ListSubscribers
|
aucune |
read | INSPECT + API_SUBSCRIBER_READ |
INSPECT +
|
aucune |
use | READ + API_SUBSCRIBER_UPDATE |
aucun accès supplémentaire |
UpdateSubscriber (requiert également read api-usage-plans pour mettre à jour les plans d'utilisation avec abonnement lors de la mise à jour d'un abonné) |
manage | USE + API_SUBSCRIBER_CREATE API_SUBSCRIBER_DELETE API_SUBSCRIBER_MOVE |
USE +
|
|
Verbes | Autorisations | API entièrement couvertes | API partiellement couvertes |
---|---|---|---|
inspect | API_USAGE_PLAN_LIST |
ListUsagePlans
|
aucune |
read | INSPECT + API_USAGE_PLAN_READ |
INSPECT +
|
aucune |
use | READ + API_USAGE_PLAN_UPDATE |
aucun accès supplémentaire |
UpdateUsagePlan (requiert également read api-deployments pour mettre à jour les déploiements d'API cible dans les droits lors de la mise à jour du plan d'utilisation) |
manage | USE + API_USAGE_PLAN_CREATE API_USAGE_PLAN_DELETE API_USAGE_PLAN_MOVE |
USE +
|
|
Autorisations requises 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 autorisations, voir Autorisations.
Opération d'API | Autorisations requises 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 et API_GATEWAY_UPDATE et API_GATEWAY_MOVE |
ListDeployments
|
API_DEPLOYMENT_LIST |
CreateDeployment
|
API_DEPLOYMENT_CREATE et API_GATEWAY_READ et API_GATEWAY_ADD_DEPLOYMENT |
GetDeployment
|
API_DEPLOYMENT_READ et API_GATEWAY_READ |
UpdateDeployment
|
API_DEPLOYMENT_UPDATE et API_GATEWAY_READ et API_GATEWAY_ADD_DEPLOYMENT |
DeleteDeployment
|
API_DEPLOYMENT_DELETE et API_GATEWAY_READ et API_GATEWAY_REMOVE_DEPLOYMENT |
ChangeDeploymentCompartment
|
API_DEPLOYMENT_READ et 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 avec abonnement lors de la mise à jour de l'abonné. |
CreateSubscriber |
API_SUBSCRIBER_CREATE API_USAGE_PLAN_READ est nécessaire pour ajouter des plans d'utilisation avec abonnement lors de la création d'un 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 droits lors de la mise à jour du plan d'utilisation. |
CreateUsagePlan |
API_USAGE_PLAN_CREATE API_DEPLOYMENT_READ est nécessaire pour ajouter des déploiements d'API cible aux droits lors de la création du plan d'utilisation. |
DeleteUsagePlan |
API_USAGE_PLAN_DELETE |
ChangeUsagePlanCompartment |
API_USAGE_PLAN_MOVE |