Gérer le masquage des informations permettant d'identifier personnellement les utilisateurs dans les bundles de flux partagés et de proxy

Vous consultez la documentation Apigee Edge.
Accédez à la documentation**Apigee X**.
info

Gérer le masquage des informations personnelles dans les bundles de proxy et de flux partagés

Dans le cadre du processus de synchronisation, l'intégration du connecteur API Hub importe vos bundles de proxy d'API dans API Hub. Ces bundles peuvent contenir des données sensibles ou des informations permettant d'identifier personnellement l'utilisateur (PII) dans les configurations de règles. Cette fonctionnalité vous permet de masquer les champs d'informations personnelles identifiés avant que les bundles ne soient importés dans API Hub.

Approche de masquage

Le masquage des informations personnelles est appliqué à l'aide d'expressions XPath pour cibler des éléments spécifiques dans les configurations de règles des bundles de proxy et de flux partagés au format XML, mais pas à d'autres éléments XML généraux du bundle. Cette fonctionnalité est divisée en deux parties :

Masques par défaut

Apigee Edge inclut une liste prédéfinie et intégrée d'expressions XPath qui ciblent automatiquement les champs d'informations personnelles courants. Ces masques sont appliqués automatiquement lors du processus d'importation.

Liste des masques par défaut :

Nom de la règle Description du champ (ou de la valeur) Expression(s) XPath
AccessEntity Identifiant d'entité //AccessEntity/EntityIdentifier
AccessEntity Identifiant secondaire //AccessEntity/SecondaryIdentifier
BasicAuthentication Valeur du champ utilisateur //BasicAuthentication/User
BasicAuthentication Valeur du champ mot de passe //BasicAuthentication/Password
ConnectorCallout Corps de la requête JSON à envoyer à l'extension //ConnectorCallout/Input
FlowCallout Valeurs des paramètres transmis à l'appel de flux //FlowCallout/Parameter
//FlowCallout/Parameters/Parameter
HMAC Clé secrète utilisée pour le calcul HMAC //HMAC/SecretKey
HMAC Contenu du message à signer //HMAC/Message
HMAC Valeur de validation HMAC //HMAC/VerificationValue
JavaCallout Propriétés transmises (configuration/données sensibles) //JavaCallout/Properties/Property
Javascript Source intégrée //Javascript/Source
Javascript Valeurs des propriétés //Javascript/Properties/Property
GenerateJWS Valeur de la clé privée //GenerateJWS/PrivateKey/Value
GenerateJWS Mot de passe de la clé privée //GenerateJWS/PrivateKey/Password
GenerateJWS ID de la clé privée //GenerateJWS/PrivateKey/Id
GenerateJWS Valeur de la clé secrète //GenerateJWS/SecretKey/Value
GenerateJWS ID de la clé secrète //GenerateJWS/SecretKey/Id
VerifyJWS Clés publiques JWKS //VerifyJWS/PublicKey/JWKS
VerifyJWS Valeur de la clé publique //VerifyJWS/PublicKey/Value
VerifyJWS Valeur de la clé secrète //VerifyJWS/SecretKey/Value
GenerateJWT Valeurs d'en-tête critiques //GenerateJWT/CriticalHeaders
GenerateJWT Valeur de la clé privée utilisée pour signer le JWT //GenerateJWT/PrivateKey/Value
GenerateJWT Mot de passe de la clé privée //GenerateJWT/PrivateKey/Password
GenerateJWT ID de la clé privée //GenerateJWT/PrivateKey/Id
GenerateJWT Valeur de la clé secrète //GenerateJWT/SecretKey/Value
GenerateJWT ID de la clé secrète //GenerateJWT/SecretKey/Id
VerifyJWT Clé publique //VerifyJWT/PublicKey/Value
VerifyJWT Clé secrète //VerifyJWT/SecretKey/Value
KeyValueMapOperations Valeurs des entrées initiales et des opérations PUT //KeyValueMapOperations/InitialEntries/Entry/Value
//KeyValueMapOperations/Put/Value
Ldap Valeurs des champs nom d'utilisateur et mot de passe //Ldap/Authentication/UserName
//Ldap/Authentication/Password
OAuthV1 Jetons //OAuthV1/Tokens/Token
OAuthV1 Jeton d'accès //OAuthV1/AccessToken
OAuthV1 Valeurs des attributs //OAuthV1/Attributes/Attribute
OAuthV1 Code de vérification //OAuthV1/VerifierCode
OAuthV1 ID utilisateur de l'application //OAuthV1/AppUserId
OAuthV1 Jeton de requête //OAuthV1/RequestToken
OAuthV2 Valeurs des attributs //OAuthV2/Attributes/Attribute
GetOAuthV2Info Jeton d'accès //GetOAuthV2Info/AccessToken
GetOAuthV2Info Code d'autorisation //GetOAuthV2Info/AuthorizationCode
GetOAuthV2Info ID client //GetOAuthV2Info/ClientId
GetOAuthV2Info Jeton d'actualisation //GetOAuthV2Info/RefreshToken
RevokeOAuthV2 ID de l'application //RevokeOAuthV2/AppId
RevokeOAuthV2 ID de l'utilisateur final //RevokeOAuthV2/EndUserId
SetOAuthV2Info Jeton d'accès //SetOAuthV2Info/AccessToken
SetOAuthV2Info Valeurs des attributs //SetOAuthV2Info/Attributes/Attribute
DeleteOAuthV2Info Valeur du jeton d'accès //DeleteOAuthV2Info/AccessToken
DeleteOAuthV2Info Valeur du code d'autorisation //DeleteOAuthV2Info/AuthorizationCode
StatisticsCollector Valeur statistique //StatisticsCollector/Statistics/Statistic
VerifyAPIKey Clé API codée en dur //VerifyAPIKey/APIKey

