Cloud Key Management Service audit logging

Cloud Key Management Service is updating the format of the protoPayload field in its Data Access audit log entries. During the migration period, the protoPayload within Data Access audit log entries will remain backward-compatible. However, new or future code applications should use the recommended replacement fields as follows:

Recommended replacement field Deprecated field Description
protoPayload.status.details protoPayload.metadata Error detail for EXTERNAL (i.e., Cloud EKM) key operations.
protoPayload.metadata.entries.caller_provided_context protoPayload.request.caller_provided_context Context from the caller associated with this Cloud KMS operation.


This document lists the audited methods for Cloud Key Management Service. Google Cloud services generate audit logs that record administrative and access activities within your Google Cloud resources. For more information about Cloud Audit Logs, see the following:

Service name

To view the Cloud Key Management Service audit logs, do the following:

  1. In the Google Cloud console, go to the Logs Explorer page:

    Go to Logs Explorer

  2. Copy and paste the following query into the Query field of the Logs Explorer, and then click Run query.

        protoPayload.serviceName="cloudkms.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, Cloud Key Management Service 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 methods in the following list that are marked with (LRO) are long-running operations (LROs). These methods usually generate two audit log entries: one when the operation starts and another when it ends. For more information see Audit logs for long-running operations.