Method: projects.locations.identityMappingStores.purgeIdentityMappings

Limpa as entradas de mapeamento de identidade especificadas ou todas as entradas de mapeamento de identidade de um armazenamento de mapeamento de identidade.

Pedido HTTP

POST https://discoveryengine.googleapis.com/v1beta/{identityMappingStore=projects/*/locations/*/identityMappingStores/*}:purgeIdentityMappings

O URL usa a sintaxe de transcodificação de gRPC.

Parâmetros de caminho

Parâmetros
identityMappingStore

string

Obrigatório. O nome da loja de mapeamento de identidades a partir da qual as entradas de mapeamento de identidades vão ser anuladas. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

Corpo do pedido

O corpo do pedido contém dados com a seguinte estrutura:

Representação JSON 
{
  "filter": string,

  // Union field source can be only one of the following:
  "inlineSource": {
    object (InlineSource)
  }
  // End of list of possible types for union field source.
  "force": boolean
}
Campos
filter

string

Filtre os mapeamentos de identidade correspondentes para os expurgar. O campo elegível para filtragem é: * updateTime: no formato "zulu" ISO 8601. * externalId

Exemplos:

  • Eliminar todos os mapeamentos da identidade atualizados num intervalo de tempo: updateTime > "2012-04-23T18:25:43.511Z" AND updateTime < "2012-04-23T18:30:43.511Z"
  • Eliminar todos os mapeamentos de identidade para um given externalId: externalId = "id1"
  • Eliminar todos os mapeamentos da identidade num arquivo de mapeamento da identidade: *

Assume-se que os campos de filtragem têm um AND implícito. Não deve ser usado com a origem. Se ambos forem fornecidos, é gerado um erro.
Campo de união source. A origem da entrada. source só pode ser uma das seguintes opções:
inlineSource

object (InlineSource)

A origem inline a partir da qual as entradas de mapeamento de identidade devem ser anuladas.
force

boolean

Executa efetivamente a eliminação. Se force estiver definido como falso, devolva a contagem de eliminação esperada sem eliminar mapeamentos de identidade. Este campo só é suportado para a eliminação com filtro. Para a origem de entrada, este campo é ignorado e os dados são eliminados independentemente do valor deste campo.

Corpo da resposta

Se for bem-sucedido, o corpo da resposta contém uma instância de Operation.

Âmbitos de autorização

Requer um dos seguintes âmbitos do OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

Para mais informações, consulte o Authentication Overview.

Autorizações de IAM

Requer a seguinte autorização de IAM no recurso identityMappingStore:

  • discoveryengine.identityMappingStores.purgeIdentityMappings

Para mais informações, consulte a documentação do IAM.

InlineSource

A origem inline a partir da qual as entradas de mapeamento de identidade devem ser anuladas.

Representação JSON 
{
  "identityMappingEntries": [
    {
      object (IdentityMappingEntry)
    }
  ]
}
Campos
identityMappingEntries[]

object (IdentityMappingEntry)

É possível expurgar um máximo de 10 000 entradas de uma vez