Как управлять маскировкой информации, позволяющей идентифицировать личность, в пакетах прокси и SharedFlow

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

Как управлять маскировкой конфиденциальной информации в пакетах прокси и SharedFlow

В процессе синхронизации интеграция коннектора API Hub загружает пакеты прокси-серверов API в API Hub. Эти пакеты могут содержать конфиденциальные данные или информацию, позволяющую идентифицировать личность, в соответствии с настройками правил. Эта функция позволяет маскировать поля, содержащие информацию, позволяющую идентифицировать личность, до того, как пакеты будут загружены в центр API.

Метод маскировки

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

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

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

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

Как управлять масками

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

Управлять специальными масками конфиденциальной информации можно с помощью конечной точки API управления Edge /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 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"
    ]
  }'

После завершения добавления появится ответ 200K со следующим сообщением: 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"
    ]
  }'

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

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

5. Удалить весь список специальных выражений XPath (DELETE)

Чтобы полностью удалить пользовательский список XPath, используйте метод DELETE. Будут удалены только пользовательские маски. Стандартные маски останутся.

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, которые были загружены ранее с более старой конфигурацией маскировки, нужно будет обработать заново с использованием последних масок. Чтобы обновить пакеты с последними настройками маскировки, отправьте запрос в службу поддержки.