REST Resource: alerts

Recurso: alerta

Um alerta que afeta um cliente.

Representação 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

Apenas saída. O identificador exclusivo da conta do Google Workspace do cliente.
alertId

string

Apenas saída. O identificador exclusivo do alerta.
createTime

string (Timestamp format)

Apenas saída. A hora em que este alerta foi criado.
startTime

string (Timestamp format)

Obrigatório. A hora em que o evento que causou este alerta foi iniciado ou detectado.
endTime

string (Timestamp format)

Opcional. A hora em que o evento que causou este alerta deixou de estar ativo. Se fornecido, o horário de término não pode ser anterior ao horário de início. Se não for informado, um alerta será exibido.
type

string

Obrigatório. O tipo do alerta. Isso só é gerado após a criação do alerta. Veja os tipos de alerta disponíveis em Tipos de alerta do Google Workspace.
source

string

Obrigatório. Identificador exclusivo do sistema que informou o alerta. Isso só é gerado após a criação do alerta.

As origens compatíveis são:

  • Operações do Google
  • Gerenciamento de dispositivos móveis
  • Phishing do Gmail
  • Prevenção contra perda de dados
  • Retirada de dados em todo o domínio
  • Ataque patrocinado pelo governo
  • Identidade do Google
  • Falha temporária dos apps
data

object

Opcional. Os dados associados a este alerta, por exemplo, google.apps.alertcenter.type.DeviceCompromised.
deleted

boolean

Apenas saída. True: se este alerta estiver marcado para exclusão.
metadata

object (AlertMetadata)

Apenas saída. Os metadados associados a este alerta.
updateTime

string (Timestamp format)

Apenas saída. A hora em que este alerta foi atualizado pela última vez.
etag

string

Opcional. O etag é usado para controlar a simultaneidade otimista como uma forma de ajudar a evitar que atualizações simultâneas de um alerta substituam umas às outras. É altamente recomendável que os sistemas usem o etag no ciclo de leitura-modificação-gravação para realizar atualizações de alerta a fim de evitar disputas: um etag é retornado na resposta que contém alertas, e é esperado que os sistemas coloquem essa ETag na solicitação para atualizar o alerta, garantindo que a mudança seja aplicada à mesma versão do alerta.

Se nenhum etag for fornecido na chamada para atualizar o alerta, o alerta existente será substituído às cegas.

Metadados de alerta

Metadados de alerta.

Representação JSON 
{
  "customerId": string,
  "alertId": string,
  "status": string,
  "assignee": string,
  "updateTime": string,
  "severity": string,
  "etag": string
}
Campos
customerId

string

Apenas saída. O identificador exclusivo da conta do Google Workspace do cliente.
alertId

string

Apenas saída. O identificador do alerta.
status

string

O status atual do alerta. Os valores compatíveis são os seguintes:

  • INÍCIO
  • IN_PROGRESS
  • FECHADO
assignee

string

Endereço de e-mail do usuário atribuído ao alerta.
updateTime

string (Timestamp format)

Apenas saída. A hora em que os metadados foram atualizados pela última vez.
severity

string

Valor da gravidade do alerta. A Central de alertas define esse campo no momento da criação do alerta, que assume como padrão uma string vazia quando ele não pode ser determinado. Os valores compatíveis para as ações de atualização neste campo são os seguintes:

  • ALTA
  • MEDIUM
  • LOW
etag

string

Opcional. O etag é usado para um controle de simultaneidade otimista como uma maneira de evitar que atualizações simultâneas de metadados de um alerta substituam umas às outras. É altamente recomendável que os sistemas usem o etag no ciclo de leitura-modificação-gravação para realizar atualizações de metadados a fim de evitar disputas: um etag é retornado na resposta que contém metadados de alerta, e é esperado que os sistemas coloquem essa ETag na solicitação para atualizar os metadados de alerta, garantindo que a alteração seja aplicada à mesma versão dos metadados de alerta.

Se nenhum etag for fornecido na chamada para atualizar os metadados de alerta, os metadados de alerta existentes serão substituídos às cegas.

Métodos

batchDelete

 Executa a operação de exclusão em lote em alertas.

batchUndelete

 Realiza operações de cancelamento de exclusão em lote em alertas.

delete

 Marca o alerta especificado para exclusão.

get

 Recebe o alerta especificado.

getMetadata

 Retorna os metadados de um alerta.

list

 Lista os alertas.

undelete

 Restaura ou cancela a exclusão de um alerta marcado para exclusão nos últimos 30 dias.