Method: projects.locations.identityMappingStores.purgeIdentityMappings

Purges specified or all Identity Mapping Entries from an Identity Mapping Store.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
identityMappingStore

string

Required. The name of the Identity Mapping Store to purge Identity Mapping Entries from. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "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
}
Fields
filter

string

Filter matching identity mappings to purge. The eligible field for filtering is: * updateTime: in ISO 8601 "zulu" format. * externalId

Examples:

  • Deleting all identity mappings updated in a time range: updateTime > "2012-04-23T18:25:43.511Z" AND updateTime < "2012-04-23T18:30:43.511Z"
  • Deleting all identity mappings for a given externalId: externalId = "id1"
  • Deleting all identity mappings inside an identity mapping store: *

The filtering fields are assumed to have an implicit AND. Should not be used with source. An error will be thrown, if both are provided.
Union field source. The source of the input. source can be only one of the following:
inlineSource

object (InlineSource)

The inline source to purge identity mapping entries from.
force

boolean

Actually performs the purge. If force is set to false, return the expected purge count without deleting any identity mappings. This field is only supported for purge with filter. For input source this field is ignored and data will be purged regardless of the value of this field.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the identityMappingStore resource:

  • discoveryengine.identityMappingStores.purgeIdentityMappings

For more information, see the IAM documentation.

InlineSource

The inline source to purge identity mapping entries from.

JSON representation 
{
  "identityMappingEntries": [
    {
      object (IdentityMappingEntry)
    }
  ]
}
Fields
identityMappingEntries[]

object (IdentityMappingEntry)

A maximum of 10000 entries can be purged at one time