Audit Logging

This document describes audit logging for Customer Engagement Suite. 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

Customer Engagement Suite audit logs use the service name ces.googleapis.com. Filter for this service: 

    protoPayload.serviceName="ces.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, Customer Engagement Suite 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.
Permission type Methods
ADMIN_READ google.cloud.ces.v1.AgentService.ExportApp (LRO)
google.cloud.ces.v1.AgentService.GetApp
google.cloud.ces.v1.AgentService.ListApps
ADMIN_WRITE google.cloud.ces.v1.AgentService.CreateApp (LRO)
google.cloud.ces.v1.AgentService.DeleteApp (LRO)
google.cloud.ces.v1.AgentService.ImportApp (LRO)
google.cloud.ces.v1.AgentService.UpdateApp
DATA_READ google.cloud.ces.v1.AgentService.GetAgent
google.cloud.ces.v1.AgentService.GetAppVersion
google.cloud.ces.v1.AgentService.GetChangelog
google.cloud.ces.v1.AgentService.GetConversation
google.cloud.ces.v1.AgentService.GetDeployment
google.cloud.ces.v1.AgentService.GetExample
google.cloud.ces.v1.AgentService.GetGuardrail
google.cloud.ces.v1.AgentService.GetTool
google.cloud.ces.v1.AgentService.GetToolset
google.cloud.ces.v1.AgentService.ListAgents
google.cloud.ces.v1.AgentService.ListAppVersions
google.cloud.ces.v1.AgentService.ListChangelogs
google.cloud.ces.v1.AgentService.ListConversations
google.cloud.ces.v1.AgentService.ListDeployments
google.cloud.ces.v1.AgentService.ListExamples
google.cloud.ces.v1.AgentService.ListGuardrails
google.cloud.ces.v1.AgentService.ListTools
google.cloud.ces.v1.AgentService.ListToolsets
google.cloud.ces.v1.ToolService.RetrieveToolSchema
google.cloud.ces.v1.ToolService.RetrieveTools
DATA_WRITE google.cloud.ces.v1.AgentService.CreateAgent
google.cloud.ces.v1.AgentService.CreateAppVersion
google.cloud.ces.v1.AgentService.CreateDeployment
google.cloud.ces.v1.AgentService.CreateExample
google.cloud.ces.v1.AgentService.CreateGuardrail
google.cloud.ces.v1.AgentService.CreateTool
google.cloud.ces.v1.AgentService.CreateToolset
google.cloud.ces.v1.AgentService.DeleteAgent
google.cloud.ces.v1.AgentService.DeleteAppVersion
google.cloud.ces.v1.AgentService.DeleteConversation
google.cloud.ces.v1.AgentService.DeleteDeployment
google.cloud.ces.v1.AgentService.DeleteExample
google.cloud.ces.v1.AgentService.DeleteGuardrail
google.cloud.ces.v1.AgentService.DeleteTool
google.cloud.ces.v1.AgentService.DeleteToolset
google.cloud.ces.v1.AgentService.RestoreAppVersion (LRO)
google.cloud.ces.v1.AgentService.UpdateAgent
google.cloud.ces.v1.AgentService.UpdateDeployment
google.cloud.ces.v1.AgentService.UpdateExample
google.cloud.ces.v1.AgentService.UpdateGuardrail
google.cloud.ces.v1.AgentService.UpdateTool
google.cloud.ces.v1.AgentService.UpdateToolset
google.cloud.ces.v1.SessionService.BidiRunSession
google.cloud.ces.v1.SessionService.RunSession
google.cloud.ces.v1.ToolService.ExecuteTool

API interface audit logs

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

google.cloud.ces.v1.AgentService

The following audit logs are associated with methods belonging to google.cloud.ces.v1.AgentService.

CreateAgent

  • Method: google.cloud.ces.v1.AgentService.CreateAgent
  • Audit log type: Data access
  • Permissions:
    • ces.agents.create - DATA_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.CreateAgent"

CreateApp

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

CreateAppVersion

  • Method: google.cloud.ces.v1.AgentService.CreateAppVersion
  • Audit log type: Data access
  • Permissions:
    • ces.appVersions.create - DATA_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.CreateAppVersion"

CreateDeployment

  • Method: google.cloud.ces.v1.AgentService.CreateDeployment
  • Audit log type: Data access
  • Permissions:
    • ces.deployments.create - DATA_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.CreateDeployment"

CreateExample

  • Method: google.cloud.ces.v1.AgentService.CreateExample
  • Audit log type: Data access
  • Permissions:
    • ces.examples.create - DATA_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.CreateExample"

CreateGuardrail

  • Method: google.cloud.ces.v1.AgentService.CreateGuardrail
  • Audit log type: Data access
  • Permissions:
    • ces.guardrails.create - DATA_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.CreateGuardrail"

