Administra el enmascaramiento de la información de identificación personal (PII) en paquetes de proxy y sharedflow

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X.
info

Administra el enmascaramiento de la PII en paquetes de proxy y de flujo compartido

Como parte del proceso de sincronización, la integración del conector del centro de APIs sube tus paquetes de proxy de API al centro de APIs. Estos paquetes pueden contener datos sensibles o información de identificación personal (PII) dentro de las configuraciones de políticas. Esta función te permite enmascarar los campos de PII identificados antes de que los paquetes se suban al concentrador de APIs.

Enfoque de enmascaramiento

El enmascaramiento de PII se aplica con expresiones XPath para segmentar elementos específicos dentro de la configuración de políticas en los paquetes de proxy y sharedflow con formato XML, pero no a otros elementos XML generales dentro del paquete. Esta función se divide en dos partes:

Máscaras predeterminadas

Apigee Edge incluye una lista integrada y predefinida de expresiones XPath que segmentan automáticamente los campos de PII comunes. Estas máscaras se aplican automáticamente durante el proceso de carga.

Lista de máscaras predeterminadas:

Nombre de la política Descripción del campo (o valor) Expresiones XPath
AccessEntity Identificador de entidad //AccessEntity/EntityIdentifier
AccessEntity Identificador secundario //AccessEntity/SecondaryIdentifier
BasicAuthentication Valor del campo del usuario //BasicAuthentication/User
BasicAuthentication Valor del campo de contraseña //BasicAuthentication/Password
ConnectorCallout Cuerpo de la solicitud JSON que se enviará a la extensión //ConnectorCallout/Input
FlowCallout Valores de los parámetros que se pasan a la llamada de texto destacado del flujo //FlowCallout/Parameter
//FlowCallout/Parameters/Parameter
HMAC Clave secreta que se usa para el cálculo de HMAC //HMAC/SecretKey
HMAC Contenido del mensaje que se firmará //HMAC/Message
HMAC Valor de verificación de HMAC //HMAC/VerificationValue
JavaCallout Propiedades que se pasan (datos o configuración sensibles) //JavaCallout/Properties/Property
Javascript Fuente intercalada //Javascript/Source
Javascript Valores de propiedad //Javascript/Properties/Property
GenerateJWS Valor de la clave privada //GenerateJWS/PrivateKey/Value
GenerateJWS Contraseña de clave privada //GenerateJWS/PrivateKey/Password
GenerateJWS ID de clave privada //GenerateJWS/PrivateKey/Id
GenerateJWS Valor de la clave secreta //GenerateJWS/SecretKey/Value
GenerateJWS ID de clave secreta //GenerateJWS/SecretKey/Id
VerifyJWS Claves públicas de JWKS //VerifyJWS/PublicKey/JWKS
VerifyJWS Valor de la clave pública //VerifyJWS/PublicKey/Value
VerifyJWS Valor de la clave secreta //VerifyJWS/SecretKey/Value
GenerateJWT Valores de encabezado críticos //GenerateJWT/CriticalHeaders
GenerateJWT Valor de la clave privada que se usa para firmar el JWT //GenerateJWT/PrivateKey/Value
GenerateJWT Contraseña de clave privada //GenerateJWT/PrivateKey/Password
GenerateJWT ID de clave privada //GenerateJWT/PrivateKey/Id
GenerateJWT Valor de la clave secreta //GenerateJWT/SecretKey/Value
GenerateJWT ID de clave secreta //GenerateJWT/SecretKey/Id
VerifyJWT Clave pública //VerifyJWT/PublicKey/Value
VerifyJWT Clave del Secret //VerifyJWT/SecretKey/Value
KeyValueMapOperations Valores para las entradas iniciales y las operaciones PUT //KeyValueMapOperations/InitialEntries/Entry/Value
//KeyValueMapOperations/Put/Value
Ldap Valores de los campos de nombre de usuario y contraseña //Ldap/Authentication/UserName
//Ldap/Authentication/Password
OAuthV1 Tokens //OAuthV1/Tokens/Token
OAuthV1 Token de acceso //OAuthV1/AccessToken
OAuthV1 Valores del atributo //OAuthV1/Attributes/Attribute
OAuthV1 Código del verificador //OAuthV1/VerifierCode
OAuthV1 ID de usuario de la app //OAuthV1/AppUserId
OAuthV1 Token de solicitud //OAuthV1/RequestToken
OAuthV2 Valores del atributo //OAuthV2/Attributes/Attribute
GetOAuthV2Info Token de acceso //GetOAuthV2Info/AccessToken
GetOAuthV2Info Código de autorización //GetOAuthV2Info/AuthorizationCode
GetOAuthV2Info ID de cliente //GetOAuthV2Info/ClientId
GetOAuthV2Info Token de actualización //GetOAuthV2Info/RefreshToken
RevokeOAuthV2 ID de aplicación //RevokeOAuthV2/AppId
RevokeOAuthV2 ID del usuario final //RevokeOAuthV2/EndUserId
SetOAuthV2Info Token de acceso //SetOAuthV2Info/AccessToken
SetOAuthV2Info Valores del atributo //SetOAuthV2Info/Attributes/Attribute
DeleteOAuthV2Info Valor del token de acceso //DeleteOAuthV2Info/AccessToken
DeleteOAuthV2Info Valor del código de autorización //DeleteOAuthV2Info/AuthorizationCode
StatisticsCollector Valor de la estadística //StatisticsCollector/Statistics/Statistic
VerifyAPIKey Clave de API codificada //VerifyAPIKey/APIKey

