Method: projects.locations.identityMappingStores.purgeIdentityMappings

從身分識別對應儲存區清除指定或所有身分識別對應項目。

HTTP 要求

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

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
identityMappingStore

string

這是必要旗標，要從中清除識別資訊對應項目的識別資訊對應商店名稱。格式：projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

要求主體

要求主體包含下列結構的資料：

JSON 表示法 
{
  "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
}
欄位
filter

string

篩選要清除的相符識別資訊對應檔。適用篩選功能的欄位如下：* updateTime：採用 ISO 8601 的「zulu」格式。* externalId

範例：

  • 刪除在某個時間範圍內更新的所有身分識別對應：updateTime > "2012-04-23T18:25:43.511Z" AND updateTime < "2012-04-23T18:30:43.511Z"
  • 刪除特定 externalId 的所有身分對應：externalId = "id1"
  • 刪除識別資訊對應檔儲存區中的所有識別資訊對應檔：*

篩選欄位會預設為隱含的 AND 條件。請勿與來源搭配使用。如果同時提供這兩項資訊，系統會擲回錯誤。
聯集欄位 source。輸入內容的來源。source 只能是下列其中一項：
inlineSource

object (InlineSource)

要從中清除身分對應項目的內嵌來源。
force

boolean

實際執行清除作業。如果 force 設為 false，則會傳回預估的清除次數，但不會刪除任何身分對應。這個欄位僅支援使用篩選器清除。如果是輸入來源，系統會忽略這個欄位，並清除資料，不論這個欄位的值為何。

回應主體

如果成功，回應主體會包含 Operation 的執行個體。

授權範圍

需要下列其中一種 OAuth 範圍：

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

詳情請參閱Authentication Overview。

IAM 權限

需要 identityMappingStore 資源的下列 IAM 權限：

  • discoveryengine.identityMappingStores.purgeIdentityMappings

詳情請參閱 IAM 說明文件。

InlineSource

要從中清除身分對應項目的內嵌來源。

JSON 表示法 
{
  "identityMappingEntries": [
    {
      object (IdentityMappingEntry)
    }
  ]
}
欄位
identityMappingEntries[]

object (IdentityMappingEntry)

一次最多可清除 10000 個項目