Data Catalog audit logging

This document describes audit logging for Data Catalog. Google Cloud services generate audit logs that record administrative and access activities within your Google Cloud resources. To learn more about Cloud Audit Logs, refer to the following documentation pages:

• Types of audit logs
• Audit log entry structure
• Details on audit log storage and routing
• Cloud Logging pricing summary
• How to enable Data Access audit logs

Notes

Audit logs associated with v2 operations are not available via the API. Audit logs for v2 operations may be viewable using the Business Glossary (full resource names include version information—for example, google.cloud.datacatalog.v2.DataCatalog.CreateEntryGroup is a v2 resource). Log content associated with v2 operations is subject to change.

Service name

Data Catalog audit logs use the service name datacatalog.googleapis.com. Filter for this service:

    protoPayload.serviceName="datacatalog.googleapis.com"
  

Methods by permission type

Each IAM permission has a type property, whose value is an enum that can be one of four values: ADMIN_READ, ADMIN_WRITE, DATA_READ, or DATA_WRITE. When you call a method, Data Catalog generates an audit log whose category is dependent on the type property of the permission required to perform the method. Methods that require an IAM permission with the type property value of DATA_READ, DATA_WRITE, or ADMIN_READ generate Data Access audit logs. Methods that require an IAM permission with the type property value of ADMIN_WRITE generate Admin Activity audit logs.

API interface audit logs

For information about how and which permissions are evaluated for each method, see the Identity and Access Management documentation for Data Catalog.

google.cloud.datacatalog.v1.DataCatalog

The following section contains details about audit logs associated with methods belonging to google.cloud.datacatalog.v1.DataCatalog.

CreateEntry

• Method: google.cloud.datacatalog.v1.DataCatalog.CreateEntry
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.entries.create - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.CreateEntry"
  

CreateEntryGroup

• Method: google.cloud.datacatalog.v1.DataCatalog.CreateEntryGroup
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.entryGroups.create - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.CreateEntryGroup"
  

CreateTag

• Method: google.cloud.datacatalog.v1.DataCatalog.CreateTag
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.entries.updateTag - ADMIN_WRITE
  • datacatalog.tagTemplates.use - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.CreateTag"
  

CreateTagTemplate

• Method: google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplate
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.tagTemplates.create - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplate"
  

CreateTagTemplateField

• Method: google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplateField
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.tagTemplates.update - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.CreateTagTemplateField"
  

DeleteEntry

• Method: google.cloud.datacatalog.v1.DataCatalog.DeleteEntry
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.entries.delete - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.DeleteEntry"
  

DeleteEntryGroup

• Method: google.cloud.datacatalog.v1.DataCatalog.DeleteEntryGroup
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.entryGroups.delete - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.DeleteEntryGroup"
  

DeleteTag

• Method: google.cloud.datacatalog.v1.DataCatalog.DeleteTag
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.entries.updateTag - ADMIN_WRITE
  • datacatalog.tagTemplates.use - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.DeleteTag"
  

DeleteTagTemplate

• Method: google.cloud.datacatalog.v1.DataCatalog.DeleteTagTemplate
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.tagTemplates.delete - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.DeleteTagTemplate"
  

DeleteTagTemplateField

• Method: google.cloud.datacatalog.v1.DataCatalog.DeleteTagTemplateField
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.tagTemplates.update - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.DeleteTagTemplateField"
  

GetEntry

• Method: google.cloud.datacatalog.v1.DataCatalog.GetEntry
  
• Audit log type: Data access
  
• Permissions:
  • datacatalog.entries.get - ADMIN_READ
  • datacatalog.tagTemplates.getTag - ADMIN_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.GetEntry"
  

GetEntryGroup

• Method: google.cloud.datacatalog.v1.DataCatalog.GetEntryGroup
  
• Audit log type: Data access
  
• Permissions:
  • datacatalog.entryGroups.get - ADMIN_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.GetEntryGroup"
  

GetIamPolicy

• Method: google.cloud.datacatalog.v1.DataCatalog.GetIamPolicy
  
• Audit log type: Data access
  
• Permissions:
  • datacatalog.entryGroups.getIamPolicy - ADMIN_READ
  • datacatalog.tagTemplates.getIamPolicy - ADMIN_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.GetIamPolicy"
  

GetTagTemplate

• Method: google.cloud.datacatalog.v1.DataCatalog.GetTagTemplate
  
• Audit log type: Data access
  
• Permissions:
  • datacatalog.tagTemplates.get - ADMIN_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.GetTagTemplate"
  

ImportEntries

• Method: google.cloud.datacatalog.v1.DataCatalog.ImportEntries
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.entries.create - ADMIN_WRITE
• Method is a long-running or streaming operation: Long-running operation
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.ImportEntries"
  

ListEntries

• Method: google.cloud.datacatalog.v1.DataCatalog.ListEntries
  
• Audit log type: Data access
  
• Permissions:
  • datacatalog.entries.list - ADMIN_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.ListEntries"
  

ListEntryGroups

