Geração de registros de auditoria de chaves de API

Este documento lista os métodos auditados para chaves de API. Google Cloud serviços geram registros de auditoria de atividades administrativas e de acesso nos seus Google Cloud recursos. Para mais informações sobre os Registros de Auditoria do Cloud, confira:

Nome do serviço

Para conferir os registros de auditoria das chaves de API, faça o seguinte:

  1. No Google Cloud console do, acesse a página Análise de registros:

    Acessar a Análise de registros

  2. Copie e cole a consulta a seguir no campo Consulta do Análise de registros e clique em Executar consulta.

        protoPayload.serviceName="apikeys.googleapis.com"

Métodos por tipo de permissão

Cada permissão do IAM tem uma propriedade type, com um tipo enumerado que pode ser um dos quatro seguintes valores: ADMIN_READ, ADMIN_WRITE, DATA_READ ou DATA_WRITE. Quando você chama um método, as chaves de API geram um registro de auditoria com categoria dependente da propriedade type da permissão necessária para executar o método. Métodos que exigem uma permissão do IAM com o valor da propriedade type de DATA_READ, DATA_WRITE ou ADMIN_READ geram registros de auditoria de acesso aos dados. Métodos que exigem uma permissão do IAM com o valor da propriedade type de ADMIN_WRITE geram registros de auditoria de atividade do administrador.

Os métodos de API na lista a seguir marcados com (LRO) são operações de longa duração. Em geral, esses métodos geram duas entradas de registro de auditoria: uma quando a operação começa e outra quando ela termina. Para mais informações, consulte Registros de auditoria para operações de longa duração.
Tipo de permissão Métodos
ADMIN_READ google.api.apikeys.v2.ApiKeys.GetKeyString
ADMIN_WRITE google.api.apikeys.v2.ApiKeys.CreateKey (LRO)
google.api.apikeys.v2.ApiKeys.DeleteKey (LRO)
google.api.apikeys.v2.ApiKeys.UndeleteKey (LRO)
google.api.apikeys.v2.ApiKeys.UpdateKey (LRO)
google.longrunning.Operations.GetOperation

Registros de auditoria da interface da API

Para informações sobre como e quais permissões são avaliadas, para cada método, consulte a documentação do Identity and Access Management para chaves de API.

google.api.apikeys.v2.ApiKeys

Os registros de auditoria a seguir estão associados a métodos que pertencem a google.api.apikeys.v2.ApiKeys.

CreateKey

  • Método: google.api.apikeys.v2.ApiKeys.CreateKey
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • serviceusage.apiKeys.create - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: operação de longa duração
  • Filtrar para este método: protoPayload.methodName="google.api.apikeys.v2.ApiKeys.CreateKey"

DeleteKey

  • Método: google.api.apikeys.v2.ApiKeys.DeleteKey
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • serviceusage.apiKeys.delete - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: operação de longa duração
  • Filtrar para este método: protoPayload.methodName="google.api.apikeys.v2.ApiKeys.DeleteKey"

GetKeyString

  • Método: google.api.apikeys.v2.ApiKeys.GetKeyString
  • Tipo de registro de auditoria: acesso a dados
  • Permissões:
    • apikeys.keys.getKeyString - ADMIN_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.api.apikeys.v2.ApiKeys.GetKeyString"

UndeleteKey

  • Método: google.api.apikeys.v2.ApiKeys.UndeleteKey
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apikeys.keys.undelete - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: operação de longa duração
  • Filtrar para este método: protoPayload.methodName="google.api.apikeys.v2.ApiKeys.UndeleteKey"

UpdateKey

  • Método: google.api.apikeys.v2.ApiKeys.UpdateKey
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • serviceusage.apiKeys.update - ADMIN_WRITE
  • O método é uma operação de streaming ou de longa duração: operação de longa duração
  • Filtrar para este método: protoPayload.methodName="google.api.apikeys.v2.ApiKeys.UpdateKey"

google.longrunning.Operations

Os registros de auditoria a seguir estão associados a métodos que pertencem a google.longrunning.Operations.

GetOperation

  • Método: google.longrunning.Operations.GetOperation
  • Tipo de registro de auditoria: atividade do administrador
  • Permissões:
    • apikeys.keys.create - ADMIN_WRITE
    • apikeys.keys.delete - ADMIN_WRITE
    • serviceusage.operations.get - DATA_READ
    • serviceusage.services.enable - ADMIN_WRITE
    • serviceusage.services.get - DATA_READ
  • O método é uma operação de streaming ou de longa duração: No
  • Filtrar para este método: protoPayload.methodName="google.longrunning.Operations.GetOperation"

Métodos que não geram registros de auditoria

Um método pode não gerar registros de auditoria por um ou mais dos seguintes motivos:

  • É um método de alto volume que envolve geração de registros significativos e custos de armazenamento.
  • Tem pouco valor para a auditoria.
  • Outro registro de auditoria ou plataforma já oferece cobertura do método.

Os métodos abaixo não geram registros de auditoria:

  • google.api.apikeys.v2.ApiKeys.GetKey
  • google.api.apikeys.v2.ApiKeys.ListKeys
  • google.api.apikeys.v2.ApiKeys.LookupKey