Administra máscaras personalizadas

Una API dedicada te permite enviar una lista personalizada de expresiones XPath para enmascarar campos específicos que identificas como PII, lo que garantiza que se satisfagan tus necesidades únicas de privacidad de datos.

Puedes administrar las máscaras de PII personalizadas de tu organización con el extremo de la API de administración de /v1/organizations/<var>ORG_NAME/uapim/proxymasks Edge. Debes tener el rol de orgadmin para realizar estas operaciones.

La API opera en una sola lista de XPath llamada proxymasks para una organización determinada.

Método Recurso Resumen Description
GET /v1/organizations/ORG_NAME/uapim/proxymasks Recupera la lista de XPath "proxymasks". Obtiene la lista completa de expresiones XPath para "proxymasks" de la organización determinada.
PUT /v1/organizations/ORG_NAME/uapim/proxymasks Crea o reemplaza la lista de XPath "proxymasks" Crea la lista "proxymasks" si no existe o reemplaza por completo su contenido si existe.
DELETE /v1/organizations/ORG_NAME/uapim/proxymasks Borra la lista de XPath "proxymasks". Borra todos los XPath de la lista "proxymasks" de la organización.
POST /v1/organizations/ORG_NAME/uapim/proxymasks/append Agrega XPaths a la lista "proxymasks". Agrega una o más cadenas de XPath al final de la lista existente de "proxymasks".
POST /v1/organizations/ORG_NAME/uapim/proxymasks/deleteItems Cómo borrar XPaths específicos de la lista "proxymasks" Quita cadenas XPath específicas de la lista "proxymasks". Coincide con cadenas exactas.

Todas las solicitudes y respuestas exitosas para crear, reemplazar, obtener, agregar o borrar elementos de la lista de XPath usan el siguiente esquema JSON:

{
  "xpaths": [
    "//Path/To/Element"
  ]
}
Campo Tipo Description
xpaths Es un array de cadenas. Es una lista de cadenas de expresión XPath que se deben enmascarar. Este campo es obligatorio.

1. Crea o reemplaza la lista de XPath personalizada (PUT)

Usa el método PUT para crear una nueva lista personalizada o reemplazar por completo el contenido de una lista existente. Se reemplazan los XPath existentes.

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"
    ]
  }'

Cuando se complete la actualización, se mostrará una respuesta 201 Created o 200K con el siguiente mensaje: Success response (201 Created or 200 OK)

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

2. Recupera la lista de XPath personalizados (GET)

Usa el método GET para recuperar la lista actual de expresiones XPath personalizadas.

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

Cuando se complete la recuperación, se mostrará una respuesta de 200 K con el siguiente mensaje:Success response (200 OK):

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

3. Agrega XPaths a la lista (POST append)

Usa el método POST para agregar una o más expresiones XPath a la lista existente sin reemplazar el contenido actual.

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"
    ]
  }'

Cuando se complete la operación de anexar, se mostrará una respuesta 200K con el siguiente mensaje: Success response (200 OK):

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

4. Borra XPaths específicos de la lista (POST deleteItems)

Usa el método POST para quitar expresiones XPath específicas de la lista existente. La solicitud debe contener las cadenas XPath exactas que se quitarán.

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"
    ]
  }'

Cuando se complete la eliminación, se mostrará una respuesta 200K con el siguiente mensaje: Success response (200 OK):

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

5. Borra toda la lista de XPath personalizados (DELETE)

Usa el método DELETE para quitar por completo la lista de XPath personalizados. Esta acción quitará solo las máscaras personalizadas. Las máscaras predeterminadas seguirán aplicándose.

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

Cuando se complete la eliminación, se mostrará una respuesta 204 No Content con el siguiente mensaje: Success response (204 No Content):

HTTP/1.1 204 No Content

Actualiza paquetes enmascarados

Cuando modificas la configuración de enmascaramiento de PII personalizada, los paquetes de proxy de API que se subieron anteriormente con una configuración de enmascaramiento anterior deben volver a procesarse con los enmascaramientos más recientes. Para actualizar los paquetes con la configuración de enmascaramiento más reciente, envía un ticket de asistencia para iniciar el reprocesamiento necesario.