• Method: google.cloud.datacatalog.v1.DataCatalog.ListEntryGroups
  
• Audit log type: Data access
  
• Permissions:
  • datacatalog.entryGroups.list - ADMIN_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.ListEntryGroups"
  

ListTags

• Method: google.cloud.datacatalog.v1.DataCatalog.ListTags
  
• Audit log type: Data access
  
• Permissions:
  • datacatalog.entries.get - ADMIN_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.ListTags"
  

LookupEntry

• Method: google.cloud.datacatalog.v1.DataCatalog.LookupEntry
  
• Audit log type: Data access
  
• Permissions:
  • datacatalog.entries.get - ADMIN_READ
  • datacatalog.tagTemplates.getTag - ADMIN_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.LookupEntry"
  

ModifyEntryContacts

• Method: google.cloud.datacatalog.v1.DataCatalog.ModifyEntryContacts
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.entries.updateContacts - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.ModifyEntryContacts"
  

ModifyEntryOverview

• Method: google.cloud.datacatalog.v1.DataCatalog.ModifyEntryOverview
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.entries.updateOverview - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.ModifyEntryOverview"
  

ReconcileTags

• Method: google.cloud.datacatalog.v1.DataCatalog.ReconcileTags
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.entries.updateTag - ADMIN_WRITE
• Method is a long-running or streaming operation: Long-running operation
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.ReconcileTags"
  

RenameTagTemplateField

• Method: google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateField
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.tagTemplates.update - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateField"
  

RenameTagTemplateFieldEnumValue

• Method: google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateFieldEnumValue
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.tagTemplates.update - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.RenameTagTemplateFieldEnumValue"
  

SetIamPolicy

• Method: google.cloud.datacatalog.v1.DataCatalog.SetIamPolicy
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.entryGroups.setIamPolicy - ADMIN_WRITE
  • datacatalog.tagTemplates.setIamPolicy - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.SetIamPolicy"
  

StarEntry

• Method: google.cloud.datacatalog.v1.DataCatalog.StarEntry
  
• Audit log type: Data access
  
• Permissions:
  • datacatalog.entries.get - ADMIN_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.StarEntry"
  

UnstarEntry

• Method: google.cloud.datacatalog.v1.DataCatalog.UnstarEntry
  
• Audit log type: Data access
  
• Permissions:
  • datacatalog.entries.get - ADMIN_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.UnstarEntry"
  

UpdateEntry

• Method: google.cloud.datacatalog.v1.DataCatalog.UpdateEntry
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.entries.setIamPolicy - ADMIN_WRITE
  • datacatalog.entries.update - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.UpdateEntry"
  

UpdateEntryGroup

• Method: google.cloud.datacatalog.v1.DataCatalog.UpdateEntryGroup
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.entryGroups.update - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.UpdateEntryGroup"
  

UpdateTag

• Method: google.cloud.datacatalog.v1.DataCatalog.UpdateTag
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.entries.updateTag - ADMIN_WRITE
  • datacatalog.tagTemplates.use - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.UpdateTag"
  

UpdateTagTemplate

• Method: google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplate
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.tagTemplates.update - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplate"
  

UpdateTagTemplateField

• Method: google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplateField
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.tagTemplates.update - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.DataCatalog.UpdateTagTemplateField"
  

google.cloud.datacatalog.v1.PolicyTagManager

The following section contains details about audit logs associated with methods belonging to google.cloud.datacatalog.v1.PolicyTagManager.

GetIamPolicy

• Method: google.cloud.datacatalog.v1.PolicyTagManager.GetIamPolicy
  
• Audit log type: Data access
  
• Permissions:
  • datacatalog.categories.getIamPolicy - ADMIN_READ
  • datacatalog.taxonomies.getIamPolicy - ADMIN_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.PolicyTagManager.GetIamPolicy"
  

SetIamPolicy

• Method: google.cloud.datacatalog.v1.PolicyTagManager.SetIamPolicy
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.categories.setIamPolicy - ADMIN_WRITE
  • datacatalog.taxonomies.setIamPolicy - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1.PolicyTagManager.SetIamPolicy"
  

google.cloud.datacatalog.v1beta1.DataCatalog

The following section contains details about audit logs associated with methods belonging to google.cloud.datacatalog.v1beta1.DataCatalog.

GetIamPolicy

• Method: google.cloud.datacatalog.v1beta1.DataCatalog.GetIamPolicy
  
• Audit log type: Data access
  
• Permissions:
  • datacatalog.entryGroups.getIamPolicy - ADMIN_READ
  • datacatalog.tagTemplates.getIamPolicy - ADMIN_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1beta1.DataCatalog.GetIamPolicy"
  

SetIamPolicy

• Method: google.cloud.datacatalog.v1beta1.DataCatalog.SetIamPolicy
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.entryGroups.setIamPolicy - ADMIN_WRITE
  • datacatalog.tagTemplates.setIamPolicy - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1beta1.DataCatalog.SetIamPolicy"
  

