Stai visualizzando la documentazione di Apigee Edge.
Consulta la
documentazione di Apigee X. info
Gestire la maschera dei dati PII nei bundle proxy e nei flussi condivisi
Nell'ambito del processo di sincronizzazione, l'integrazione del connettore dell'hub API carica i pacchetti di proxy API nell'hub API. Questi bundle potrebbero contenere dati sensibili o informazioni che consentono l'identificazione personale (PII) all'interno delle configurazioni delle norme. Questa funzionalità consente di mascherare i campi PII identificati prima che i bundle vengano caricati nell'hub API.
Metodo di mascheramento
Il mascheramento dei dati PII viene applicato utilizzando espressioni XPath per scegliere come target elementi specifici all'interno delle configurazioni dei criteri nei bundle proxy e sharedflow in formato XML, ma non ad altri elementi XML generali all'interno del bundle. Questa funzionalità è suddivisa in due parti:
Maschere predefinite
Apigee Edge include un elenco predefinito e integrato di espressioni XPath che hanno automaticamente come target i campi PII comuni. Queste maschere vengono applicate automaticamente durante la procedura di caricamento.
Elenco delle maschere predefinite:
| Nome norma | Descrizione del campo (o del valore) | Espressione/i XPath |
|---|---|---|
AccessEntity |
Identificatore entità | //AccessEntity/EntityIdentifier |
AccessEntity |
Identificatore secondario | //AccessEntity/SecondaryIdentifier |
BasicAuthentication |
Valore del campo utente | //BasicAuthentication/User |
BasicAuthentication |
Valore del campo password | //BasicAuthentication/Password |
ConnectorCallout |
Corpo della richiesta JSON da inviare all'estensione | //ConnectorCallout/Input |
FlowCallout |
Valori dei parametri passati al callout del flusso | //FlowCallout/Parameter//FlowCallout/Parameters/Parameter |
HMAC |
Chiave segreta utilizzata per il calcolo HMAC | //HMAC/SecretKey |
HMAC |
Contenuti del messaggio da firmare | //HMAC/Message |
HMAC |
Valore di verifica HMAC | //HMAC/VerificationValue |
JavaCallout |
Proprietà trasmesse (configurazione/dati sensibili) | //JavaCallout/Properties/Property |
Javascript |
Origine in linea | //Javascript/Source |
Javascript |
Valori delle proprietà | //Javascript/Properties/Property |
GenerateJWS |
Valore della chiave privata | //GenerateJWS/PrivateKey/Value |
GenerateJWS |
Password chiave privata | //GenerateJWS/PrivateKey/Password |
GenerateJWS |
ID chiave privata | //GenerateJWS/PrivateKey/Id |
GenerateJWS |
Valore della chiave segreta | //GenerateJWS/SecretKey/Value |
GenerateJWS |
ID chiave segreta | //GenerateJWS/SecretKey/Id |
VerifyJWS |
Chiavi pubbliche JWKS | //VerifyJWS/PublicKey/JWKS |
VerifyJWS |
Valore chiave pubblica | //VerifyJWS/PublicKey/Value |
VerifyJWS |
Valore della chiave segreta | //VerifyJWS/SecretKey/Value |
GenerateJWT |
Valori di intestazione critici | //GenerateJWT/CriticalHeaders |
GenerateJWT |
Valore della chiave privata utilizzato per firmare il JWT | //GenerateJWT/PrivateKey/Value |
GenerateJWT |
Password chiave privata | //GenerateJWT/PrivateKey/Password |
GenerateJWT |
ID chiave privata | //GenerateJWT/PrivateKey/Id |
GenerateJWT |
Valore della chiave segreta | //GenerateJWT/SecretKey/Value |
GenerateJWT |
ID chiave segreta | //GenerateJWT/SecretKey/Id |
VerifyJWT |
Chiave pubblica | //VerifyJWT/PublicKey/Value |
VerifyJWT |
Chiave secret | //VerifyJWT/SecretKey/Value |
KeyValueMapOperations |
Valori per le voci iniziali e le operazioni PUT | //KeyValueMapOperations/InitialEntries/Entry/Value//KeyValueMapOperations/Put/Value |
Ldap |
Valori dei campi Nome utente e Password | //Ldap/Authentication/UserName//Ldap/Authentication/Password |
OAuthV1 |
Token | //OAuthV1/Tokens/Token |
OAuthV1 |
Token di accesso | //OAuthV1/AccessToken |
OAuthV1 |
Valori attributi | //OAuthV1/Attributes/Attribute |
OAuthV1 |
Codice del verificatore | //OAuthV1/VerifierCode |
OAuthV1 |
ID utente app | //OAuthV1/AppUserId |
OAuthV1 |
Token di richiesta | //OAuthV1/RequestToken |
OAuthV2 |
Valori attributi | //OAuthV2/Attributes/Attribute |
GetOAuthV2Info |
Token di accesso | //GetOAuthV2Info/AccessToken |
GetOAuthV2Info |
Codice di autorizzazione | //GetOAuthV2Info/AuthorizationCode |
GetOAuthV2Info |
ID client | //GetOAuthV2Info/ClientId |
GetOAuthV2Info |
Aggiorna token | //GetOAuthV2Info/RefreshToken |
RevokeOAuthV2 |
ID app | //RevokeOAuthV2/AppId |
RevokeOAuthV2 |
ID utente finale | //RevokeOAuthV2/EndUserId |
SetOAuthV2Info |
Token di accesso | //SetOAuthV2Info/AccessToken |
SetOAuthV2Info |
Valori attributi | //SetOAuthV2Info/Attributes/Attribute |
DeleteOAuthV2Info |
Valore del token di accesso | //DeleteOAuthV2Info/AccessToken |
DeleteOAuthV2Info |
Valore del codice di autorizzazione | //DeleteOAuthV2Info/AuthorizationCode |
StatisticsCollector |
Valore statistica | //StatisticsCollector/Statistics/Statistic |
VerifyAPIKey |
Chiave API hardcoded | //VerifyAPIKey/APIKey |
Gestire maschere personalizzate
Un'API dedicata ti consente di inviare un elenco personalizzato di espressioni XPath per mascherare campi specifici che identifichi come PII, garantendo che le tue esigenze specifiche di privacy dei dati siano soddisfatte.
Puoi gestire le maschere PII personalizzate della tua organizzazione utilizzando l'endpoint API di gestione /v1/organizations/<var>ORG_NAME/uapim/proxymasks Edge. Per eseguire queste operazioni devi disporre del ruolo orgadmin.
L'API opera su un unico elenco di XPath denominato proxymasks per una determinata organizzazione.
| Metodo | Risorsa | Riepilogo | Descrizione |
|---|---|---|---|
GET |
/v1/organizations/ORG_NAME/uapim/proxymasks |
Recupera l'elenco XPath "proxymasks" | Recupera l'elenco completo delle espressioni XPath per "proxymasks" per l'organizzazione specificata. |
PUT |
/v1/organizations/ORG_NAME/uapim/proxymasks |
Creare o sostituire l'elenco XPath "proxymasks" | Crea l 'elenco "proxymasks" se non esiste o ne sostituisce completamente i contenuti se esiste. |
DELETE |
/v1/organizations/ORG_NAME/uapim/proxymasks |
Elimina l'elenco XPath "proxymasks" | Elimina tutti gli XPath nell'elenco "proxymasks" per l'organizzazione. |
POST |
/v1/organizations/ORG_NAME/uapim/proxymasks/append |
Aggiungi XPaths all'elenco "proxymasks" | Aggiunge una o più stringhe XPath alla fine dell'elenco "proxymasks" esistente. |
POST |
/v1/organizations/ORG_NAME/uapim/proxymasks/deleteItems |
Eliminare XPath specifici dall'elenco "proxymasks" | Rimuove stringhe XPath specifiche dall'elenco "proxymasks". Corrisponde a stringhe esatte. |
Tutte le richieste e le risposte riuscite per la creazione, la sostituzione, l'ottenimento, l'aggiunta o l'eliminazione di elementi dall'elenco XPath utilizzano il seguente schema JSON:
{ "xpaths": [ "//Path/To/Element" ] }
| Campo | Tipo | Descrizione |
|---|---|---|
xpaths |
array di stringhe | Un elenco di stringhe di espressioni XPath da mascherare. Questo campo è obbligatorio. |
1. Crea o sostituisci l'elenco XPath personalizzato (PUT)
Utilizza il metodo PUT per creare un nuovo elenco personalizzato o sostituire completamente i contenuti di un elenco esistente. Gli XPath esistenti vengono sovrascritti.
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" ] }'
Al termine dell'aggiornamento, viene visualizzata una risposta 201 Created o 200K con il seguente messaggio: Success response (201 Created or 200 OK)
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value" ] }
2. Recupera l'elenco XPath personalizzato (GET)
Utilizza il metodo GET per recuperare l'elenco corrente delle espressioni XPath personalizzate.
curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \ -H "Authorization: Bearer OAUTH_TOKEN"
Al termine del recupero, viene visualizzata una risposta 200K con il seguente messaggio:Success response (200 OK):
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value" ] }
3. Aggiungere XPaths all'elenco (POST append)
Utilizza il metodo POST per aggiungere una o più espressioni XPath all'elenco esistente senza sovrascrivere i contenuti attuali.
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" ] }'
Al termine dell'aggiunta, viene visualizzata una risposta 200K con il seguente messaggio: Success response (200 OK):
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value", "//New/Appended/XPath" ] }
4. Eliminare XPath specifici dall'elenco (POST deleteItems)
Utilizza il metodo POST per rimuovere espressioni XPath specifiche dall'elenco esistente. La richiesta deve contenere le stringhe XPath esatte da rimuovere.
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" ] }'
Al termine dell'eliminazione, viene visualizzata una risposta 200K con il seguente messaggio: Success response (200 OK):
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value" ] }
5. Elimina l'intero elenco XPath personalizzato (DELETE)
Utilizza il metodo DELETE per rimuovere completamente l'elenco XPath personalizzato. In questo modo verranno rimosse solo le maschere personalizzate; le maschere predefinite verranno comunque applicate.
curl -X DELETE https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \ -H "Authorization: Bearer OAUTH_TOKEN"
Al termine dell'eliminazione, viene visualizzata una risposta 204 No Content con il seguente messaggio: Success response (204 No Content):
HTTP/1.1 204 No Content
Aggiornamento dei bundle mascherati
Quando modifichi la configurazione personalizzata di mascheramento dei dati PII, i bundle di proxy API caricati in precedenza con una configurazione di maschera precedente devono essere rielaborati con le maschere più recenti. Per aggiornare i bundle con le impostazioni di mascheramento più recenti, invia una richiesta di assistenza per avviare la rielaborazione necessaria.