Управление маскировкой персонально идентифицируемой информации (PII) в прокси-серверах и пакетах Sharedflow

Вы просматриваете документацию Apigee Edge .
Перейти к документации Apigee X. info

Управление маскировкой PII в прокси-пакетах и ​​пакетах Sharedflow

В процессе синхронизации интеграция с API Hub Connector загружает ваши пакеты прокси-сервера API в API Hub. Эти пакеты могут содержать конфиденциальные данные или персональные данные (PII) в конфигурациях политик. Эта функция позволяет скрыть поля PII перед загрузкой пакетов в API Hub.

Маскирующий подход

Маскирование персональных данных (PII) применяется с помощью выражений XPath к определенным элементам в конфигурациях политик в пакетах прокси-сервера и Sharedflow в формате XML, но не к другим общим XML-элементам в пакете. Эта функция разделена на две части:

Маски по умолчанию

Apigee Edge включает в себя предопределённый встроенный список выражений XPath, которые автоматически выбирают общие поля персональных данных. Эти маски применяются автоматически в процессе загрузки.

Список масок по умолчанию:

Управление пользовательскими масками

Специальный API позволяет вам отправлять индивидуальный список выражений XPath для маскировки определенных полей, которые вы определяете как персональные данные, обеспечивая соблюдение ваших уникальных требований к конфиденциальности данных.

Вы можете управлять масками персональных данных вашей организации, используя конечную точку API Edge Management /v1/organizations/<var>ORG_NAME /uapim/proxymasks . Для выполнения этих операций необходима роль orgadmin .

API работает с единым списком XPath-путей, называемых proxymasks для данной организации.

Все запросы и успешные ответы на создание, замену, получение, добавление или удаление элементов из списка XPath используют следующую схему JSON:

{
  "xpaths": [
    "//Path/To/Element"
  ]
}

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-дополнение)

Используйте метод 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"
    ]
  }'

После завершения добавления отображается ответ 200K со следующим сообщением: Success response (200 OK):

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

4. Удалить определенные XPath-пути из списка (POST deleteItems)

Используйте метод POST для удаления определённых выражений XPath из существующего списка. Запрос должен содержать точные строки 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"
    ]
  }'

После завершения удаления отобразится ответ 200K со следующим сообщением: 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 No Content со следующим сообщением: Success response (204 No Content):

HTTP/1.1 204 No Content

Обновление замаскированных пакетов

При изменении пользовательской конфигурации маскирования персональных данных пакеты API-прокси, ранее загруженные с более старой конфигурацией масок, необходимо переобработать с использованием последних масок. Чтобы обновить пакеты с использованием последних настроек маскирования, отправьте запрос в службу поддержки для инициирования необходимой переобработки.