redact - DataPower Gateway (v5 compatible)

Modifier en ligne

Utilisez la stratégie redact pour supprimer complètement ou occulter des zones définies dans le corps de la demande, le corps de la réponse et les 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 stratégie redact dans DataPower® Gateway (v5 compatible). Si vous utilisez, DataPower API Gatewayconsultez la page « redact » - DataPower API Gateway.

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 Gateway (v5 compatible) 1.0.0

Cette rubrique explique comment configurer la stratégie dans votre source OpenAPI; pour plus de détails sur la configuration de la stratégie dans l'interface utilisateur d', consultez la rubrique « Redaction - DataPower Gateway » (compatible avec v5 ).

A propos de

Cette stratégie a le format suivant :
- redact:
  version: version
  title: title
  description: description
  actions:
    - action: remove_or_redact
      from: 
        - where_the_redaction_is_to_be_applied
      path: XPath_expression_for_field_to_remove_or_redact
                     .
                     .
                     .
           further action/from/path combinations
                     .
                     .
                     .

Vous pouvez définir un nombre illimité de combinaisons action/from/path.

Propriétés

Le tableau suivant décrit les propriétés de la stratégie :
Tableau 2. Propriétés de la politique de masquage
Propriété Obligatoire Descriptif Type de données
version Oui Numéro de version de la stratégie chaîne
title Non Titre de la stratégie. chaîne
description Non Description de la stratégie. chaîne
action Non Indique si vous souhaitez supprimer ou occulter les zones.
Valeurs valides :
  • remove: supprime complètement les zones spécifiées.
  • redact: 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
from Non Indique où l'occultation doit être appliquée.
Valeurs valides :
  • all : applique l'occultation au corps de la demande, au corps de la réponse et aux journaux d'activité.
  • request : applique l'occultation uniquement au corps de la demande.
  • response applique l'occultation uniquement au corps de la réponse.
  • logs : applique l'occultation uniquement aux journaux d'activité.

Vous pouvez indiquer une ou plusieurs valeurs. La valeur par défaut est all.

 chaîne
path Oui Définit une expression XPath qui spécifie les zones à supprimer ou occulter.

Vous pouvez construire une expression XPath basée sur le format JSON ou XML selon que vos demandes et vos réponses d'API utilisent un format JSON ou XML. Si le contenu est au format JSON, utilisez la représentation XML DataPower du contenu JSON (JSONx) pour construire l'expression.

Remarque: utilisez une représentation JSONx uniquement pour identifier les expressions XPath des zones à supprimer ou à occulter. Ne modifiez pas le format des corps de réponse dans API Manager.

Pour en savoir plus sur la création d'expressions XPath basées sur JSON ou XML, consultez la section Création d'expressions XPath pour masquer des champs.

 chaîne

Exemple

# Specify separate remove and redact actions

- redact:
  version: 1.0.0
  title: remove secret field, redact address
  actions:
    - action: remove
      from: 
        - all
      path: /document/user/secret
    - action: redact
      from: 
        - request
        - response
      path: //*[@name='secondaryAddress']/*[@name='streetAddress']