Method: projects.locations.identityMappingStores.purgeIdentityMappings

Löscht angegebene oder alle Identitätszuweisungseinträge dauerhaft aus einem Identitätszuweisungsspeicher.

HTTP-Anfrage

:


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

Für die URLs wird die Syntax der gRPC-Transcodierung verwendet.

Pfadparameter

Parameter
identityMappingStore

string

Erforderlich. Der Name des Identitätszuweisungsspeichers, aus dem Identitätszuweisungseinträge dauerhaft gelöscht werden sollen. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "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
}
Felder
filter

string

Filtert übereinstimmende Identitätszuweisungen, die dauerhaft gelöscht werden sollen. Folgendes Feld kann gefiltert werden:

  • updateTime: Im ISO-8601-Format „Zulu“.
  • externalId

Beispiele:

  • Alle Identitätszuweisungen löschen, die in einem bestimmten Zeitraum aktualisiert wurden: updateTime > "2012-04-23T18:25:43.511Z" AND updateTime < "2012-04-23T18:30:43.511Z"
  • Alle Identitätszuweisungen für eine bestimmte externalId löschen: externalId = "id1"
  • Alle Identitätszuweisungen in einem Identitätszuweisungsspeicher löschen: *

In den Filterfeldern wird von einer impliziten UND-Verknüpfung ausgegangen. Sollte nicht mit „source“ verwendet werden. Wenn beide angegeben sind, wird ein Fehler ausgegeben.
Die Quelle der Eingabe. Im Folgenden finden Sie eine Liste von sich gegenseitig ausschließenden Feldern. In einer Antwort wird höchstens eines der Felder festgelegt:
inlineSource

object (InlineSource)

Die Inline-Quelle, aus der Identitätszuweisungseinträge dauerhaft gelöscht werden sollen.
Ende der sich gegenseitig ausschließenden Felder.
force

boolean

Löscht die Einträge dauerhaft. Wenn force auf „false“ gesetzt ist, wird die erwartete Anzahl der Löschungen zurückgegeben, ohne Identitätszuweisungen dauerhaft zu löschen. Dieses Feld wird nur für dauerhaftes Löschen mit Filter unterstützt. Für die Eingabequelle wird dieses Feld ignoriert. Daten werden unabhängig vom Wert dieses Feldes dauerhaft gelöscht.

Antworttext

Wenn der Vorgang erfolgreich abgeschlossen wurde, enthält der Antworttext eine Instanz von Operation.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie unter Authentication Overview.

IAM-Berechtigungen

Erfordert die folgende IAM-Berechtigung für die Ressource identityMappingStore:

  • discoveryengine.identityMappingStores.purgeIdentityMappings

Weitere Informationen finden Sie in der IAM-Dokumentation.

InlineSource

Die Inline-Quelle, aus der Identitätszuweisungseinträge dauerhaft gelöscht werden sollen.

JSON-Darstellung 
{
  "identityMappingEntries": [
    {
      object (IdentityMappingEntry)
    }
  ]
}
Felder
identityMappingEntries[]

object (IdentityMappingEntry)

Es können maximal 10.000 Einträge gleichzeitig dauerhaft gelöscht werden.