Method: projects.locations.identityMappingStores.purgeIdentityMappings

Borra las entradas de asignación de identidad especificadas o todas las entradas de un almacén de asignación de identidad.

Solicitud HTTP


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

Las URL usan la sintaxis de 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,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "inlineSource": {
    object (InlineSource)
  }
  // End of mutually exclusive fields.
  "force": boolean
}
Campos
filter

string

Filtra las asignaciones de identidad coincidentes que se borrarán. El campo apto para filtrar es el siguiente:

  • 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.

Es la fuente de la entrada. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta:
inlineSource

object (InlineSource)

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

Fin de los campos mutuamente excluyentes.
force

boolean

Realiza la purga. 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
  • https://www.googleapis.com/auth/discoveryengine.serving.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.