CreateTool

  • Method: google.cloud.ces.v1.AgentService.CreateTool
  • Audit log type: Data access
  • Permissions:
    • ces.tools.create - DATA_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.CreateTool"

CreateToolset

  • Method: google.cloud.ces.v1.AgentService.CreateToolset
  • Audit log type: Data access
  • Permissions:
    • ces.toolsets.create - DATA_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.CreateToolset"

DeleteAgent

  • Method: google.cloud.ces.v1.AgentService.DeleteAgent
  • Audit log type: Data access
  • Permissions:
    • ces.agents.delete - DATA_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.DeleteAgent"

DeleteApp

  • Method: google.cloud.ces.v1.AgentService.DeleteApp
  • Audit log type: Admin activity
  • Permissions:
    • ces.apps.delete - ADMIN_WRITE
  • Method is a long-running or streaming operation: Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.DeleteApp"

DeleteAppVersion

  • Method: google.cloud.ces.v1.AgentService.DeleteAppVersion
  • Audit log type: Data access
  • Permissions:
    • ces.appVersions.delete - DATA_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.DeleteAppVersion"

DeleteConversation

  • Method: google.cloud.ces.v1.AgentService.DeleteConversation
  • Audit log type: Data access
  • Permissions:
    • ces.conversations.delete - DATA_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.DeleteConversation"

DeleteDeployment

  • Method: google.cloud.ces.v1.AgentService.DeleteDeployment
  • Audit log type: Data access
  • Permissions:
    • ces.deployments.delete - DATA_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.DeleteDeployment"

DeleteExample

  • Method: google.cloud.ces.v1.AgentService.DeleteExample
  • Audit log type: Data access
  • Permissions:
    • ces.examples.delete - DATA_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.DeleteExample"

DeleteGuardrail

  • Method: google.cloud.ces.v1.AgentService.DeleteGuardrail
  • Audit log type: Data access
  • Permissions:
    • ces.guardrails.delete - DATA_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.DeleteGuardrail"

DeleteTool

  • Method: google.cloud.ces.v1.AgentService.DeleteTool
  • Audit log type: Data access
  • Permissions:
    • ces.tools.delete - DATA_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.DeleteTool"

DeleteToolset

  • Method: google.cloud.ces.v1.AgentService.DeleteToolset
  • Audit log type: Data access
  • Permissions:
    • ces.toolsets.delete - DATA_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.DeleteToolset"

ExportApp

  • Method: google.cloud.ces.v1.AgentService.ExportApp
  • Audit log type: Data access
  • Permissions:
    • ces.apps.export - ADMIN_READ
  • Method is a long-running or streaming operation: Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.ExportApp"

GetAgent

  • Method: google.cloud.ces.v1.AgentService.GetAgent
  • Audit log type: Data access
  • Permissions:
    • ces.agents.get - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.GetAgent"

GetApp

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

GetAppVersion

  • Method: google.cloud.ces.v1.AgentService.GetAppVersion
  • Audit log type: Data access
  • Permissions:
    • ces.appVersions.get - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.GetAppVersion"

GetChangelog

  • Method: google.cloud.ces.v1.AgentService.GetChangelog
  • Audit log type: Data access
  • Permissions:
    • ces.changelogs.get - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.GetChangelog"

GetConversation

  • Method: google.cloud.ces.v1.AgentService.GetConversation
  • Audit log type: Data access
  • Permissions:
    • ces.conversations.get - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.GetConversation"

GetDeployment

  • Method: google.cloud.ces.v1.AgentService.GetDeployment
  • Audit log type: Data access
  • Permissions:
    • ces.deployments.get - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.GetDeployment"

GetExample

  • Method: google.cloud.ces.v1.AgentService.GetExample
  • Audit log type: Data access
  • Permissions:
    • ces.examples.get - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.GetExample"

GetGuardrail

  • Method: google.cloud.ces.v1.AgentService.GetGuardrail
  • Audit log type: Data access
  • Permissions:
    • ces.guardrails.get - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.GetGuardrail"

GetTool

  • Method: google.cloud.ces.v1.AgentService.GetTool
  • Audit log type: Data access
  • Permissions:
    • ces.tools.get - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.GetTool"

GetToolset

  • Method: google.cloud.ces.v1.AgentService.GetToolset
  • Audit log type: Data access
  • Permissions:
    • ces.toolsets.get - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.GetToolset"

ImportApp

  • Method: google.cloud.ces.v1.AgentService.ImportApp
  • Audit log type: Admin activity
  • Permissions:
    • ces.apps.import - ADMIN_WRITE
  • Method is a long-running or streaming operation: Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.ImportApp"

ListAgents

  • Method: google.cloud.ces.v1.AgentService.ListAgents
  • Audit log type: Data access
  • Permissions:
    • ces.agents.list - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.ListAgents"

