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:
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-06-27 UTC."],[[["\u003cp\u003eThis endpoint purges specified or all Identity Mapping Entries from a given Identity Mapping Store via a POST request.\u003c/p\u003e\n"],["\u003cp\u003eThe request URL uses gRPC Transcoding syntax and requires the \u003ccode\u003eidentityMappingStore\u003c/code\u003e path parameter, which identifies the target store.\u003c/p\u003e\n"],["\u003cp\u003eThe request body can use a filter to specify which identity mappings to delete based on \u003ccode\u003eupdateTime\u003c/code\u003e or \u003ccode\u003eexternal_id\u003c/code\u003e, or use \u003ccode\u003einlineSource\u003c/code\u003e to delete by providing the entries directly.\u003c/p\u003e\n"],["\u003cp\u003eA \u003ccode\u003eforce\u003c/code\u003e parameter in the request body determines if the purge should be executed, or only calculated, and it is only supported when using the filter.\u003c/p\u003e\n"],["\u003cp\u003eThe operation requires the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"]]],[],null,["# Method: projects.locations.identityMappingStores.purgeIdentityMappings\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [IAM Permissions](#body.aspect_1)\n- [InlineSource](#InlineSource)\n - [JSON representation](#InlineSource.SCHEMA_REPRESENTATION)\n\nPurges specified or all Identity Mapping Entries from an Identity Mapping Store.\n\n### HTTP request\n\n`POST https://discoveryengine.googleapis.com/v1/{identityMappingStore=projects/*/locations/*/identityMappingStores/*}:purgeIdentityMappings`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nIf successful, the response body contains an instance of [Operation](/generative-ai-app-builder/docs/reference/rest/Shared.Types/ListOperationsResponse#Operation).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\n### IAM Permissions\n\nRequires the following [IAM](https://cloud.google.com/iam/docs) permission on the `identityMappingStore` resource:\n\n- `discoveryengine.identityMappingStores.purgeIdentityMappings`\n\nFor more information, see the [IAM documentation](https://cloud.google.com/iam/docs).\n\nInlineSource\n------------\n\nThe inline source to purge identity mapping entries from."]]
