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 o alerta foi criado.
startTime

string (Timestamp format)

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

string (Timestamp format)

Opcional. A hora em que o evento que causou esse 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 fornecido, indica um alerta em andamento.
type

string

Obrigatório. O tipo de alerta. Essa é a saída somente após a criação do alerta. Para conferir uma lista dos tipos de alerta disponíveis, consulte Tipos de alerta do Google Workspace.
source

string

Obrigatório. Um identificador exclusivo do sistema que informou o alerta. Essa é a saída somente 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
  • Download de dados de todo o domínio
  • Ataque patrocinado por governos
  • Identidade do Google
  • Interrupção temporária dos apps
data

object

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

boolean

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

object (AlertMetadata)

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

string (Timestamp format)

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

string

Opcional. etag é usado para controle de simultaneidade otimista como uma maneira de impedir 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 e evitar disputas. Um etag é retornado na resposta que contém alertas, e os sistemas precisam colocar esse etag na solicitação para atualizar o alerta e garantir que a mudança seja aplicada à mesma versão do alerta.

Se nenhum etag for fornecido na chamada para atualizar o alerta, o alerta atual será substituído de forma cega.

AlertMetadata

Metadados de um 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:

  • NOT_STARTED
  • IN_PROGRESS
  • FECHADO
assignee

string

O 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

O valor de gravidade do alerta. O Alert Center vai definir esse campo no momento da criação do alerta e vai usar uma string vazia como padrão quando não for possível determinar o valor. Os valores aceitos para ações de atualização neste campo são os seguintes:

  • ALTA
  • MEDIUM
  • BAIXA
etag

string

Opcional. etag é usado para controle de simultaneidade otimista como uma maneira de ajudar a impedir 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 e evitar disputas. Um etag é retornado na resposta que contém metadados de alerta, e os sistemas precisam colocar esse etag na solicitação para atualizar os metadados de alerta e garantir que a mudança seja aplicada à mesma versão dos metadados de alerta.

Se nenhum etag for fornecido na chamada para atualizar os metadados do alerta, os metadados atuais serão substituídos de forma cega.

Métodos

batchDelete

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

batchUndelete

 Realiza a operação 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 "desfaz a exclusão" de um alerta marcado para exclusão nos últimos 30 dias.