Usando a API do Registro de Auditoria, o administrador da conta pode extrair eventos do Registro de Auditoria que ocorrem em uma conta da monday.com. Monitorar os dados exibidos aqui pode ajudar a proteger contra acessos indesejados à conta, investigar comportamentos suspeitos e, em última análise, garantir o uso seguro da conta em todos os momentos.

A API do Registro de Auditoria pode ser usada para:

• Identificar potenciais problemas de segurança ou tentativas de acesso indesejadas
• Transferir dados de eventos do Registro de Auditoria para uma plataforma de auditoria diferente, como um SIEM, para análise adicional
• Criar aplicações personalizadas para entender melhor como a conta da monday.com está sendo utilizada

Nota: Esse recurso avançado de segurança está disponível no plano Enterprise e pode ser acessado apenas pelo administrador da conta.

 

Gerando o token da API

Para gerar o token da API do registro de auditoria, acesse a seção de administração da sua conta, clique na seção “Segurança” e depois na aba “Auditoria”. A partir daí, selecione o botão “Monitorar por API” e copie-o para o seu computador assim:

 

Como usá-lo

A API do Registro de Auditoria é uma API REST que utiliza o verbo HTTP GET tanto para consultar quanto para recuperar os dados dos eventos. Os métodos de retorno também retornarão códigos de status HTTP padrão para indicar sucesso (ou falha).

O limite de taxa é de até 50 requisições por minuto.

URL base

A URL base para acessar os métodos da API de Registros de Auditoria é https://<SEU_DOMÍNIO>.monday.com/audit-api/get-logs

Nota: Substitua <SEU_DOMÍNIO> acima pelo nome da URL da sua conta (se a URL da sua conta for myaccount.monday.com, você deve escrever “myaccount” aqui).

Token Bearer

O acesso à API do Registro de Auditoria só pode ser feito com um token gerado pelo administrador da conta.

Como administrador da conta, clique na sua foto de perfil no canto inferior esquerdo e selecione “Admin”. Na aba de Segurança da seção de administração, clique em “auditoria” e depois em “Monitorar por API”.

A partir daqui, clique para gerar e copiar o token. Use o token no cabeçalho de autorização, como tipo bearer.

Cabeçalho de autorização

Aqui está um exemplo de um cabeçalho de autorização:

curl -g -X GET -H ‘Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJ0aWQiOjQsInVpZCI6MywiaWFkIjoiMjAyMS0wOC0xMFQxNzowOTozNC40NjNaIiwicGVyIjocdadsc6YXBpIiwiYWN0aWQjk32rkjhduIjoibG9jYWwtcmVnaW9uIn0.RqPFKVGzxxUsqZ5V3hU-aAv4Kmkxyp39-L60DSG6mfw’ ‘https://myaccount.monday.com/audit-api/get-logs?page=1&per_page=20’

Filtrando a API do Registro de Auditoria

Os seguintes atributos podem ser usados para filtrar a API do Registro de Auditoria: 

• user_id
• event
• ip_address
• start_time
• end_time (especificar formato de tempo)

Para filtrar, você deve adicionar os filtros à consulta como parâmetros.

Aqui está um exemplo de uma consulta filtrada (recupera logs criados após “2021-08-24T17:03:00Z”):

curl -g -X GET -H ‘Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJ0aWQiOjQsInVpZCI6MywiaWFkIjoiMjAyMS0wOC0xMFQxNzowOTozNC40NjNaIiwicGVyIjocdadsc6YXBpIiwiYWN0aWQjk32rkjhduIjoibG9jYWwtcmVnaW9uIn0.RqPFKVGzxxUsqZ5V3hU-aAv4Kmkxyp39-L60DSG6mfw’ ‘https://myaccount.monday.com/audit-api/get-logs?page=1&per_page=20&filters={“start_time”:”2021-08-24T17:03:00Z”}‘ 

Exemplo

• Consulta:

curl -g -X GET -H ‘Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJ0aWQiOjQsInVpZCI6MywiaWFkIjoiMjAyMS0wOC0xMFQxNzowOTozNC40NjNaIiwicGVyIjocdadsc6YXBpIiwiYWN0aWQjk32rkjhduIjoibG9jYWwtcmVnaW9uIn0.RqPFKVGzxxUsqZ5V3hU-aAv4Kmkxyp39-L60DSG6mfw’ ‘https://myaccount.monday.com/audit-api/get-logs?page=1&per_page=20&filters={“start_time”:”2021-08-24T17:03:00Z”,”event”:[“download-attachment”, “delete-board”]}’

• Dados retornados:

{
  data: [
    {
      "timestamp": "2021-08-24T17:18:39Z",
      "account_id": 739628,
      "user_id": 27,
      "event": "delete-board",
      "slug": "myaccount",
      "ip_address": "123.123",
      "user_agent": "user agent",
      "client_name": "Chrome",
      "client_version": "92.0.4515.160",
      "os_name": "Mac OS",
      "os_version": "10.0.0",
      "device_name": null,
      "device_type": "desktop",
      "activity_metadata":  {
        "board_name": "Meus projetos"
      }
    }
  ],
  page: 1,
  per_page: 20,
  next_page: null
}

Códigos de status

Os seguintes códigos de status serão retornados para cada requisição:

• 200 – a recuperação dos registros de auditoria foi bem-sucedida

• 400 – erros do cliente (por exemplo, filtro inválido)

• 401 – não autorizado (por exemplo, requisições sem um token/token inválido)

• 429 – erro de limite de taxa

• 500 – erro interno do servidor

Descrição dos eventos do Registro de Auditoria

Quer entender mais sobre o que cada evento do Registro de Auditoria realmente significa para sua conta? A monday.com tem o que você precisa! Confira o quadro a seguir para saber mais sobre cada um dos eventos do Registro de Auditoria que oferecemos.

Dúvidas técnicas? O suporte oficial da monday.com resolve.

Já para levar a produtividade da sua empresa ao próximo nível, conheça os serviços de consultoria e treinamento da Audatia, parceira certificada da monday.com no Brasil. Agende um bate-papo →