Method: projects.locations.identityMappingStores.purgeIdentityMappings

Elimina las entradas de mapeado de identidades especificadas o todas las entradas de un almacén de mapeado de identidades.

Solicitud HTTP

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

La URL utiliza la sintaxis de transcodificación a gRPC.

Parámetros de ruta

Parámetros
identityMappingStore

string

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

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos que presentan 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 los mapeados de identidades coincidentes que quieras purgar. El campo apto para filtrar es: * updateTime: en formato "zulu" ISO 8601. * externalId

Ejemplos:

  • Eliminar todos los mapeados de identidades actualizados en un intervalo de tiempo: updateTime > "2012-04-23T18:25:43.511Z" AND updateTime < "2012-04-23T18:30:43.511Z"
  • Eliminar todos los mapeos de identidades de un externalId determinado: externalId = "id1"
  • Eliminar todos los mapeados de identidades de un almacén de mapeados de identidades: *

Se presupone que los campos de filtrado tienen un AND implícito. No se debe usar con la fuente. Se producirá un error si se proporcionan ambos.
Campo de unión source. La fuente de la entrada. source solo puede ser una de estas dos opciones:
inlineSource

object (InlineSource)

La fuente insertada de la que se purgarán las entradas de mapeo de identidades.
force

boolean

Realiza la purga. Si force tiene el valor "false", devuelve el recuento de purgas esperado sin eliminar ninguna asignación de identidad. Este campo solo se admite en la purga con filtro. En el caso de la fuente de entrada, este campo se ignora y los datos se purgan independientemente del valor de este campo.

Cuerpo de la respuesta

Si la solicitud se hace correctamente, en el cuerpo de la respuesta se incluye una instancia de Operation.

Permisos de autorización

Debes disponer de 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 el Authentication Overview.

Permisos de IAM

Requiere el siguiente permiso de gestión de identidades y accesos en el recurso identityMappingStore:

  • discoveryengine.identityMappingStores.purgeIdentityMappings

Para obtener más información, consulta la documentación de gestión de identidades y accesos.

InlineSource

La fuente insertada de la que se purgarán las entradas de mapeo de identidades.

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

object (IdentityMappingEntry)

Se pueden purgar un máximo de 10.000 entradas a la vez