redact - DataPower Gateway (v5 compatible)

Utilizar la política redact para eliminar completamente o para redactar campos especificados del cuerpo de solicitud, el cuerpo de respuesta y los registros de actividad. Encontrará esta política útil para eliminar o bloquear datos confidenciales (por ejemplo, detalles de tarjeta de crédito) por razones legales, de seguridad o de otro tipo.

Soporte de pasarela

Nota: Esta página describe la implementación de la política redact en DataPower® Gateway (v5 compatible). Si utilizas el DataPower API Gateway, consulta redact - DataPower API Gateway.

Para obtener información sobre los distintos tipos de pasarela, consulte Tipos de pasarela deAPI Connect.

Tabla 1. Tabla que muestra qué puertas de enlace admiten esta política y la versión correspondiente de la misma
Pasarela	Versión de política
DataPower Gateway (v5 compatible)	1.0.0

En este tema se describe cómo configurar la política en la fuente de OpenAPI; para obtener más información sobre cómo configurar la política en la interfaz de usuario de Assembly, consulte «Redacción - DataPower Gateway (compatible con v5 ) ».

Acerca de

La política de reacción tiene el formato siguiente:

- 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
                     .
                     .
                     .

Puede especificar tantas combinaciones action/from/path como desee.

Propiedades

La tabla siguiente describe las propiedades de política.

Tabla 2. Propiedades de la política de ocultación
Propiedad	Obligatorio	Descripción	Tipo de datos
version	Sí	El número de versión de la política	serie
title	Nee	Título de la política.	serie
description	Nee	Una descripción de la política.	serie
action	Nee	Especifica si desea eliminar o redactar los campos. Valores válidos: `remove`: elimina completamente los campos especificados. `redact`: Redacta (ofusca con "" s) los campos para bloquear los datos. El valor predeterminado es `redact`. Nota: Si se está redactando un valor numérico, el valor redactado se representa como `*****` y el tipo se cambia a `string`.	serie
from	Nee	Determina dónde se va a aplicar la redacción. Valores válidos: `all`: aplicar la redacción al cuerpo de la solicitud, al cuerpo de la respuesta y a los registros de actividad. `request`: aplicar la redacción solo al cuerpo de la solicitud. `response`: aplicar la redacción solo al cuerpo de la respuesta. `logs`: aplicar la redacción solo a los registros de actividad. Puede proporcionar uno o varios valores. El valor predeterminado es `all`.	serie
path	Sí	Especifica una expresión XPath que define los campos que se deben eliminar o redactar. Puede construir una expresión XPath que se base en JSON o XML según si las solicitudes y respuestas de API utilizan un formato JSON o XML. Si la carga útil es JSON, utilice la representación XML de DataPower del contenido de JSON (JSONx) para construir la expresión. Nota: Utilice una representación JSONx sólo para identificar las expresiones XPath para los campos a eliminar o redactar. No cambie el formato de ningún cuerpo de respuesta en Gestor de API. Para obtener más información sobre cómo crear expresiones XPath basadas en JSON o XML, consulta «Creación de expresiones XPath para ocultar campos ».	serie

Ejemplo

# 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']