Method: projects.locations.identityMappingStores.purgeIdentityMappings

Elimina le voci di mappatura delle identità specificate o tutte le voci di un archivio di mappatura delle identità.

Richiesta HTTP


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

Gli URL utilizzano la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
identityMappingStore

string

Obbligatorio. Il nome dell'archivio di mappatura delle identità da cui eliminare le voci di mappatura delle identità. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione 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
}
Campi
filter

string

Filtra le mappature delle identità corrispondenti da eliminare. Il campo idoneo per il filtro è:

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

Esempi:

  • Eliminazione di tutte le mappature delle identità aggiornate in un intervallo di tempo: updateTime > "2012-04-23T18:25:43.511Z" AND updateTime < "2012-04-23T18:30:43.511Z"
  • Eliminazione di tutte le mappature delle identità per un determinato externalId: externalId = "id1"
  • Eliminazione di tutte le mappature delle identità all'interno di un archivio di mappature delle identità: *

Si presume che i campi di filtro abbiano un AND implicito. Non deve essere utilizzato con la sorgente. Se vengono forniti entrambi, verrà generato un errore.
L'origine dell'input. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
inlineSource

object (InlineSource)

L'origine in linea da cui eliminare le voci di mappatura delle identità.
Fine dei campi che si escludono a vicenda.
force

boolean

Esegue effettivamente l'eliminazione. Se force è impostato su false, restituisci il numero di eliminazioni previsto senza eliminare alcun mapping delle identità. Questo campo è supportato solo per l'eliminazione definitiva con filtro. Per l'origine di input, questo campo viene ignorato e i dati vengono eliminati indipendentemente dal valore di questo campo.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Operation.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa identityMappingStore:

  • discoveryengine.identityMappingStores.purgeIdentityMappings

Per saperne di più, consulta la documentazione di IAM.

InlineSource

L'origine in linea da cui eliminare le voci di mappatura delle identità.

Rappresentazione JSON 
{
  "identityMappingEntries": [
    {
      object (IdentityMappingEntry)
    }
  ]
}
Campi
identityMappingEntries[]

object (IdentityMappingEntry)

È possibile eliminare un massimo di 10.000 voci alla volta