Maskierung personenidentifizierbarer Informationen in Proxy- und Sharedflow-Bundles verwalten

Sie lesen gerade die Dokumentation zu Apigee Edge.
Apigee X-Dokumentation aufrufen.
info

PII-Maskierung in Proxy- und Sharedflow-Bundles verwalten

Im Rahmen der Synchronisierung werden Ihre API-Proxy-Bundles über die API-Hub-Connector-Integration in den API-Hub hochgeladen. Diese Pakete können in Richtlinienkonfigurationen vertrauliche Daten oder personenbezogene Daten enthalten. Mit dieser Funktion können Sie erkannte Felder mit personenbezogenen Daten maskieren, bevor die Bundles in den API-Hub hochgeladen werden.

Maskierungsansatz

Die Maskierung personenbezogener Daten erfolgt mithilfe von XPath-Ausdrücken, um bestimmte Elemente in Richtlinienkonfigurationen in den XML-formatierten Proxy- und Sharedflow-Bundles zu erfassen, jedoch nicht für andere allgemeine XML-Elemente im Bundle. Diese Funktion ist in zwei Teile unterteilt:

Standardmasken

Apigee Edge enthält eine vordefinierte, integrierte Liste von XPath-Ausdrücken, die automatisch auf gängige PII-Felder ausgerichtet sind. Diese Masken werden während des Uploads automatisch angewendet.

Liste der Standardmasken:

Richtlinienname Feld- oder Wertbeschreibung XPath-Ausdrücke
AccessEntity Entitäts-ID //AccessEntity/EntityIdentifier
AccessEntity Sekundäre Kennung //AccessEntity/SecondaryIdentifier
BasicAuthentication Wert des Nutzerfelds //BasicAuthentication/User
BasicAuthentication Wert des Passwortfelds //BasicAuthentication/Password
ConnectorCallout JSON-Anfragetext, der an die Erweiterung gesendet werden soll //ConnectorCallout/Input
FlowCallout Werte der Parameter, die an den Flow-Aufruf übergeben werden //FlowCallout/Parameter
//FlowCallout/Parameters/Parameter
HMAC Geheimer Schlüssel für die HMAC-Berechnung //HMAC/SecretKey
HMAC Zu signierender Nachrichteninhalt //HMAC/Message
HMAC HMAC-Verifizierungswert //HMAC/VerificationValue
JavaCallout Übergebene Attribute (vertrauliche Konfiguration/Daten) //JavaCallout/Properties/Property
Javascript Inline-Quelle //Javascript/Source
Javascript Attributwerte //Javascript/Properties/Property
GenerateJWS Wert des privaten Schlüssels //GenerateJWS/PrivateKey/Value
GenerateJWS Passwort für den privaten Schlüssel //GenerateJWS/PrivateKey/Password
GenerateJWS ID des privaten Schlüssels //GenerateJWS/PrivateKey/Id
GenerateJWS Wert des geheimen Schlüssels //GenerateJWS/SecretKey/Value
GenerateJWS ID des geheimen Schlüssels //GenerateJWS/SecretKey/Id
VerifyJWS Öffentliche JWKS-Schlüssel //VerifyJWS/PublicKey/JWKS
VerifyJWS Wert des öffentlichen Schlüssels //VerifyJWS/PublicKey/Value
VerifyJWS Wert des geheimen Schlüssels //VerifyJWS/SecretKey/Value
GenerateJWT Kritische Headerwerte //GenerateJWT/CriticalHeaders
GenerateJWT Wert des privaten Schlüssels, der zum Signieren des JWT verwendet wird //GenerateJWT/PrivateKey/Value
GenerateJWT Passwort für den privaten Schlüssel //GenerateJWT/PrivateKey/Password
GenerateJWT ID des privaten Schlüssels //GenerateJWT/PrivateKey/Id
GenerateJWT Wert des geheimen Schlüssels //GenerateJWT/SecretKey/Value
GenerateJWT ID des geheimen Schlüssels //GenerateJWT/SecretKey/Id
VerifyJWT Öffentlicher Schlüssel //VerifyJWT/PublicKey/Value
VerifyJWT Secret-Schlüssel //VerifyJWT/SecretKey/Value
KeyValueMapOperations Werte für erste Einträge und PUT-Vorgänge //KeyValueMapOperations/InitialEntries/Entry/Value
//KeyValueMapOperations/Put/Value
Ldap Feldwerte für Nutzername und Passwort //Ldap/Authentication/UserName
//Ldap/Authentication/Password
OAuthV1 Tokens //OAuthV1/Tokens/Token
OAuthV1 Zugriffstoken //OAuthV1/AccessToken
OAuthV1 Attributwerte //OAuthV1/Attributes/Attribute
OAuthV1 Bestätigungscode //OAuthV1/VerifierCode
OAuthV1 App-Nutzer-ID //OAuthV1/AppUserId
OAuthV1 Anfragetoken //OAuthV1/RequestToken
OAuthV2 Attributwerte //OAuthV2/Attributes/Attribute
GetOAuthV2Info Zugriffstoken //GetOAuthV2Info/AccessToken
GetOAuthV2Info Autorisierungscode //GetOAuthV2Info/AuthorizationCode
GetOAuthV2Info Client-ID //GetOAuthV2Info/ClientId
GetOAuthV2Info Aktualisierungstoken //GetOAuthV2Info/RefreshToken
RevokeOAuthV2 App-ID //RevokeOAuthV2/AppId
RevokeOAuthV2 Endnutzer-ID //RevokeOAuthV2/EndUserId
SetOAuthV2Info Zugriffstoken //SetOAuthV2Info/AccessToken
SetOAuthV2Info Attributwerte //SetOAuthV2Info/Attributes/Attribute
DeleteOAuthV2Info Wert des Zugriffstokens //DeleteOAuthV2Info/AccessToken
DeleteOAuthV2Info Wert des Autorisierungscodes //DeleteOAuthV2Info/AuthorizationCode
StatisticsCollector Statistikwert //StatisticsCollector/Statistics/Statistic
VerifyAPIKey Fest codierter API-Schlüssel //VerifyAPIKey/APIKey

