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 esse alerta foi iniciado ou detectado.
endTime

string (Timestamp format)

Opcional. A hora em que o evento que causou esse alerta deixou de ser 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, significa que há um alerta contínuo.
type

string

Obrigatório. O tipo de alerta. Essa saída só é exibida após a criação do alerta. Confira uma lista dos tipos de alerta disponíveis em Tipos de alertas do Google Workspace.
source

string

Obrigatório. Um identificador exclusivo para o sistema que relatou o alerta. Essa saída só é exibida após a criação do alerta.

Estas são as origens aceitas:

  • Operações do Google
  • Gerenciamento de dispositivos móveis
  • Phishing do Gmail
  • Prevenção contra perda de dados
  • Retirada de todo o domínio
  • Ataque patrocinado pelo governo
  • Identidade do Google
  • interrupção 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 controle de simultaneidade otimista como forma de evitar que atualizações simultâneas de um alerta substituam umas às outras. É altamente recomendável que os sistemas usem a etag no ciclo de leitura-modificação-gravação para realizar atualizações de alerta a fim de evitar disputas: uma etag é retornada na resposta que contém alertas, e os sistemas devem colocar essa etag na solicitação para atualizar o alerta a fim de garantir que a alteração seja aplicada à mesma versão do alerta.

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

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 aceitos 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 esses metadados foram atualizados pela última vez.
severity

string

O valor de gravidade do alerta. A Central de alertas definirá esse campo no momento da criação do alerta. Quando não for possível determiná-lo, o padrão será uma string vazia. Os valores compatíveis para ações de atualização nesse campo são os seguintes:

  • HIGH
  • MEDIUM
  • BAIXA
etag

string

Opcional. O etag é usado para controle de simultaneidade otimista como forma de evitar que atualizações simultâneas de metadados de alerta substituam uns aos outros. É altamente recomendável que os sistemas usem a 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 espera-se que os sistemas coloquem essa etag na solicitação para atualizar os metadados de alerta a fim de garantir 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 atuais serão substituídos às cegas.

Métodos

batchDelete

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

batchUndelete

 Executa a operação de cancelamento de exclusão em lote nos 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 que foi marcado para exclusão nos últimos 30 dias.