Você está lendo a documentação do Apigee Edge.
Acesse a
documentação da Apigee X. info
Gerenciar o mascaramento de PII em pacotes de proxy e sharedflow
Como parte do processo de sincronização, a integração do conector do hub de API faz upload dos pacotes de proxy de API para o hub de API. Esses pacotes podem conter dados sensíveis ou informações de identificação pessoal (PII) nas configurações de política. Esse recurso permite mascarar os campos de PII identificados antes que os pacotes sejam enviados para o hub de API.
Abordagem de mascaramento
O mascaramento de PII é aplicado usando expressões XPath para segmentar elementos específicos nas configurações de política nos pacotes de proxy e sharedflow formatados em XML, mas não para outros elementos XML gerais no pacote. Esse recurso é dividido em duas partes:
Máscaras padrão
O Apigee Edge inclui uma lista predefinida e integrada de expressões XPath que segmentam automaticamente campos comuns de PII. Essas máscaras são aplicadas automaticamente durante o processo de upload.
Lista de máscaras padrão :
| Nome da política | Descrição do campo (ou valor) | Expressões XPath |
|---|---|---|
AccessEntity |
Identificador de entidade | //AccessEntity/EntityIdentifier |
AccessEntity |
Identificador secundário | //AccessEntity/SecondaryIdentifier |
BasicAuthentication |
Valor do campo do usuário | //BasicAuthentication/User |
BasicAuthentication |
Valor do campo de senha | //BasicAuthentication/Password |
ConnectorCallout |
Corpo da solicitação JSON a ser enviado para a extensão | //ConnectorCallout/Input |
FlowCallout |
Valores de parâmetros transmitidos para a chamada de fluxo | //FlowCallout/Parameter//FlowCallout/Parameters/Parameter |
HMAC |
Chave secreta usada para o cálculo de HMAC | //HMAC/SecretKey |
HMAC |
Conteúdo da mensagem a ser assinado | //HMAC/Message |
HMAC |
Valor de verificação de HMAC | //HMAC/VerificationValue |
JavaCallout |
Propriedades transmitidas (configuração/dados sensíveis) | //JavaCallout/Properties/Property |
Javascript |
Fonte inline | //Javascript/Source |
Javascript |
Valores de propriedade | //Javascript/Properties/Property |
GenerateJWS |
Valor da chave privada | //GenerateJWS/PrivateKey/Value |
GenerateJWS |
Senha de chave privada | //GenerateJWS/PrivateKey/Password |
GenerateJWS |
ID da chave privada | //GenerateJWS/PrivateKey/Id |
GenerateJWS |
Valor da chave secreta | //GenerateJWS/SecretKey/Value |
GenerateJWS |
ID da chave secreta | //GenerateJWS/SecretKey/Id |
VerifyJWS |
Chaves públicas JWKS | //VerifyJWS/PublicKey/JWKS |
VerifyJWS |
Valor da chave pública | //VerifyJWS/PublicKey/Value |
VerifyJWS |
Valor da chave secreta | //VerifyJWS/SecretKey/Value |
GenerateJWT |
Valores de cabeçalho críticos | //GenerateJWT/CriticalHeaders |
GenerateJWT |
Valor da chave privada usado para assinar o JWT | //GenerateJWT/PrivateKey/Value |
GenerateJWT |
Senha de chave privada | //GenerateJWT/PrivateKey/Password |
GenerateJWT |
ID da chave privada | //GenerateJWT/PrivateKey/Id |
GenerateJWT |
Valor da chave secreta | //GenerateJWT/SecretKey/Value |
GenerateJWT |
ID da chave secreta | //GenerateJWT/SecretKey/Id |
VerifyJWT |
Chave pública | //VerifyJWT/PublicKey/Value |
VerifyJWT |
Chave secreta | //VerifyJWT/SecretKey/Value |
KeyValueMapOperations |
Valores para entradas iniciais e operações PUT | //KeyValueMapOperations/InitialEntries/Entry/Value//KeyValueMapOperations/Put/Value |
Ldap |
Valores de campo de nome de usuário e senha | //Ldap/Authentication/UserName//Ldap/Authentication/Password |
OAuthV1 |
Tokens | //OAuthV1/Tokens/Token |
OAuthV1 |
Token de acesso | //OAuthV1/AccessToken |
OAuthV1 |
Valores dos atributos | //OAuthV1/Attributes/Attribute |
OAuthV1 |
Código do verificador | //OAuthV1/VerifierCode |
OAuthV1 |
ID do usuário do app | //OAuthV1/AppUserId |
OAuthV1 |
Token de solicitação | //OAuthV1/RequestToken |
OAuthV2 |
Valores dos atributos | //OAuthV2/Attributes/Attribute |
GetOAuthV2Info |
Token de acesso | //GetOAuthV2Info/AccessToken |
GetOAuthV2Info |
Código de autorização | //GetOAuthV2Info/AuthorizationCode |
GetOAuthV2Info |
ID do cliente | //GetOAuthV2Info/ClientId |
GetOAuthV2Info |
Token de atualização | //GetOAuthV2Info/RefreshToken |
RevokeOAuthV2 |
ID do app | //RevokeOAuthV2/AppId |
RevokeOAuthV2 |
ID do usuário final | //RevokeOAuthV2/EndUserId |
SetOAuthV2Info |
Token de acesso | //SetOAuthV2Info/AccessToken |
SetOAuthV2Info |
Valores dos atributos | //SetOAuthV2Info/Attributes/Attribute |
DeleteOAuthV2Info |
Valor do token de acesso | //DeleteOAuthV2Info/AccessToken |
DeleteOAuthV2Info |
Valor do código de autorização | //DeleteOAuthV2Info/AuthorizationCode |
StatisticsCollector |
Valor estatístico | //StatisticsCollector/Statistics/Statistic |
VerifyAPIKey |
Chave de API codificada | //VerifyAPIKey/APIKey |
Gerenciar máscaras personalizadas
Uma API dedicada permite enviar uma lista personalizada de expressões XPath para mascarar campos específicos identificados como PII, garantindo que suas necessidades exclusivas de privacidade de dados sejam atendidas.
É possível gerenciar as máscaras de PII personalizadas da sua organização usando o endpoint de API de gerenciamento do Edge /v1/organizations/<var>ORG_NAME/uapim/proxymasks. Você precisa ter o papel orgadmin para realizar essas operações.
A API opera em uma única lista de XPaths chamada proxymasks para uma determinada organização.
| Método | Recurso | Resumo | Descrição |
|---|---|---|---|
GET |
/v1/organizations/ORG_NAME/uapim/proxymasks |
Recuperar a lista de XPath "proxymasks" | Recebe a lista completa de expressões XPath para "proxymasks" da organização especificada. |
PUT |
/v1/organizations/ORG_NAME/uapim/proxymasks |
Criar ou substituir a lista de XPath "proxymasks" | Cria a lista "proxymasks" se ela não existir ou substitui completamente o conteúdo dela. |
DELETE |
/v1/organizations/ORG_NAME/uapim/proxymasks |
Excluir a lista de XPath "proxymasks" | Exclui todos os XPaths na lista "proxymasks" da organização. |
POST |
/v1/organizations/ORG_NAME/uapim/proxymasks/append |
Anexar XPaths à lista "proxymasks" | Adiciona uma ou mais strings XPath ao final da lista "proxymasks" atual. |
POST |
/v1/organizations/ORG_NAME/uapim/proxymasks/deleteItems |
Excluir XPaths específicos da lista "proxymasks" | Remove strings XPath específicas da lista "proxymasks". Corresponde a strings exatas. |
Todas as solicitações e respostas bem-sucedidas para criar, substituir, receber, anexar ou excluir itens da lista XPath usam o seguinte esquema JSON:
{ "xpaths": [ "//Path/To/Element" ] }
| Campo | Tipo | Descrição |
|---|---|---|
xpaths |
matriz de strings | Uma lista de strings de expressão XPath a serem mascaradas. Este campo é obrigatório. |
1. Criar ou substituir a lista XPath personalizada (PUT)
Use o método PUT para criar uma nova lista personalizada ou substituir completamente o conteúdo de uma lista atual. Todos os XPaths atuais são substituídos.
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" ] }'
Quando a atualização for concluída, uma resposta 201 Created ou 200K será exibida com a seguinte mensagem: Success response (201 Created or 200 OK)
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value" ] }
2. Recuperar a lista XPath personalizada (GET)
Use o método GET para recuperar a lista atual de expressões XPath personalizadas.
curl -X GET https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \ -H "Authorization: Bearer OAUTH_TOKEN"
Quando a recuperação for concluída, uma resposta 200K será exibida com a seguinte mensagem:Success response (200 OK):
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value" ] }
3. Anexar XPaths à lista (POST append)
Use o método POST para anexar uma ou mais expressões XPath à lista atual sem substituir o conteúdo atual.
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" ] }'
Quando a anexação for concluída, uma resposta 200K será exibida com a seguinte mensagem: Success response (200 OK):
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value", "//New/Appended/XPath" ] }
4. Excluir XPaths específicos da lista (POST deleteItems)
Use o método POST para remover expressões XPath específicas da lista atual. A solicitação precisa conter as strings XPath exatas a serem removidas.
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" ] }'
Quando a exclusão for concluída, uma resposta 200K será exibida com a seguinte mensagem: Success response (200 OK):
{ "xpaths": [ "//StatisticsCollector/Statistics/Statistic[@name='caller']", "//AssignMessage/AssignVariable[Name='password']/Value" ] }
5. Excluir toda a lista XPath personalizada (DELETE)
Use o método DELETE para remover completamente a lista XPath personalizada. Isso removerá apenas as máscaras personalizadas ; as máscaras padrão ainda serão aplicadas.
curl -X DELETE https://api.enterprise.apigee.com/v1/organizations/ORG_NAME/uapim/proxymasks \ -H "Authorization: Bearer OAUTH_TOKEN"
Quando a exclusão for concluída, uma resposta 204 No Content será exibida com a seguinte mensagem: Success response (204 No Content):
HTTP/1.1 204 No Content
Atualizar pacotes mascarados
Ao modificar a configuração de mascaramento de PII personalizada, os pacotes de proxy de API que foram enviados anteriormente com uma configuração de máscara mais antiga precisam ser reprocessados com as máscaras mais recentes. Para atualizar os pacotes com as configurações de mascaramento mais recentes, registre um tíquete de suporte para iniciar o reprocessamento necessário.