Benutzerdefinierte Masken verwalten

Mit einer speziellen API können Sie eine benutzerdefinierte Liste von XPath-Ausdrücken einreichen, um bestimmte Felder zu maskieren, die Sie als personenidentifizierbare Informationen identifizieren. So wird sichergestellt, dass Ihre individuellen Datenschutzanforderungen erfüllt werden.

Sie können die benutzerdefinierten PII-Masken Ihrer Organisation mit dem /v1/organizations/<var>ORG_NAME/uapim/proxymasks-Endpunkt der Edge Management API verwalten. Sie benötigen die Rolle orgadmin, um diese Vorgänge auszuführen.

Die API arbeitet mit einer einzelnen Liste von XPaths mit dem Namen proxymasks für eine bestimmte Organisation.

Methode Ressource Zusammenfassung Description
GET /v1/organizations/ORG_NAME/uapim/proxymasks XPath-Liste „proxymasks“ abrufen Ruft die vollständige Liste der XPath-Ausdrücke für „proxymasks“ für die angegebene Organisation ab.
PUT /v1/organizations/ORG_NAME/uapim/proxymasks XPath-Liste „proxymasks“ erstellen oder ersetzen Erstellt die Liste „proxymasks“, falls sie nicht vorhanden ist, oder ersetzt ihren Inhalt vollständig, falls sie vorhanden ist.
DELETE /v1/organizations/ORG_NAME/uapim/proxymasks Löschen Sie die XPath-Liste „proxymasks“. Löscht alle XPaths in der Liste „proxymasks“ für die Organisation.
POST /v1/organizations/ORG_NAME/uapim/proxymasks/append XPath-Ausdrücke an die Liste „proxymasks“ anhängen Fügt der vorhandenen Liste „proxymasks“ einen oder mehrere XPath-Strings hinzu.
POST /v1/organizations/ORG_NAME/uapim/proxymasks/deleteItems Bestimmte XPaths aus der Liste „proxymasks“ löschen Entfernt bestimmte XPath-Strings aus der Liste „proxymasks“. Stimmt mit exakten Strings überein.

Für alle Anfragen und erfolgreichen Antworten zum Erstellen, Ersetzen, Abrufen, Anhängen oder Löschen von Elementen aus der XPath-Liste wird das folgende JSON-Schema verwendet:

{
  "xpaths": [
    "//Path/To/Element"
  ]
}
Feld Typ Description
xpaths String-Array Eine Liste von XPath-Ausdrucksstrings, die maskiert werden sollen. Dies ist ein Pflichtfeld.

1. Benutzerdefinierte XPath-Liste erstellen oder ersetzen (PUT)

Mit der Methode PUT können Sie entweder eine neue benutzerdefinierte Liste erstellen oder den Inhalt einer vorhandenen Liste vollständig ersetzen. Alle vorhandenen XPaths werden überschrieben.

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

Nach Abschluss des Updates wird die Antwort „201 Created“ oder „200K“ mit der folgenden Meldung angezeigt: Success response (201 Created or 200 OK)

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

2. Benutzerdefinierte XPath-Liste abrufen (GET)

Verwenden Sie die Methode GET, um die aktuelle Liste der benutzerdefinierten XPath-Ausdrücke abzurufen.

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

Nach Abschluss des Abrufs wird eine 200K-Antwort mit der folgenden Meldung angezeigt:Success response (200 OK):

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

3. XPath-Ausdrücke an die Liste anhängen (POST append)

Mit der Methode POST können Sie der vorhandenen Liste ein oder mehrere XPath-Ausdrücke hinzufügen, ohne den aktuellen Inhalt zu überschreiben.

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

Nach Abschluss des Anhängens wird eine 200K-Antwort mit der folgenden Meldung angezeigt: Success response (200 OK):

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

4. Bestimmte XPaths aus der Liste löschen (POST deleteItems)

Verwenden Sie die Methode POST, um bestimmte XPath-Ausdrücke aus der vorhandenen Liste zu entfernen. Der Antrag muss die genauen XPath-Strings enthalten, die entfernt werden sollen.

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

Nach Abschluss des Löschvorgangs wird eine 200K-Antwort mit der folgenden Meldung angezeigt: Success response (200 OK):

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

5. Gesamte benutzerdefinierte XPath-Liste löschen (DELETE)

Verwenden Sie die Methode DELETE, um die benutzerdefinierte XPath-Liste vollständig zu entfernen. Dadurch werden nur die benutzerdefinierten Masken entfernt. Standardmasken werden weiterhin angewendet.

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

Nach Abschluss des Löschvorgangs wird die Antwort „204 No Content“ mit der folgenden Meldung angezeigt: Success response (204 No Content):

HTTP/1.1 204 No Content

Maskierte Bundles aktualisieren

Wenn Sie Ihre benutzerdefinierte Konfiguration für die Maskierung personenidentifizierbarer Informationen ändern, müssen API-Proxy-Sets, die zuvor mit einer älteren Maskenkonfiguration hochgeladen wurden, mit den neuesten Masken neu verarbeitet werden. Wenn Sie die Bundles mit den neuesten Maskierungseinstellungen aktualisieren möchten, reichen Sie bitte ein Support-Ticket ein, um die erforderliche Neuverarbeitung zu starten.