Gérer les masques personnalisés

Une API dédiée vous permet d'envoyer une liste personnalisée d'expressions XPath pour masquer des champs spécifiques que vous identifiez comme des informations personnelles, ce qui garantit que vos besoins uniques en matière de confidentialité des données sont satisfaits.

Vous pouvez gérer les masques d'informations personnelles personnalisés de votre organisation à l'aide du point de terminaison de l'API de gestion Edge /v1/organizations/<var>ORG_NAME/uapim/proxymasks. Vous devez disposer du rôle orgadmin pour effectuer ces opérations.

L'API fonctionne sur une seule liste de chemins XPath nommée proxymasks pour une organisation donnée.

Méthode Ressource Résumé Description
GET /v1/organizations/ORG_NAME/uapim/proxymasks Récupérer la liste XPath "proxymasks" Obtient la liste complète des expressions XPath pour "proxymasks" pour l'organisation donnée.
PUT /v1/organizations/ORG_NAME/uapim/proxymasks Créer ou remplacer la liste XPath "proxymasks" Crée la liste "proxymasks" si elle n'existe pas, ou remplace complètement son contenu si elle existe.
DELETE /v1/organizations/ORG_NAME/uapim/proxymasks Supprimer la liste XPath "proxymasks" Supprime tous les chemins XPath de la liste "proxymasks" pour l'organisation.
POST /v1/organizations/ORG_NAME/uapim/proxymasks/append Ajouter des chemins XPath à la liste "proxymasks" Ajoute une ou plusieurs chaînes XPath à la fin de la liste "proxymasks" existante.
POST /v1/organizations/ORG_NAME/uapim/proxymasks/deleteItems Supprimer des chemins XPath spécifiques de la liste "proxymasks" Supprime des chaînes XPath spécifiques de la liste "proxymasks". Correspond aux chaînes exactes.

Toutes les requêtes et les réponses positives pour la création, le remplacement, l'obtention, l'ajout ou la suppression d'éléments de la liste XPath utilisent le schéma JSON suivant :

