Point d’entrée d’accès IP

Pour sécuriser l’accès aux données dans un environnement de test Query Service spécifié, utilisez le point de terminaison Accès IP pour gérer les plages d’adresses IP autorisées. Vous pouvez utiliser cette API pour récupérer, configurer ou supprimer des plages d’adresses IP associées à l’ID de votre organisation.

Vous pouvez effectuer les actions suivantes avec l’API d’accès IP :

Ce document couvre les requêtes et réponses que vous pouvez effectuer et recevoir du point de terminaison /security/ip-access.

Récupération de toutes les plages d’adresses IP fetch-all-ip-ranges

Récupérez une liste de toutes les plages d’adresses IP configurées pour votre environnement de test. Si aucune plage d’adresses IP n’est définie, toutes les adresses IP sont autorisées par défaut et la réponse renvoie une liste vide dans allowedIpRanges.

Format d’API

GET /security/ip-access

Requête

curl -X GET https://platform.adobe.io/data/foundation/query/security/ip-access \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse

Une réponse réussie renvoie un état HTTP 200 avec une liste des plages d’adresses IP autorisées de l’environnement de test.

{
  "imsOrg": "{ORG_ID}",
  "sandboxName": "prod",
  "channel": "data_distiller",
  "allowedIpRanges": [
    {"ipRange": "136.23.110.0/23", "description": "VPN-1 gateway IPs"},
    {"ipRange": "101.10.1.1"}
  ]
}

Le tableau suivant fournit une description et un exemple des propriétés du schéma de réponse :

Définition de nouvelles plages d’adresses IP

Remplacez les plages d’adresses IP existantes en définissant une nouvelle liste pour l’environnement de test. Cette opération nécessite une liste complète des plages d’adresses IP, y compris celles qui restent inchangées.

Format d’API

PUT /security/ip-access

Requête

curl -X PUT https://platform.adobe.io/data/foundation/query/security/ip-access \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'Content-Type: application/json' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}' \
 -d '{
     "ipRanges": [
       {"ipRange": "136.23.110.0/23", "description": "VPN-1 gateway IPs"},
       {"ipRange": "17.102.17.0/23", "description": "VPN-2 gateway IPs"},
       {"ipRange": "101.10.1.1"},
       {"ipRange": "163.77.30.9", "description": "Test server IP"}
     ]
   }'

Réponse

Une réponse réussie renvoie un état HTTP 200 avec les détails des plages IP nouvellement configurées.

{
  "imsOrg": "{ORG_ID}",
  "sandboxName": "prod",
  "channel": "data_distiller",
  "allowedIpRanges": [
    {"ipRange": "136.23.110.0/23", "description": "VPN-1 gateway IPs"},
    {"ipRange": "17.102.17.0/23", "description": "VPN-2 gateway IPs"},
    {"ipRange": "101.10.1.1"},
    {"ipRange": "163.77.30.9", "description": "Test server IP"}
  ]
}

Suppression de plages IP delete-ip-ranges

Supprimez toutes les plages d’adresses IP configurées pour l’environnement de test. Cette action supprime les plages d’adresses IP et renvoie la liste d’adresses IP supprimée.

Format d’API

DELETE /security/ip-access

Requête

curl -X DELETE https://platform.adobe.io/data/foundation/query/security/ip-access \
 -H 'Authorization: Bearer {ACCESS_TOKEN}' \
 -H 'x-gw-ims-org-id: {ORG_ID}' \
 -H 'x-api-key: {API_KEY}' \
 -H 'x-sandbox-name: {SANDBOX_NAME}'

Réponse

Une réponse réussie renvoie un état HTTP 200 avec les détails des plages d’adresses IP supprimées.

{
  "imsOrg": "{ORG_ID}",
  "sandboxName": "prod",
  "channel": "data_distiller",
  "deletedIpRanges": [
    {"ipRange": "136.23.110.0/23", "description": "VPN-1 gateway IPs"},
    {"ipRange": "17.102.17.0/23", "description": "VPN-2 gateway IPs"},
    {"ipRange": "101.10.1.1"},
    {"ipRange": "163.77.30.9", "description": "Test server IP"}
  ]
}