google.cloud.datacatalog.v1beta1.PolicyTagManager

The following section contains details about audit logs associated with methods belonging to google.cloud.datacatalog.v1beta1.PolicyTagManager.

CreatePolicyTag

• Method: google.cloud.datacatalog.v1beta1.PolicyTagManager.CreatePolicyTag
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.taxonomies.update - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1beta1.PolicyTagManager.CreatePolicyTag"
  

CreateTaxonomy

• Method: google.cloud.datacatalog.v1beta1.PolicyTagManager.CreateTaxonomy
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.taxonomies.create - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1beta1.PolicyTagManager.CreateTaxonomy"
  

DeletePolicyTag

• Method: google.cloud.datacatalog.v1beta1.PolicyTagManager.DeletePolicyTag
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.taxonomies.update - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1beta1.PolicyTagManager.DeletePolicyTag"
  

DeleteTaxonomy

• Method: google.cloud.datacatalog.v1beta1.PolicyTagManager.DeleteTaxonomy
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.taxonomies.delete - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1beta1.PolicyTagManager.DeleteTaxonomy"
  

GetIamPolicy

• Method: google.cloud.datacatalog.v1beta1.PolicyTagManager.GetIamPolicy
  
• Audit log type: Data access
  
• Permissions:
  • datacatalog.categories.getIamPolicy - ADMIN_READ
  • datacatalog.taxonomies.getIamPolicy - ADMIN_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1beta1.PolicyTagManager.GetIamPolicy"
  

GetPolicyTag

• Method: google.cloud.datacatalog.v1beta1.PolicyTagManager.GetPolicyTag
  
• Audit log type: Data access
  
• Permissions:
  • datacatalog.taxonomies.get - ADMIN_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1beta1.PolicyTagManager.GetPolicyTag"
  

GetTaxonomy

• Method: google.cloud.datacatalog.v1beta1.PolicyTagManager.GetTaxonomy
  
• Audit log type: Data access
  
• Permissions:
  • datacatalog.taxonomies.get - ADMIN_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1beta1.PolicyTagManager.GetTaxonomy"
  

ListPolicyTags

• Method: google.cloud.datacatalog.v1beta1.PolicyTagManager.ListPolicyTags
  
• Audit log type: Data access
  
• Permissions:
  • datacatalog.taxonomies.get - ADMIN_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1beta1.PolicyTagManager.ListPolicyTags"
  

ListTaxonomies

• Method: google.cloud.datacatalog.v1beta1.PolicyTagManager.ListTaxonomies
  
• Audit log type: Data access
  
• Permissions:
  • datacatalog.taxonomies.get - ADMIN_READ
  • datacatalog.taxonomies.list - ADMIN_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1beta1.PolicyTagManager.ListTaxonomies"
  

SetIamPolicy

• Method: google.cloud.datacatalog.v1beta1.PolicyTagManager.SetIamPolicy
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.categories.setIamPolicy - ADMIN_WRITE
  • datacatalog.taxonomies.setIamPolicy - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1beta1.PolicyTagManager.SetIamPolicy"
  

UpdatePolicyTag

• Method: google.cloud.datacatalog.v1beta1.PolicyTagManager.UpdatePolicyTag
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.taxonomies.update - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1beta1.PolicyTagManager.UpdatePolicyTag"
  

UpdateTaxonomy

• Method: google.cloud.datacatalog.v1beta1.PolicyTagManager.UpdateTaxonomy
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.taxonomies.update - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1beta1.PolicyTagManager.UpdateTaxonomy"
  

google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization

The following section contains details about audit logs associated with methods belonging to google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization.

ExportTaxonomies

• Method: google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization.ExportTaxonomies
  
• Audit log type: Data access
  
• Permissions:
  • datacatalog.taxonomies.get - ADMIN_READ
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization.ExportTaxonomies"
  

ImportTaxonomies

• Method: google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization.ImportTaxonomies
  
• Audit log type: Admin activity
  
• Permissions:
  • datacatalog.taxonomies.create - ADMIN_WRITE
• Method is a long-running or streaming operation: No.
  
• Filter for this method: protoPayload.methodName="google.cloud.datacatalog.v1beta1.PolicyTagManagerSerialization.ImportTaxonomies"
  

Methods that don't produce audit logs

A method might not produce audit logs for one or more of the following reasons:

• It is a high volume method involving signifcant log generation and storage costs.
• It has low auditing value.
• Another audit or platform log already provides method coverage.

The following methods don't produce audit logs:

• google.cloud.datacatalog.v1.DataCatalog.SearchCatalog
• google.cloud.datacatalog.v1.DataCatalog.TestIamPermissions
• google.cloud.datacatalog.v1.PolicyTagManager.TestIamPermissions
• google.cloud.datacatalog.v1beta1.DataCatalog.SearchCatalog
• google.cloud.datacatalog.v1beta1.DataCatalog.TestIamPermissions
• google.cloud.datacatalog.v1beta1.PolicyTagManager.TestIamPermissions