{
  "xpaths": [
    "//Path/To/Element"
  ]
}
Champ Type Description
xpaths tableau de chaînes Liste de chaînes d'expression XPath à masquer. Ce champ est obligatoire.

1. Créer ou remplacer la liste XPath personnalisée (PUT)

Utilisez la méthode PUT pour créer une liste personnalisée ou remplacer complètement le contenu d'une liste existante. Tous les chemins XPath existants sont remplacés.

curl -X PUT https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \
  -H "Authorization: Bearer OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "xpaths": [
      "//StatisticsCollector/Statistics/Statistic[@name='caller']",
      "//AssignMessage/AssignVariable[Name='password']/Value"
    ]
  }'

Une fois la mise à jour terminée, une réponse 201 Created ou 200K s'affiche avec le message suivant : Success response (201 Created or 200 OK).

{
  "xpaths": [
    "//StatisticsCollector/Statistics/Statistic[@name='caller']",
    "//AssignMessage/AssignVariable[Name='password']/Value"
  ]
}

2. Récupérer la liste XPath personnalisée (GET)

Utilisez la méthode GET pour récupérer la liste actuelle des expressions XPath personnalisées.

curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \
  -H "Authorization: Bearer OAUTH_TOKEN"

Une fois la récupération terminée, une réponse 200K s'affiche avec le message suivant : Success response (200 OK):.

{
  "xpaths": [
    "//StatisticsCollector/Statistics/Statistic[@name='caller']",
    "//AssignMessage/AssignVariable[Name='password']/Value"
  ]
}

3. Ajouter des chemins XPath à la liste (POST append)

Utilisez la méthode POST pour ajouter une ou plusieurs expressions XPath à la liste existante sans remplacer le contenu actuel.

curl -X POST https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks/append \
  -H "Authorization: Bearer OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "xpaths": [
      "//New/Appended/XPath"
    ]
  }'

Une fois l'ajout terminé, une réponse 200K s'affiche avec le message suivant : Success response (200 OK):.

{
  "xpaths": [
    "//StatisticsCollector/Statistics/Statistic[@name='caller']",
    "//AssignMessage/AssignVariable[Name='password']/Value",
    "//New/Appended/XPath"
  ]
}

4. Supprimer des chemins XPath spécifiques de la liste (POST deleteItems)

Utilisez la méthode POST pour supprimer des expressions XPath spécifiques de la liste existante. La requête doit contenir les chaînes XPath exactes à supprimer.

curl -X POST https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks/deleteItems \
  -H "Authorization: Bearer OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "xpaths": [
      "//New/Appended/XPath"
    ]
  }'

Une fois la suppression terminée, une réponse 200K s'affiche avec le message suivant : Success response (200 OK):.

{
  "xpaths": [
    "//StatisticsCollector/Statistics/Statistic[@name='caller']",
    "//AssignMessage/AssignVariable[Name='password']/Value"
  ]
}

5. Supprimer l'intégralité de la liste XPath personnalisée (DELETE)

Utilisez la méthode DELETE pour supprimer complètement la liste XPath personnalisée. Seuls les masques personnalisés seront supprimés. Les masques par défaut seront toujours appliqués.

curl -X DELETE https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \
  -H "Authorization: Bearer OAUTH_TOKEN"

Une fois la suppression terminée, une réponse 204 No Content s'affiche avec le message suivant : Success response (204 No Content):.

HTTP/1.1 204 No Content

Mettre à jour les bundles masqués

Lorsque vous modifiez votre configuration de masquage des informations personnelles personnalisée, les bundles de proxy d'API qui ont été importés précédemment avec une configuration de masquage plus ancienne doivent être retraités avec les masques les plus récents. Pour mettre à jour les bundles avec les derniers paramètres de masquage, veuillez envoyer un ticket d'assistance afin de lancer le retraitement nécessaire.