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:
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.
[[["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-02-28 UTC."],[[["This endpoint purges specified or all Identity Mapping Entries from a designated Identity Mapping Store."],["The `identityMappingStore` path parameter is required, and it specifies the target store from which to purge entries."],["The request body allows for filtering identity mappings to be purged based on `updateTime` or `external_id` or all, and supports an `inlineSource` to purge identity mapping entries."],["The `force` field in the request body determines whether the purge is actually executed or just estimated when using filters."],["A successful request returns an `Operation` instance, and the operation requires `https://www.googleapis.com/auth/cloud-platform` OAuth scope for authorization."]]],[]]
