Quản lý việc che thông tin nhận dạng cá nhân (PII) trong các gói proxy và sharedflow

Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào tài liệu Apigee X.
Thông tin

Quản lý việc che giấu thông tin nhận dạng cá nhân trong các gói proxy và sharedflow

Trong quy trình đồng bộ hoá, chế độ tích hợp trình kết nối trung tâm API sẽ tải các gói proxy API lên trung tâm API. Các gói này có thể chứa dữ liệu nhạy cảm hoặc Thông tin nhận dạng cá nhân (PII) trong cấu hình chính sách. Tính năng này cho phép bạn che các trường thông tin nhận dạng cá nhân đã xác định trước khi các gói được tải lên trung tâm API.

Phương pháp che

Tính năng che giấu thông tin nhận dạng cá nhân được áp dụng bằng cách sử dụng các biểu thức XPath để nhắm đến các phần tử cụ thể trong cấu hình chính sách trong các gói proxy và sharedflow có định dạng XML, nhưng không áp dụng cho các phần tử XML chung khác trong gói. Tính năng này được chia thành hai phần:

Mặt nạ mặc định

Apigee Edge có một danh sách được xác định trước và tích hợp sẵn các biểu thức XPath tự động nhắm đến các trường thông tin nhận dạng cá nhân phổ biến. Các mặt nạ này sẽ tự động được áp dụng trong quá trình tải lên.

Danh sách các mặt nạ mặc định:

Tên chính sách Nội dung mô tả về trường (hoặc giá trị) (Các) biểu thức XPath
AccessEntity Giá trị nhận dạng thực thể //AccessEntity/EntityIdentifier
AccessEntity Giá trị nhận dạng phụ //AccessEntity/SecondaryIdentifier
BasicAuthentication Giá trị trường người dùng //BasicAuthentication/User
BasicAuthentication Giá trị của trường mật khẩu //BasicAuthentication/Password
ConnectorCallout Nội dung yêu cầu JSON để gửi đến tiện ích //ConnectorCallout/Input
FlowCallout Giá trị của các tham số được truyền đến chú thích luồng //FlowCallout/Parameter
//FlowCallout/Parameters/Parameter
HMAC Khoá bí mật dùng để tính toán HMAC //HMAC/SecretKey
HMAC Nội dung thư cần được ký //HMAC/Message
HMAC Giá trị xác minh HMAC //HMAC/VerificationValue
JavaCallout Các thuộc tính được truyền (dữ liệu/cấu hình nhạy cảm) //JavaCallout/Properties/Property
Javascript Nguồn nội tuyến //Javascript/Source
Javascript Giá trị thuộc tính //Javascript/Properties/Property
GenerateJWS Giá trị khoá riêng tư //GenerateJWS/PrivateKey/Value
GenerateJWS Mật khẩu khoá riêng tư //GenerateJWS/PrivateKey/Password
GenerateJWS Mã khoá riêng tư //GenerateJWS/PrivateKey/Id
GenerateJWS Giá trị khoá bí mật //GenerateJWS/SecretKey/Value
GenerateJWS Mã khoá bí mật //GenerateJWS/SecretKey/Id
VerifyJWS Khoá công khai JWKS //VerifyJWS/PublicKey/JWKS
VerifyJWS Giá trị khoá công khai //VerifyJWS/PublicKey/Value
VerifyJWS Giá trị khoá bí mật //VerifyJWS/SecretKey/Value
GenerateJWT Giá trị tiêu đề quan trọng //GenerateJWT/CriticalHeaders
GenerateJWT Giá trị khoá riêng tư dùng để ký JWT //GenerateJWT/PrivateKey/Value
GenerateJWT Mật khẩu khoá riêng tư //GenerateJWT/PrivateKey/Password
GenerateJWT Mã khoá riêng tư //GenerateJWT/PrivateKey/Id
GenerateJWT Giá trị khoá bí mật //GenerateJWT/SecretKey/Value
GenerateJWT Mã khoá bí mật //GenerateJWT/SecretKey/Id
VerifyJWT Khoá công khai //VerifyJWT/PublicKey/Value
VerifyJWT Khoá bí mật //VerifyJWT/SecretKey/Value
KeyValueMapOperations Giá trị cho các mục nhập ban đầu và các thao tác PUT //KeyValueMapOperations/InitialEntries/Entry/Value
//KeyValueMapOperations/Put/Value
Ldap Giá trị trường tên người dùng và mật khẩu //Ldap/Authentication/UserName
//Ldap/Authentication/Password
OAuthV1 Mã thông báo //OAuthV1/Tokens/Token
OAuthV1 Mã truy cập //OAuthV1/AccessToken
OAuthV1 Giá trị thuộc tính //OAuthV1/Attributes/Attribute
OAuthV1 Mã xác minh //OAuthV1/VerifierCode
OAuthV1 Mã nhận dạng người dùng ứng dụng //OAuthV1/AppUserId
OAuthV1 Mã thông báo yêu cầu //OAuthV1/RequestToken
OAuthV2 Giá trị thuộc tính //OAuthV2/Attributes/Attribute
GetOAuthV2Info Mã truy cập //GetOAuthV2Info/AccessToken
GetOAuthV2Info Mã uỷ quyền //GetOAuthV2Info/AuthorizationCode
GetOAuthV2Info ID khách hàng //GetOAuthV2Info/ClientId
GetOAuthV2Info Mã làm mới //GetOAuthV2Info/RefreshToken
RevokeOAuthV2 Mã ứng dụng //RevokeOAuthV2/AppId
RevokeOAuthV2 Mã nhận dạng người dùng cuối //RevokeOAuthV2/EndUserId
SetOAuthV2Info Mã truy cập //SetOAuthV2Info/AccessToken
SetOAuthV2Info Giá trị thuộc tính //SetOAuthV2Info/Attributes/Attribute
DeleteOAuthV2Info Giá trị mã truy cập //DeleteOAuthV2Info/AccessToken
DeleteOAuthV2Info Giá trị mã uỷ quyền //DeleteOAuthV2Info/AuthorizationCode
StatisticsCollector Giá trị thống kê //StatisticsCollector/Statistics/Statistic
VerifyAPIKey Khoá API được mã hoá cứng //VerifyAPIKey/APIKey

