Method: projects.locations.identityMappingStores.purgeIdentityMappings

Exclui as entradas de mapeamento de identidade especificadas ou todas de um repositório de mapeamento de identidade.

Solicitação HTTP


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

Os URLs usam a sintaxe de Transcodificação gRPC.

Parâmetros de caminho

Parâmetros
identityMappingStore

string

Obrigatório. O nome do Identity Mapping Store de onde as entradas de mapeamento de identidade serão excluídas. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "inlineSource": {
    object (InlineSource)
  }
  // End of mutually exclusive fields.
  "force": boolean
}
Campos
filter

string

Filtre os mapeamentos de identidade correspondentes para limpar. O campo qualificado para filtragem é:

  • updateTime: no formato "zulu" ISO 8601.
  • externalId

Exemplos:

  • Excluir todos os mapeamentos de identidade atualizados em um período: updateTime > "2012-04-23T18:25:43.511Z" AND updateTime < "2012-04-23T18:30:43.511Z"
  • Excluindo todos os mapeamentos de identidade para um determinado externalId: externalId = "id1"
  • Excluir todos os mapeamentos de identidade em um repositório de mapeamento de identidade: *

Os campos de filtragem têm um AND implícito. Não deve ser usado com a origem. Um erro será gerado se os dois forem fornecidos.
A origem da entrada. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
inlineSource

object (InlineSource)

A fonte inline de onde as entradas de mapeamento de identidade serão excluídas.
Fim dos campos mutuamente exclusivos.
force

boolean

Realiza a exclusão permanente. Se force for definido como "false", retorne a contagem de limpeza esperada sem excluir mapeamentos de identidade. Esse campo só é compatível com a exclusão permanente com filtro. Para a origem de entrada, esse campo é ignorado, e os dados são excluídos independente do valor dele.

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta conterá uma instância de Operation.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

Para mais informações, consulte Authentication Overview.

Permissões do IAM

Requer a seguinte permissão do IAM no recurso identityMappingStore:

  • discoveryengine.identityMappingStores.purgeIdentityMappings

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

InlineSource

A fonte inline de onde as entradas de mapeamento de identidade serão excluídas.

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

object (IdentityMappingEntry)

É possível excluir no máximo 10.000 entradas por vez.