Method: projects.locations.identityMappingStores.purgeIdentityMappings
Stay organized with collections
Save and categorize content based on your preferences.
Purges specified or all Identity Mapping Entries from an Identity Mapping Store.
HTTP request
POST https://discoveryengine.googleapis.com/v1beta/{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. * external_id 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 external_id:
external_id = "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.
InlineSource
The inline source to purge identity mapping entries from.
| Fields |
identityMappingEntries[] |
object (IdentityMappingEntry)
A maximum of 10000 entries can be purged at one time
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-03 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-03-03 UTC."],[[["This endpoint purges specified or all Identity Mapping Entries from a given Identity Mapping Store."],["The `POST` request to `https://discoveryengine.googleapis.com/v1beta/{identityMappingStore=projects/*/locations/*/identityMappingStores/*}:purgeIdentityMappings` initiates the purge operation."],["You can use a `filter` to specify which identity mappings to delete, using criteria like `updateTime` or `external_id`, or target all entries with `*`."],["The request body can include either a filter to delete identity mapping entries, or an `inlineSource` where mapping entries are provided directly, and the `force` field in the body allows for testing the expected purge count before actual deletion."],["Successful responses return an `Operation` and the operation requires the OAuth scope `https://www.googleapis.com/auth/cloud-platform` for authorization."]]],[]]