Quản lý mặt nạ tuỳ chỉnh

Một API chuyên dụng cho phép bạn gửi danh sách tuỳ chỉnh các biểu thức XPath để che các trường cụ thể mà bạn xác định là PII, đảm bảo đáp ứng các nhu cầu riêng biệt của bạn về quyền riêng tư đối với dữ liệu.

Bạn có thể quản lý các mặt nạ thông tin nhận dạng cá nhân (PII) tuỳ chỉnh của tổ chức bằng điểm cuối /v1/organizations/<var>ORG_NAME/uapim/proxymasks Edge Management API. Bạn phải có vai trò orgadmin để thực hiện các thao tác này.

API này hoạt động trên một danh sách XPath duy nhất có tên là proxymasks cho một tổ chức nhất định.

Phương thức Tài nguyên Tóm tắt Mô tả
GET /v1/organizations/ORG_NAME/uapim/proxymasks Truy xuất danh sách XPath "proxymasks" Lấy danh sách đầy đủ các biểu thức XPath cho "proxymasks" của tổ chức đã cho.
PUT /v1/organizations/ORG_NAME/uapim/proxymasks Tạo hoặc thay thế danh sách XPath "proxymasks" Tạo danh sách "proxymasks" nếu danh sách này chưa tồn tại hoặc thay thế hoàn toàn nội dung của danh sách nếu danh sách này đã tồn tại.
DELETE /v1/organizations/ORG_NAME/uapim/proxymasks Xoá danh sách XPath "proxymasks" Xoá tất cả XPath trong danh sách "proxymasks" cho tổ chức.
POST /v1/organizations/ORG_NAME/uapim/proxymasks/append Thêm XPath vào danh sách "proxymasks" Thêm một hoặc nhiều chuỗi XPath vào cuối danh sách "proxymasks" hiện có.
POST /v1/organizations/ORG_NAME/uapim/proxymasks/deleteItems Xoá các XPath cụ thể khỏi danh sách "proxymasks" Xoá các chuỗi XPath cụ thể khỏi danh sách "proxymasks". Khớp chính xác các chuỗi.

