Wyświetlasz dokumentację Apigee Edge.
Przejdź do
dokumentacji Apigee X. info
Zarządzanie maskowaniem informacji umożliwiających identyfikację osób w pakietach proxy i współdzielonych przepływów
W ramach procesu synchronizacji integracja łącznika centrum interfejsów API przesyła pakiety proxy interfejsu API do centrum interfejsów API. Te pakiety mogą zawierać dane wrażliwe lub informacje umożliwiające identyfikację osób w konfiguracjach zasad. Ta funkcja umożliwia maskowanie zidentyfikowanych pól zawierających informacje umożliwiające identyfikację osób, zanim pakiety zostaną przesłane do centrum interfejsów API.
Metoda maskowania
Maskowanie informacji umożliwiających identyfikację osób jest stosowane za pomocą wyrażeń XPath, które kierują na określone elementy w konfiguracjach zasad w pakietach proxy i współdzielonych przepływów w formacie XML, ale nie na inne ogólne elementy XML w pakiecie. Ta funkcja jest podzielona na 2 części:
Maski domyślne
Apigee Edge zawiera predefiniowaną, wbudowaną listę wyrażeń XPath, które automatycznie kierują na typowe pola zawierające informacje umożliwiające identyfikację osób. Maski te są stosowane automatycznie podczas przesyłania.
Lista masek domyślnych:
| Nazwa zasady | Opis pola (lub wartości) | Wyrażenia XPath |
|---|---|---|
AccessEntity |
Identyfikator encji | //AccessEntity/EntityIdentifier |
AccessEntity |
Identyfikator dodatkowy | //AccessEntity/SecondaryIdentifier |
BasicAuthentication |
Wartość pola użytkownika | //BasicAuthentication/User |
BasicAuthentication |
Wartość pola hasła | //BasicAuthentication/Password |
ConnectorCallout |
Treść żądania JSON do wysłania do rozszerzenia | //ConnectorCallout/Input |
FlowCallout |
Wartości parametrów przekazywanych do wywołania przepływu | //FlowCallout/Parameter//FlowCallout/Parameters/Parameter |
HMAC |
Klucz tajny używany do obliczania HMAC | //HMAC/SecretKey |
HMAC |
Treść wiadomości do podpisania | //HMAC/Message |
HMAC |
Wartość weryfikacji HMAC | //HMAC/VerificationValue |
JavaCallout |
Przekazane właściwości (konfiguracja/dane wrażliwe) | //JavaCallout/Properties/Property |
Javascript |
Źródło wbudowane | //Javascript/Source |
Javascript |
Wartości właściwości | //Javascript/Properties/Property |
GenerateJWS |
Wartość klucza prywatnego | //GenerateJWS/PrivateKey/Value |
GenerateJWS |
Hasło klucza prywatnego | //GenerateJWS/PrivateKey/Password |
GenerateJWS |
Identyfikator klucza prywatnego | //GenerateJWS/PrivateKey/Id |
GenerateJWS |
Wartość klucza tajnego | //GenerateJWS/SecretKey/Value |
GenerateJWS |
Identyfikator klucza tajnego | //GenerateJWS/SecretKey/Id |
VerifyJWS |
Klucze publiczne JWKS | //VerifyJWS/PublicKey/JWKS |
VerifyJWS |
Wartość klucza publicznego | //VerifyJWS/PublicKey/Value |
VerifyJWS |
Wartość klucza tajnego | //VerifyJWS/SecretKey/Value |
GenerateJWT |
Krytyczne wartości nagłówka | //GenerateJWT/CriticalHeaders |
GenerateJWT |
Wartość klucza prywatnego używanego do podpisywania JWT | //GenerateJWT/PrivateKey/Value |
GenerateJWT |
Hasło klucza prywatnego | //GenerateJWT/PrivateKey/Password |
GenerateJWT |
Identyfikator klucza prywatnego | //GenerateJWT/PrivateKey/Id |
GenerateJWT |
Wartość klucza tajnego | //GenerateJWT/SecretKey/Value |
GenerateJWT |
Identyfikator klucza tajnego | //GenerateJWT/SecretKey/Id |
VerifyJWT |
Klucz publiczny | //VerifyJWT/PublicKey/Value |
VerifyJWT |
Klucz tajny | //VerifyJWT/SecretKey/Value |
KeyValueMapOperations |
Wartości początkowych wpisów i operacji PUT | //KeyValueMapOperations/InitialEntries/Entry/Value//KeyValueMapOperations/Put/Value |
Ldap |
Wartości pól nazwy użytkownika i hasła | //Ldap/Authentication/UserName//Ldap/Authentication/Password |
OAuthV1 |
Tokeny | //OAuthV1/Tokens/Token |
OAuthV1 |
Token dostępu | //OAuthV1/AccessToken |
OAuthV1 |
Wartości atrybutów | //OAuthV1/Attributes/Attribute |
OAuthV1 |
Kod weryfikatora | //OAuthV1/VerifierCode |
OAuthV1 |
Identyfikator użytkownika aplikacji | //OAuthV1/AppUserId |
OAuthV1 |
Token żądania | //OAuthV1/RequestToken |
OAuthV2 |
Wartości atrybutów | //OAuthV2/Attributes/Attribute |
GetOAuthV2Info |
Token dostępu | //GetOAuthV2Info/AccessToken |
GetOAuthV2Info |
Kod autoryzacji | //GetOAuthV2Info/AuthorizationCode |
GetOAuthV2Info |
Identyfikator klienta | //GetOAuthV2Info/ClientId |
GetOAuthV2Info |
Token odświeżania | //GetOAuthV2Info/RefreshToken |
RevokeOAuthV2 |
Identyfikator aplikacji | //RevokeOAuthV2/AppId |
RevokeOAuthV2 |
Identyfikator użytkownika końcowego | //RevokeOAuthV2/EndUserId |
SetOAuthV2Info |
Token dostępu | //SetOAuthV2Info/AccessToken |
SetOAuthV2Info |
Wartości atrybutów | //SetOAuthV2Info/Attributes/Attribute |
DeleteOAuthV2Info |
Wartość tokena dostępu | //DeleteOAuthV2Info/AccessToken |
DeleteOAuthV2Info |
Wartość kodu autoryzacji | //DeleteOAuthV2Info/AuthorizationCode |
StatisticsCollector |
Wartość statystyki | //StatisticsCollector/Statistics/Statistic |
VerifyAPIKey |
Zakodowany na stałe klucz API | //VerifyAPIKey/APIKey |
Zarządzanie maskami niestandardowymi
Specjalny interfejs API umożliwia przesyłanie dostosowanej listy wyrażeń XPath w celu maskowania określonych pól, które uznasz za zawierające informacje umożliwiające identyfikację osób, co zapewni spełnienie Twoich unikalnych potrzeb w zakresie ochrony prywatności danych.
Maskami niestandardowymi informacji umożliwiających identyfikację osób w organizacji możesz zarządzać za pomocą punktu końcowego interfejsu Edge Management API /v1/organizations/<var>ORG_NAME/uapim/proxymasks. Aby wykonywać te operacje, musisz mieć rolę orgadmin.
Interfejs API działa na pojedynczej liście XPath o nazwie proxymasks dla danej organizacji.
| Metoda | Zasób | Podsumowanie | Opis |
|---|---|---|---|
GET |
/v1/organizations/ORG_NAME/uapim/proxymasks |
Pobieranie listy XPath „proxymasks” | Pobiera pełną listę wyrażeń XPath dla „proxymasks” w danej organizacji. |
PUT |
/v1/organizations/ORG_NAME/uapim/proxymasks |
Tworzenie lub zastępowanie listy XPath „proxymasks” | Tworzy listę „proxymasks”, jeśli nie istnieje, lub całkowicie zastępuje jej zawartość, jeśli istnieje. |
DELETE |
/v1/organizations/ORG_NAME/uapim/proxymasks |
Usuwanie listy XPath „proxymasks” | Usuwa wszystkie wyrażenia XPath z listy „proxymasks” w organizacji. |
POST |
/v1/organizations/ORG_NAME/uapim/proxymasks/append |
Dołączanie wyrażeń XPath do listy „proxymasks” | Dodaje co najmniej 1 ciąg znaków XPath na końcu istniejącej listy „proxymasks”. |
POST |
/v1/organizations/ORG_NAME/uapim/proxymasks/deleteItems |
Usuwanie określonych wyrażeń XPath z listy „proxymasks” | Usuwa określone ciągi znaków XPath z listy „proxymasks”. Dopasowuje dokładne ciągi znaków. |
Wszystkie żądania i odpowiedzi o powodzeniu dotyczące tworzenia, zastępowania, pobierania, dołączania lub usuwania elementów z listy XPath używają tego schematu JSON:
{ "xpaths": [ "//Path/To/Element" ] }
| Pole | Typ | Opis |
|---|---|---|
xpaths |
tablica ciągów znaków | Lista ciągów znaków wyrażeń XPath do zamaskowania. To pole jest wymagane. |
1. Tworzenie lub zastępowanie niestandardowej listy XPath (PUT)
Użyj metody PUT, aby utworzyć nową listę niestandardową lub całkowicie zastąpić zawartość istniejącej listy. Wszystkie dotychczasowe wyrażenia XPath zostaną zastąpione.
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" ] }'
Po zakończeniu aktualizacji wyświetli się odpowiedź 201 Created lub 200K z tym komunikatem: Success response (201 Created or 200 OK)
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value" ] }
2. Pobieranie niestandardowej listy XPath (GET)
Użyj metody GET, aby pobrać bieżącą listę niestandardowych wyrażeń XPath.
curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \ -H "Authorization: Bearer OAUTH_TOKEN"
Po zakończeniu pobierania wyświetli się odpowiedź 200K z tym komunikatem:Success response (200 OK):
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value" ] }
3. Dołączanie wyrażeń XPath do listy (POST append)
Użyj metody POST, aby dołączyć co najmniej 1 wyrażenie XPath do istniejącej listy bez zastępowania bieżącej zawartości.
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" ] }'
Po zakończeniu dołączania wyświetli się odpowiedź 200K z tym komunikatem: Success response (200 OK):
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value", "//New/Appended/XPath" ] }
4. Usuwanie określonych wyrażeń XPath z listy (POST deleteItems)
Użyj metody POST, aby usunąć określone wyrażenia XPath z istniejącej listy. Żądanie musi zawierać dokładne ciągi znaków XPath do usunięcia.
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" ] }'
Po zakończeniu usuwania wyświetli się odpowiedź 200K z tym komunikatem: Success response (200 OK):
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value" ] }
5. Usuwanie całej niestandardowej listy XPath (DELETE)
Użyj metody DELETE, aby całkowicie usunąć niestandardową listę XPath. Spowoduje to usunięcie tylko masek niestandardowych ; maski domyślne będą nadal stosowane.
curl -X DELETE https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \ -H "Authorization: Bearer OAUTH_TOKEN"
Po zakończeniu usuwania wyświetli się odpowiedź 204 No Content z tym komunikatem: Success response (204 No Content):
HTTP/1.1 204 No Content
Aktualizowanie zamaskowanych pakietów
Gdy zmodyfikujesz konfigurację maskowania niestandardowego informacji umożliwiających identyfikację osób, pakiety proxy interfejsu API, które zostały wcześniej przesłane ze starszą konfiguracją maski, muszą zostać ponownie przetworzone z użyciem najnowszych masek. Aby zaktualizować pakiety za pomocą najnowszych ustawień maskowania, otwórz zgłoszenie do zespołu pomocy, aby rozpocząć niezbędne ponowne przetwarzanie.