ListAppVersions

  • Method: google.cloud.ces.v1.AgentService.ListAppVersions
  • Audit log type: Data access
  • Permissions:
    • ces.appVersions.list - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.ListAppVersions"

ListApps

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

ListChangelogs

  • Method: google.cloud.ces.v1.AgentService.ListChangelogs
  • Audit log type: Data access
  • Permissions:
    • ces.changelogs.list - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.ListChangelogs"

ListConversations

  • Method: google.cloud.ces.v1.AgentService.ListConversations
  • Audit log type: Data access
  • Permissions:
    • ces.conversations.list - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.ListConversations"

ListDeployments

  • Method: google.cloud.ces.v1.AgentService.ListDeployments
  • Audit log type: Data access
  • Permissions:
    • ces.deployments.list - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.ListDeployments"

ListExamples

  • Method: google.cloud.ces.v1.AgentService.ListExamples
  • Audit log type: Data access
  • Permissions:
    • ces.examples.list - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.ListExamples"

ListGuardrails

  • Method: google.cloud.ces.v1.AgentService.ListGuardrails
  • Audit log type: Data access
  • Permissions:
    • ces.guardrails.list - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.ListGuardrails"

ListTools

  • Method: google.cloud.ces.v1.AgentService.ListTools
  • Audit log type: Data access
  • Permissions:
    • ces.tools.list - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.ListTools"

ListToolsets

  • Method: google.cloud.ces.v1.AgentService.ListToolsets
  • Audit log type: Data access
  • Permissions:
    • ces.toolsets.list - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.ListToolsets"

RestoreAppVersion

  • Method: google.cloud.ces.v1.AgentService.RestoreAppVersion
  • Audit log type: Data access
  • Permissions:
    • ces.appVersions.restore - DATA_WRITE
  • Method is a long-running or streaming operation: Long-running operation
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.RestoreAppVersion"

UpdateAgent

  • Method: google.cloud.ces.v1.AgentService.UpdateAgent
  • Audit log type: Data access
  • Permissions:
    • ces.agents.update - DATA_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.UpdateAgent"

UpdateApp

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

UpdateDeployment

  • Method: google.cloud.ces.v1.AgentService.UpdateDeployment
  • Audit log type: Data access
  • Permissions:
    • ces.deployments.update - DATA_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.UpdateDeployment"

UpdateExample

  • Method: google.cloud.ces.v1.AgentService.UpdateExample
  • Audit log type: Data access
  • Permissions:
    • ces.examples.update - DATA_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.UpdateExample"

UpdateGuardrail

  • Method: google.cloud.ces.v1.AgentService.UpdateGuardrail
  • Audit log type: Data access
  • Permissions:
    • ces.guardrails.update - DATA_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.UpdateGuardrail"

UpdateTool

  • Method: google.cloud.ces.v1.AgentService.UpdateTool
  • Audit log type: Data access
  • Permissions:
    • ces.tools.update - DATA_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.UpdateTool"

UpdateToolset

  • Method: google.cloud.ces.v1.AgentService.UpdateToolset
  • Audit log type: Data access
  • Permissions:
    • ces.toolsets.update - DATA_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.AgentService.UpdateToolset"

google.cloud.ces.v1.SessionService

The following audit logs are associated with methods belonging to google.cloud.ces.v1.SessionService.

BidiRunSession

  • Method: google.cloud.ces.v1.SessionService.BidiRunSession
  • Audit log type: Data access
  • Permissions:
    • ces.sessions.bidiRunSession - DATA_WRITE
  • Method is a long-running or streaming operation: Streaming RPC
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.SessionService.BidiRunSession"

RunSession

  • Method: google.cloud.ces.v1.SessionService.RunSession
  • Audit log type: Data access
  • Permissions:
    • ces.sessions.runSession - DATA_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.SessionService.RunSession"

google.cloud.ces.v1.ToolService

The following audit logs are associated with methods belonging to google.cloud.ces.v1.ToolService.

ExecuteTool

  • Method: google.cloud.ces.v1.ToolService.ExecuteTool
  • Audit log type: Data access
  • Permissions:
    • ces.tools.execute - DATA_WRITE
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.ToolService.ExecuteTool"

RetrieveToolSchema

  • Method: google.cloud.ces.v1.ToolService.RetrieveToolSchema
  • Audit log type: Data access
  • Permissions:
    • ces.tools.get - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.ToolService.RetrieveToolSchema"

RetrieveTools

  • Method: google.cloud.ces.v1.ToolService.RetrieveTools
  • Audit log type: Data access
  • Permissions:
    • ces.toolsets.get - DATA_READ
  • Method is a long-running or streaming operation: No.
  • Filter for this method: protoPayload.methodName="google.cloud.ces.v1.ToolService.RetrieveTools"