Вы просматриваете документацию Apigee Edge .
Перейдите в документацию Apigee X.info
Управление маскированием персональных данных в прокси-серверах и пакетах Sharedflow.
В рамках процесса синхронизации интеграция коннектора API Hub загружает ваши пакеты API-прокси в API Hub. Эти пакеты могут содержать конфиденциальные данные или персональные данные (PII) в конфигурациях политик. Эта функция позволяет маскировать поля с идентифицированными персональными данными перед загрузкой пакетов в API Hub.
Маскирующий подход
Маскировка персональных данных применяется с использованием выражений XPath для выбора конкретных элементов в конфигурациях политик в XML-форматированных прокси-серверах и пакетах Sharedflow, но не для других общих XML-элементов внутри пакета. Эта функция разделена на две части:
Маски по умолчанию
Apigee Edge включает в себя предопределенный встроенный список выражений XPath, которые автоматически нацелены на распространенные поля, содержащие персональные данные. Эти маски применяются автоматически в процессе загрузки.
Список масок по умолчанию:
| Название полиса | Описание поля (или значения) | Выражение(я) XPath |
|---|---|---|
AccessEntity | Идентификатор сущности | //AccessEntity/EntityIdentifier |
AccessEntity | Вторичный идентификатор | //AccessEntity/SecondaryIdentifier |
BasicAuthentication | Значение пользовательского поля | //BasicAuthentication/User |
BasicAuthentication | Значение поля «Пароль» | //BasicAuthentication/Password |
ConnectorCallout | Тело JSON-запроса для отправки расширению | //ConnectorCallout/Input |
FlowCallout | Значения параметров, передаваемых в вызов потока. | //FlowCallout/Parameter//FlowCallout/Parameters/Parameter |
HMAC | Секретный ключ, используемый для расчета HMAC. | //HMAC/SecretKey |
HMAC | Содержимое сообщения для подписи | //HMAC/Message |
HMAC | значение проверки HMAC | //HMAC/VerificationValue |
JavaCallout | Переданы свойства (конфиденциальная конфигурация/данные) | //JavaCallout/Properties/Property |
Javascript | Встроенный источник | //Javascript/Source |
Javascript | Стоимость недвижимости | //Javascript/Properties/Property |
GenerateJWS | Значение закрытого ключа | //GenerateJWS/PrivateKey/Value |
GenerateJWS | пароль закрытого ключа | //GenerateJWS/PrivateKey/Password |
GenerateJWS | Идентификатор закрытого ключа | //GenerateJWS/PrivateKey/Id |
GenerateJWS | Секретное значение ключа | //GenerateJWS/SecretKey/Value |
GenerateJWS | Идентификатор секретного ключа | //GenerateJWS/SecretKey/Id |
VerifyJWS | открытые ключи JWKS | //VerifyJWS/PublicKey/JWKS |
VerifyJWS | Значение открытого ключа | //VerifyJWS/PublicKey/Value |
VerifyJWS | Секретное значение ключа | //VerifyJWS/SecretKey/Value |
GenerateJWT | Критические значения заголовка | //GenerateJWT/CriticalHeaders |
GenerateJWT | Значение закрытого ключа, используемое для подписи JWT. | //GenerateJWT/PrivateKey/Value |
GenerateJWT | пароль закрытого ключа | //GenerateJWT/PrivateKey/Password |
GenerateJWT | Идентификатор закрытого ключа | //GenerateJWT/PrivateKey/Id |
GenerateJWT | Секретное значение ключа | //GenerateJWT/SecretKey/Value |
GenerateJWT | Идентификатор секретного ключа | //GenerateJWT/SecretKey/Id |
VerifyJWT | Открытый ключ | //VerifyJWT/PublicKey/Value |
VerifyJWT | Секретный ключ | //VerifyJWT/SecretKey/Value |
KeyValueMapOperations | Значения для начальных записей и операций PUT | //KeyValueMapOperations/InitialEntries/Entry/Value//KeyValueMapOperations/Put/Value |
Ldap | Значения полей «Имя пользователя» и «Пароль» | //Ldap/Authentication/UserName//Ldap/Authentication/Password |
OAuthV1 | Токены | //OAuthV1/Tokens/Token |
OAuthV1 | токен доступа | //OAuthV1/AccessToken |
OAuthV1 | Значения атрибутов | //OAuthV1/Attributes/Attribute |
OAuthV1 | Код верификатора | //OAuthV1/VerifierCode |
OAuthV1 | Идентификатор пользователя приложения | //OAuthV1/AppUserId |
OAuthV1 | Запросить токен | //OAuthV1/RequestToken |
OAuthV2 | Значения атрибутов | //OAuthV2/Attributes/Attribute |
GetOAuthV2Info | токен доступа | //GetOAuthV2Info/AccessToken |
GetOAuthV2Info | Код авторизации | //GetOAuthV2Info/AuthorizationCode |
GetOAuthV2Info | Идентификатор клиента | //GetOAuthV2Info/ClientId |
GetOAuthV2Info | Токен обновления | //GetOAuthV2Info/RefreshToken |
RevokeOAuthV2 | Идентификатор приложения | //RevokeOAuthV2/AppId |
RevokeOAuthV2 | Идентификатор конечного пользователя | //RevokeOAuthV2/EndUserId |
SetOAuthV2Info | токен доступа | //SetOAuthV2Info/AccessToken |
SetOAuthV2Info | Значения атрибутов | //SetOAuthV2Info/Attributes/Attribute |
DeleteOAuthV2Info | значение токена доступа | //DeleteOAuthV2Info/AccessToken |
DeleteOAuthV2Info | значение кода авторизации | //DeleteOAuthV2Info/AuthorizationCode |
StatisticsCollector | Статистическое значение | //StatisticsCollector/Statistics/Statistic |
VerifyAPIKey | Ключ API, заданный жестко | //VerifyAPIKey/APIKey |
Управление пользовательскими масками
Специальный API позволяет отправлять настраиваемый список выражений XPath для маскировки определенных полей, которые вы определяете как персональные данные, обеспечивая тем самым соблюдение ваших уникальных требований к конфиденциальности данных.
Вы можете управлять пользовательскими масками персональных данных вашей организации, используя конечную точку API управления Edge по адресу /v1/organizations/<var>ORG_NAME /uapim/proxymasks . Для выполнения этих операций вам необходима роль orgadmin .
API работает с единым списком XPath-параметров, именованных proxymasks для заданной организации.
| Метод | Ресурс | Краткое содержание | Описание |
|---|---|---|---|
GET | /v1/organizations/ ORG_NAME /uapim/proxymasks | Получите список XPath-параметров 'proxymasks'. | Получает полный список выражений XPath для параметра 'proxymasks' для заданной организации. |
PUT | /v1/organizations/ ORG_NAME /uapim/proxymasks | Создайте или замените список XPath 'proxymasks'. | Создает список 'proxymasks', если он не существует, или полностью заменяет его содержимое, если он существует. |
DELETE | /v1/organizations/ ORG_NAME /uapim/proxymasks | Удалите список XPath 'proxymasks'. | Удаляет все XPath-ы из списка 'proxymasks' для организации. |
POST | /v1/organizations/ ORG_NAME /uapim/proxymasks/append | Добавьте XPath-ы в список 'proxymasks'. | Добавляет одну или несколько строк XPath в конец существующего списка 'proxymasks'. |
POST | /v1/organizations/ ORG_NAME /uapim/proxymasks/deleteItems | Удалите определенные XPath-ы из списка 'proxymasks'. | Удаляет определенные строки XPath из списка 'proxymasks'. Сопоставляет точные строки. |
Все запросы и успешные ответы на создание, замену, получение, добавление или удаление элементов из списка XPath используют следующую схему JSON:
{ "xpaths": [ "//Path/To/Element" ] }
| Поле | Тип | Описание |
|---|---|---|
xpaths | массив строк | Список строковых выражений XPath, которые необходимо замаскировать. Это поле обязательно для заполнения. |
1. Создайте или замените пользовательский список XPath (PUT).
Используйте метод PUT для создания нового пользовательского списка или для полной замены содержимого существующего списка. Все существующие XPath-запросы будут перезаписаны.
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" ] }'
После завершения обновления отобразится ответ 201 Created или 200K со следующим сообщением: Success response (201 Created or 200 OK)
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value" ] }
2. Получить пользовательский список XPath (GET)
Используйте метод GET для получения текущего списка пользовательских выражений XPath.
curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \ -H "Authorization: Bearer OAUTH_TOKEN"
После завершения процесса получения данных отобразится ответ с кодом 200K и следующим сообщением: Success response (200 OK):
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value" ] }
3. Добавьте XPath-ы к списку (POST append)
Используйте метод POST для добавления одного или нескольких выражений XPath к существующему списку без перезаписи текущего содержимого.
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" ] }'
После завершения добавления данных отобразится ответ размером 200 КБ со следующим сообщением: Success response (200 OK):
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value", "//New/Appended/XPath" ] }
4. Удалите определенные XPath-ы из списка (POST deleteItems)
Для удаления определенных выражений XPath из существующего списка используйте метод POST . Запрос должен содержать точные строки XPath, которые необходимо удалить.
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" ] }'
После завершения удаления отображается ответ размером 200 КБ со следующим сообщением: Success response (200 OK):
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value" ] }
5. Удалите весь пользовательский список XPath (DELETE).
Используйте метод DELETE для полного удаления пользовательского списка XPath. При этом будут удалены только пользовательские маски; маски по умолчанию останутся в силе.
curl -X DELETE https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \ -H "Authorization: Bearer OAUTH_TOKEN"
После завершения удаления отобразится ответ 204 «Нет содержимого» со следующим сообщением: Success response (204 No Content):
HTTP/1.1 204 No Content
Обновление маскированных пакетов
При изменении конфигурации маскирования персональных данных пакеты API-прокси, ранее загруженные с более старой конфигурацией маскирования, необходимо повторно обработать с использованием последних настроек. Для обновления пакетов с учетом последних настроек маскирования, пожалуйста, создайте заявку в службу поддержки, чтобы инициировать необходимую повторную обработку.