Method: projects.locations.identityMappingStores.purgeIdentityMappings

Borra las entradas de Identity Mapping especificadas o todas las entradas de un Identity Mapping Store.

Solicitud HTTP

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

La URL usa la sintaxis de la transcodificación gRPC.

Parámetros de ruta de acceso

Parámetros
identityMappingStore

string

Obligatorio. Nombre del almacén de asignación de identidades del que se borrarán las entradas de asignación de identidades. Formato: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación 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
}
Campos
filter

string

Filtra las asignaciones de identidad coincidentes que se deben purgar. El campo apto para filtrar es * updateTime: En formato ISO 8601 “zulu” * externalId

Ejemplos:

  • Borra todas las asignaciones de identidad actualizadas en un período: updateTime > "2012-04-23T18:25:43.511Z" AND updateTime < "2012-04-23T18:30:43.511Z"
  • Borra todas las asignaciones de identidad para un externalId determinado: externalId = "id1"
  • Borra todas las asignaciones de identidad dentro de un almacén de asignaciones de identidad: *

Se supone que los campos de filtrado tienen un AND implícito. No se debe usar con la fuente. Si se proporcionan ambos, se arrojará un error.
Campo de unión source. Es la fuente de la entrada. source puede ser solo uno de los siguientes:
inlineSource

object (InlineSource)

Es la fuente intercalada desde la que se borrarán las entradas de asignación de identidad.
force

boolean

Realiza la eliminación definitiva. Si force se establece como falso, devuelve el recuento de eliminación definitiva previsto sin borrar ninguna asignación de identidad. Este campo solo se admite para la eliminación con filtro. Para la fuente de entrada, este campo se ignora y los datos se borrarán independientemente del valor de este campo.

Cuerpo de la respuesta

Si se ejecuta de forma correcta, el cuerpo de la respuesta contiene una instancia de Operation.

Alcances de autorización

Se necesita uno de los siguientes permisos de OAuth:

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

Para obtener más información, consulta Authentication Overview.

Permisos de IAM

Se requiere el siguiente permiso de IAM en el recurso identityMappingStore:

  • discoveryengine.identityMappingStores.purgeIdentityMappings

Para obtener más información, consulta la documentación de IAM.

InlineSource

Es la fuente intercalada desde la que se borrarán las entradas de asignación de identidad.

Representación JSON 
{
  "identityMappingEntries": [
    {
      object (IdentityMappingEntry)
    }
  ]
}
Campos
identityMappingEntries[]

object (IdentityMappingEntry)

Se puede purgar un máximo de 10,000 entradas a la vez.