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. Es el identificador único de la alerta.
createTime

string (Timestamp format)

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

string (Timestamp format)

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

string (Timestamp format)

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

string

Obligatorio. Es el tipo de alerta. Este valor se muestra solo después de crear la alerta. Para obtener una lista de los tipos de alertas disponibles, consulta Tipos de alertas de Google Workspace.
source

string

Obligatorio. Es un identificador único para el sistema que informó la alerta. Este valor se muestra solo después de crear la alerta.

Las fuentes admitidas son las siguientes:

  • Operaciones de Google
  • Administración de dispositivos móviles
  • Phishing de Gmail
  • Prevención de pérdida de datos
  • Exportación de datos en todo el dominio
  • Ataque auspiciado 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. True si esta alerta está marcada para su eliminación.
metadata

object (AlertMetadata)

Solo salida. Son los metadatos asociados con esta alerta.
updateTime

string (Timestamp format)

Solo salida. La hora en la 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 etag en el ciclo de lectura, modificación y escritura para realizar actualizaciones de alertas y evitar condiciones de carrera: Se muestra un etag en la respuesta que contiene alertas, y se espera que los sistemas coloquen esa etiqueta en la solicitud para actualizar la alerta y asegurarse de que el cambio se aplique a la misma versión de la alerta.

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

AlertMetadata

Son los 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. Es el identificador de la alerta.
status

string

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

  • NOT_STARTED
  • IN_PROGRESS
  • CERRADO
assignee

string

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

string (Timestamp format)

Solo salida. La hora en la que se actualizaron estos metadatos por última vez.
severity

string

Es el valor de gravedad de la alerta. El Centro de alertas establecerá este campo en el momento de la creación de la alerta. El valor predeterminado es una cadena vacía cuando no se puede determinar. 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 para evitar condiciones de carrera: Se muestra un etag en la respuesta que contiene metadatos de alerta, y se espera que los sistemas coloquen esa etiqueta en la solicitud para actualizar los metadatos de alerta y garantizar que el cambio se aplique a la misma versión de los metadatos de alerta.

Si no se proporciona ninguna etag en la llamada para actualizar los metadatos de la alerta, los metadatos de la alerta existentes se reemplazarán sin consultar.

Métodos

batchDelete

 Realiza una operación de eliminación masiva en las alertas.

batchUndelete

 Realiza una operación de recuperación masiva en las alertas.

delete

 Marca la alerta especificada para su eliminación.

get

 Obtiene la alerta especificada.

getMetadata

 Devuelve los metadatos de una alerta.

list

 Muestra una lista de las alertas.

undelete

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