Tất cả các yêu cầu và phản hồi thành công để tạo, thay thế, nhận, thêm hoặc xoá các mục khỏi danh sách XPath đều sử dụng lược đồ JSON sau:

{
  "xpaths": [
    "//Path/To/Element"
  ]
}
Trường Loại Mô tả
xpaths mảng chuỗi Danh sách các chuỗi biểu thức XPath cần được che. Đây là trường bắt buộc.

1. Tạo hoặc thay thế danh sách XPath tuỳ chỉnh (PUT)

Sử dụng phương thức PUT để tạo một danh sách tuỳ chỉnh mới hoặc thay thế hoàn toàn nội dung của một danh sách hiện có. Mọi XPath hiện có sẽ bị ghi đè.

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"
    ]
  }'

Khi quá trình cập nhật hoàn tất, phản hồi 201 Created hoặc 200K sẽ hiển thị thông báo sau: Success response (201 Created or 200 OK)

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

2. Truy xuất danh sách XPath tuỳ chỉnh (GET)

Sử dụng phương thức GET để truy xuất danh sách hiện tại gồm các biểu thức XPath tuỳ chỉnh.

curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \
  -H "Authorization: Bearer OAUTH_TOKEN"

Khi quá trình truy xuất hoàn tất, một phản hồi 200K sẽ hiển thị thông báo sau:Success response (200 OK):

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

3. Thêm XPath vào danh sách (thêm POST)

Sử dụng phương thức POST để thêm một hoặc nhiều biểu thức XPath vào danh sách hiện có mà không ghi đè nội dung hiện tại.

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"
    ]
  }'

Khi quá trình thêm hoàn tất, một phản hồi 200K sẽ xuất hiện kèm theo thông báo sau: Success response (200 OK):

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

4. Xoá các XPath cụ thể khỏi danh sách (POST deleteItems)

Sử dụng phương thức POST để xoá các biểu thức XPath cụ thể khỏi danh sách hiện có. Yêu cầu phải chứa chuỗi XPath chính xác cần xoá.

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"
    ]
  }'

Khi quá trình xoá hoàn tất, một phản hồi 200K sẽ xuất hiện kèm theo thông báo sau: Success response (200 OK):

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

5. Xoá toàn bộ danh sách XPath tuỳ chỉnh (XOÁ)

Sử dụng phương thức DELETE để xoá hoàn toàn danh sách XPath tuỳ chỉnh. Thao tác này sẽ chỉ xoá các mặt nạ tuỳ chỉnh; các mặt nạ mặc định vẫn sẽ được áp dụng.

curl -X DELETE https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \
  -H "Authorization: Bearer OAUTH_TOKEN"

Khi quá trình xoá hoàn tất, phản hồi 204 No Content (Không có nội dung) sẽ xuất hiện cùng với thông báo sau: Success response (204 No Content):

HTTP/1.1 204 No Content

Cập nhật các gói bị che

Khi bạn sửa đổi cấu hình che giấu thông tin nhận dạng cá nhân tuỳ chỉnh, các gói proxy API đã được tải lên trước đó bằng cấu hình mặt nạ cũ cần được xử lý lại bằng các mặt nạ mới nhất. Để cập nhật các gói bằng chế độ cài đặt che mặt mới nhất, vui lòng gửi phiếu yêu cầu hỗ trợ để bắt đầu quy trình xử lý lại cần thiết.