Action d'occultation - DataPower API Gateway

Utilisez la règle d' occultation pour supprimer complètement ou occulter des zones spécifiées du corps de la demande, du corps de la réponse et des journaux d'activité. Cette stratégie peut s'avérer pratique pour supprimer ou bloquer des données sensibles (par exemple, informations de carte de crédit) pour des raisons juridiques, de sécurité ou autres.

Prise en charge des passerelles

Remarque: Cette page décrit l'implémentation de la stratégie Redaction dans DataPower® API Gateway. Si vous utilisez le DataPower Gateway (v5 compatible), consultez la section « Redaction » - DataPower Gateway (compatible avec v5 ).

Pour plus d'informations sur les différents types de passerelle, voir Types de passerelleAPI Connect.

Tableau 1. Tableau indiquant les passerelles prenant en charge cette politique, ainsi que la version correspondante de la politique
Passerelle	Version de la stratégie
DataPower API Gateway	2.0.0

Cette rubrique explique comment configurer la stratégie dans l'interface utilisateur d'Assembly; pour plus de détails sur la configuration de la stratégie dans votre source d' OpenAPI, consultez la page « redact » : DataPowerAPI Gateway.

Remarque: avec DataPower API Gateway, l'entrée de la règle d' occultation doit être des données analysées. Une façon de générer des données analysées consiste à utiliser une politique d'analyse avant une politique de masquage dans votre flux d'assemblage, ce qui permet de contrôler explicitement l'action d'analyse.

Propriétés

Le tableau suivant répertorie les propriétés des stratégies, indique si une propriété est nécessaire, définit les valeurs d'entrée et par défaut valides et précise le type de données des valeurs.

Tableau 2. Propriétés de la politique de caviardage
Libellé de la propriété	Obligatoire	Descriptif	Type de données
Titre	Non	Titre de la stratégie. La valeur par défaut est `redact`.	chaîne
Description	Non	Description de la stratégie.	chaîne
Racine	Non	Indique la source de données qui contient le contenu à occulter ou retirer. Si aucune valeur n'est saisie dans la zone Racine, l'action est appliquée à l'ensemble du contexte d'API. Vous pouvez utiliser toute expression de chemin JSONata prise en charge. Si vous souhaitez appliquer l'action à des données de demande ou de réponse, spécifiez la valeur `message.body`. Le contenu réel auquel l'action est appliquée dépend alors du positionnement de la stratégie Occultation dans le flux d'assemblage global ; par exemple: Si elle est positionnée au début, l'action est appliquée à la demande du client. Si elle est positionnée après une stratégie Invoke , l'action est appliquée à la réponse du système dorsal. Si elle est positionnée à la fin, l'action est appliquée à la réponse qui est renvoyée au client. Si, dans votre flux d'assemblage, la stratégie de rédaction est appliquée après une stratégie de journalisation définissant le mode « collecte uniquement », indiquez la valeur racine pour la `log.request_body` charge utile de la requête journalisée, ou `log.response_body` pour la charge utile de la réponse journalisée.	chaîne
chemin d'accès	Oui	Indique une expression de chemin JSONata qui identifie le contenu à occulter ou à retirer de la source. Pour plus d'informations, consultez la section « Création d'expressions JSONata pour masquer des champs ».	chaîne
Action	Non	Indique si vous souhaitez supprimer ou occulter le contenu. Sélectionnez l'une des options suivantes : Retirer : supprime complètement les zones définies. Occulter : occulte (brouille avec des "") les zones pour bloquer les données. La valeur par défaut est Redact. Remarque: Si une valeur numérique est occultée, la valeur occultée est représentée par `*****` et le type est remplacé par `string`.	chaîne

Astuce: Vous pouvez éventuellement cliquer sur Ajouter une action pour spécifier des expressions JSONata pour des zones supplémentaires que vous souhaitez supprimer ou occulter de la source de contenu spécifiée.