Method: projects.locations.identityMappingStores.purgeIdentityMappings

Löscht angegebene oder alle Einträge für die Identitätszuordnung aus einem Speicher für die Identitätszuordnung.

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
identityMappingStore

string

Erforderlich. Der Name des Identity Mapping Store, aus dem Identity Mapping-Einträge gelöscht werden sollen. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

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

string

Passende Identitätszuweisungen filtern, die 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: *

Bei den Filterfeldern wird von einer impliziten UND-Verknüpfung ausgegangen. Sollte nicht mit „source“ verwendet werden. Wenn beide angegeben sind, wird ein Fehler ausgegeben.
Union-Feld source. Die Quelle der Eingabe. Für source ist nur einer der folgenden Werte zulässig:
inlineSource

object (InlineSource)

Die Inline-Quelle, aus der Identitätszuordnungseinträge entfernt werden sollen.
force

boolean

Führt den Löschvorgang tatsächlich aus. Wenn force auf „false“ gesetzt ist, wird die erwartete Anzahl an Löschungen zurückgegeben, ohne Identitätszuordnungen zu löschen. Dieses Feld wird nur für das Löschen mit Filter unterstützt. Für die Eingabequelle wird dieses Feld ignoriert und Daten werden unabhängig vom Wert dieses Felds 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

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ätszuordnungseinträge entfernt werden sollen.

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

object (IdentityMappingEntry)

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