REST Resource: alerts

Recurso: Alert

Una alerta que afecta a un cliente.

Representación JSON 
{
  "customerId": string,
  "alertId": string,
  "createTime": string,
  "startTime": string,
  "endTime": string,
  "type": string,
  "source": string,
  "data": {
    "@type": string,
    field1: ...,
    ...
  },
  "securityInvestigationToolLink": string,
  "deleted": boolean,
  "metadata": {
    object (AlertMetadata)
  },
  "updateTime": string,
  "etag": string
}
Campos
customerId

string

Solo salida. Es el identificador único de la cuenta de Google Workspace del cliente.
alertId

string

Solo salida. El identificador único de la alerta.
createTime

string (Timestamp format)

Solo salida. La hora en que se creó esta alerta.
startTime

string (Timestamp format)

Obligatorio. La hora en que se inició o detectó el evento que causó esta alerta.
endTime

string (Timestamp format)

Opcional. La hora a la que el evento que causó esta alerta dejó de estar activo. Si se proporciona, la hora de finalización no debe ser anterior a la hora de inicio. Si no se proporciona, indica una alerta en curso.
type

string

Obligatorio. El tipo de alerta. Esto se muestra solo después de que se crea la alerta. Para obtener una lista de los tipos de alerta disponibles, consulta Tipos de alertas de Google Workspace.
source

string

Obligatorio. Un identificador único para el sistema que informó la alerta. Esto se muestra solo después de que se crea la alerta.

Las fuentes admitidas son cualquiera de las siguientes:

  • Operaciones de Google
  • Administración de dispositivos móviles
  • Phishing de Gmail
  • Prevención de pérdida de datos
  • Exportación en todo el dominio
  • Ataque patrocinado por el Estado
  • Identidad de Google
  • Interrupción de las apps
data

object

Opcional. Los datos asociados con esta alerta, por ejemplo, google.apps.alertcenter.type.DeviceCompromised.
deleted

boolean

Solo salida. Es True si esta alerta se marcó para su eliminación.
metadata

object (AlertMetadata)

Solo salida. Los metadatos asociados con esta alerta.
updateTime

string (Timestamp format)

Solo salida. La hora en que se actualizó esta alerta por última vez.
etag

string

Opcional. etag se usa para el control de simultaneidad optimista, como una forma de evitar que las actualizaciones simultáneas de una alerta se reemplacen entre sí. Se recomienda que los sistemas usen la etag en el ciclo de lectura, modificación y escritura para realizar actualizaciones de alertas y evitar condiciones de carrera: se muestra una etag en la respuesta que contiene alertas, y se espera que los sistemas coloquen esa ETag en la solicitud de actualización de la alerta para garantizar que su cambio se aplique a la misma versión de la alerta.

Si no se proporciona un etag en la llamada para actualizar la alerta, la alerta existente se reemplazará sin consultar.

AlertMetadata

Metadatos de una alerta.

Representación JSON 
{
  "customerId": string,
  "alertId": string,
  "status": string,
  "assignee": string,
  "updateTime": string,
  "severity": string,
  "etag": string
}
Campos
customerId

string

Solo salida. Es el identificador único de la cuenta de Google Workspace del cliente.
alertId

string

Solo salida. El identificador de la alerta.
status

string

El estado actual de la alerta. Los valores admitidos son los siguientes:

  • NOT_STARTED
  • IN_PROGRESS
  • CERRADO
assignee

string

La dirección de correo electrónico del usuario asignado a la alerta.
updateTime

string (Timestamp format)

Solo salida. Fecha y hora en la que se actualizaron los metadatos por última vez.
severity

string

El valor de gravedad de la alerta. El Centro de alertas configurará este campo en el momento de la creación de la alerta. Si no se pudo determinar, se utilizará una cadena vacía de forma predeterminada. Los valores admitidos para las acciones de actualización en este campo son los siguientes:

  • ALTO
  • MEDIO
  • BAJO
etag

string

Opcional. etag se usa para el control de simultaneidad optimista, como una forma de evitar que las actualizaciones simultáneas de los metadatos de una alerta se reemplacen entre sí. Se recomienda que los sistemas usen etag en el ciclo de lectura, modificación y escritura para realizar actualizaciones de metadatos y evitar condiciones de carrera: se muestra una etag en la respuesta que contiene metadatos de alerta, y se espera que los sistemas coloquen esa ETag en la solicitud de actualización de los metadatos de las alertas para garantizar que su cambio se aplique a la misma versión de los metadatos de la alerta.

Si no se proporciona un etag en la llamada para actualizar los metadatos de la alerta, los metadatos de la alerta existentes se reemplazarán de forma ciega.

Métodos

batchDelete

 Realiza la operación de eliminación por lotes en las alertas.

batchUndelete

 Realiza la operación de recuperación por lotes de las alertas.

delete

 Marca la alerta especificada para su eliminación.

get

 Obtiene la alerta especificada.

getMetadata

 Muestra los metadatos de una alerta.

list

 Enumera las alertas.

undelete

 Restablece o "recupera" una alerta que se marcó para borrarse en los últimos 30 días.