AuditLog

Common audit log format for Google Cloud Platform API operations.

JSON representation
{
  "serviceName": string,
  "methodName": string,
  "resourceName": string,
  "resourceLocation": {
    object(ResourceLocation)
  },
  "numResponseItems": string,
  "status": {
    object(Status)
  },
  "authenticationInfo": {
    object(AuthenticationInfo)
  },
  "authorizationInfo": [
    {
      object(AuthorizationInfo)
    }
  ],
  "requestMetadata": {
    object(RequestMetadata)
  },
  "request": {
    object
  },
  "response": {
    object
  },
  "metadata": {
    object
  },
  "serviceData": {
    "@type": string,
    field1: ...,
    ...
  }
}
Fields
serviceName

string

The name of the API service performing the operation. For example, "datastore.googleapis.com".

methodName

string

The name of the service method or operation. For API calls, this should be the name of the API method. For example,

"google.datastore.v1.Datastore.RunQuery"
"google.logging.v1.LoggingService.DeleteLog"

resourceName

string

The resource or collection that is the target of the operation. The name is a scheme-less URI, not including the API service name. For example:

"shelves/SHELF_ID/books"
"shelves/SHELF_ID/books/BOOK_ID"

resourceLocation

object(ResourceLocation)

The resource location information.

numResponseItems

string (int64 format)

The number of items returned from a List or Query API method, if applicable.

status

object(Status)

The status of the overall operation.

authenticationInfo

object(AuthenticationInfo)

Authentication information.

authorizationInfo[]

object(AuthorizationInfo)

Authorization information. If there are multiple resources or permissions involved, then there is one AuthorizationInfo element for each {resource, permission} tuple.

requestMetadata

object(RequestMetadata)

Metadata about the operation.

request

object (Struct format)

The operation request. This may not include all request parameters, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record. It should never include user-generated data, such as file contents. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the @type property.

response

object (Struct format)

The operation response. This may not include all response elements, such as those that are too large, privacy-sensitive, or duplicated elsewhere in the log record. It should never include user-generated data, such as file contents. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the @type property.

metadata

object (Struct format)

Other service-specific data about the request, response, and other information associated with the current audited event.

serviceData

object

Deprecated, use metadata field instead. Other service-specific data about the request, response, and other activities.

An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" }.

ResourceLocation

Location information about a resource.

JSON representation
{
  "currentLocations": [
    string
  ]
}
Fields
currentLocations[]

string

The locations of a resource after the execution of the operation. For example:

"europe-west1-a"
"us-east1"
"nam3"

AuthenticationInfo

Authentication information for the operation.

JSON representation
{
  "principalEmail": string,
  "authoritySelector": string,
  "thirdPartyPrincipal": {
    object
  }
}
Fields
principalEmail

string

The email address of the authenticated user (or service account on behalf of third party principal) making the request. For privacy reasons, the principal email address is redacted for all read-only operations that fail with a "permission denied" error.

authoritySelector

string

The authority selector specified by the requestor, if any. It is not guaranteed that the principal was allowed to use this authority.

thirdPartyPrincipal

object (Struct format)

The third party identification (if any) of the authenticated user making the request. When the JSON object represented here has a proto equivalent, the proto name will be indicated in the @type property.

AuthorizationInfo

Authorization information for the operation.

JSON representation
{
  "resource": string,
  "permission": string,
  "granted": boolean,
  "resourceAttributes": {
    object(Resource)
  }
}
Fields
resource

string

The resource being accessed, as a REST-style string. For example:

bigquery.googleapis.com/projects/PROJECTID/datasets/DATASETID

permission

string

The required IAM permission.

granted

boolean

Whether or not authorization for resource and permission was granted.

resourceAttributes

object(Resource)

Resource attributes used in IAM condition evaluation. This field contains resource attributes like resource type and resource name.

To get the whole view of the attributes used in IAM condition evaluation, the user must also look into AuditLog.request_metadata.request_attributes.

Resource

This message defines core attributes for a resource. A resource is an addressable (named) entity provided by the destination service. For example, a file stored on a network storage service.

JSON representation
{
  "service": string,
  "name": string,
  "type": string,
  "labels": {
    string: string,
    ...
  }
}
Fields
service

string

The name of the service that this resource belongs to, such as pubsub.googleapis.com. The service may be different from the DNS hostname that actually serves the request.

name

string

The stable identifier (name) of a resource on the service. A resource can be logically identified as "//{resource.service}/{resource.name}". The differences between a resource name and a URI are:

  • Resource name is a logical identifier, independent of network protocol and API version. For example, //pubsub.googleapis.com/projects/123/topics/news-feed.
  • URI often includes protocol and version information, so it can be used directly by applications. For example, https://pubsub.googleapis.com/v1/projects/123/topics/news-feed.

See https://cloud.google.com/apis/design/resource_names for details.

type

string

The type of the resource. The scheme is platform-specific because different platforms define their resources differently.

labels

map (key: string, value: string)

The labels or tags on the resource, such as AWS resource tags and Kubernetes resource labels.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

RequestMetadata

Metadata about the request.

JSON representation
{
  "callerIp": string,
  "callerSuppliedUserAgent": string,
  "callerNetwork": string,
  "requestAttributes": {
    object(Request)
  },
  "destinationAttributes": {
    object(Peer)
  }
}
Fields
callerIp

string

The IP address of the caller. For caller from internet, this will be public IPv4 or IPv6 address. For caller from a Compute Engine VM with external IP address, this will be the VM's external IP address. For caller from a Compute Engine VM without external IP address, if the VM is in the same organization (or project) as the accessed resource, callerIp will be the VM's internal IPv4 address, otherwise the callerIp will be redacted to "gce-internal-ip". See https://cloud.google.com/compute/docs/vpc/ for more information.

callerSuppliedUserAgent

string

The user agent of the caller. This information is not authenticated and should be treated accordingly. For example:

  • google-api-python-client/1.4.0: The request was made by the Google API client for Python.
  • Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0.9.62: The request was made by the Google Cloud SDK CLI (gcloud).
  • AppEngine-Google; (+http://code.google.com/appengine; appid: s~my-project: The request was made from the my-project App Engine app. NOLINT

callerNetwork

string

The network of the caller. Set only if the network host project is part of the same GCP organization (or project) as the accessed resource. See https://cloud.google.com/compute/docs/vpc/ for more information. This is a scheme-less URI full resource name. For example:

"//compute.googleapis.com/projects/PROJECT_ID/global/networks/NETWORK_ID"

requestAttributes

object(Request)

Request attributes used in IAM condition evaluation. This field contains request attributes like request time and access levels associated with the request.

To get the whole view of the attributes used in IAM condition evaluation, the user must also look into AuditLog.authentication_info.resource_attributes.

destinationAttributes

object(Peer)

The destination of a network activity, such as accepting a TCP connection. In a multi hop network activity, the destination represents the receiver of the last hop. Only two fields are used in this message, Peer.port and Peer.ip. These fields are optionally populated by those services utilizing the IAM condition feature.

Request

This message defines attributes for an HTTP request. If the actual request is not an HTTP request, the runtime system should try to map the actual request to an equivalent HTTP request.

JSON representation
{
  "id": string,
  "method": string,
  "headers": {
    string: string,
    ...
  },
  "path": string,
  "host": string,
  "scheme": string,
  "query": string,
  "fragment": string,
  "time": string,
  "size": string,
  "protocol": string,
  "reason": string,
  "auth": {
    object(Auth)
  }
}
Fields
id

string

The unique ID for a request, which can be propagated to downstream systems. The ID should have low probability of collision within a single day for a specific service.

method

string

The HTTP request method, such as GET, POST.

headers

map (key: string, value: string)

The HTTP request headers. If multiple headers share the same key, they must be merged according to the HTTP spec. All header keys must be lowercased, because HTTP header keys are case-insensitive.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

path

string

The HTTP URL path.

host

string

The HTTP request Host header value.

scheme

string

The HTTP URL scheme, such as http and https.

query

string

The HTTP URL query in the format of name1=value&name2=value2`, as it appears in the first line of the HTTP request. No decoding is performed.

fragment

string

The HTTP URL fragment. No URL decoding is performed.

time

string (Timestamp format)

The timestamp when the destination service receives the first byte of the request.

A timestamp in RFC3339 UTC "Zulu" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

size

string (int64 format)

The HTTP request size in bytes. If unknown, it must be -1.

protocol

string

The network protocol used with the request, such as "http/1.1", "spdy/3", "h2", "h2c", "webrtc", "tcp", "udp", "quic". See https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids for details.

reason

string

A special parameter for request reason. It is used by security systems to associate auditing information with a request.

auth

object(Auth)

The request authentication. May be absent for unauthenticated requests. Derived from the HTTP request Authorization header or equivalent.

Auth

This message defines request authentication attributes. Terminology is based on the JSON Web Token (JWT) standard, but the terms also correlate to concepts in other standards.

JSON representation
{
  "principal": string,
  "audiences": [
    string
  ],
  "presenter": string,
  "claims": {
    object
  },
  "accessLevels": [
    string
  ]
}
Fields
principal

string

The authenticated principal. Reflects the issuer (iss) and subject (sub) claims within a JWT. The issuer and subject should be / delimited, with / percent-encoded within the subject fragment. For Google accounts, the principal format is: "https://accounts.google.com/{id}"

audiences[]

string

The intended audience(s) for this authentication information. Reflects the audience (aud) claim within a JWT. The audience value(s) depends on the issuer, but typically include one or more of the following pieces of information:

  • The services intended to receive the credential such as ["pubsub.googleapis.com", "storage.googleapis.com"]
  • A set of service-based scopes. For example, ["https://www.googleapis.com/auth/cloud-platform"]
  • The client id of an app, such as the Firebase project id for JWTs from Firebase Auth.

Consult the documentation for the credential issuer to determine the information provided.

presenter

string

The authorized presenter of the credential. Reflects the optional Authorized Presenter (azp) claim within a JWT or the OAuth client id. For example, a Google Cloud Platform client id looks as follows: "123456789012.apps.googleusercontent.com".

claims

object (Struct format)

Structured claims presented with the credential. JWTs include {key: value} pairs for standard and private claims. The following is a subset of the standard required and optional claims that would typically be presented for a Google-based JWT:

{'iss': 'accounts.google.com', 'sub': '113289723416554971153', 'aud': ['123456789012', 'pubsub.googleapis.com'], 'azp': '123456789012.apps.googleusercontent.com', 'email': 'jsmith@example.com', 'iat': 1353601026, 'exp': 1353604926}

SAML assertions are similarly specified, but with an identity provider dependent structure.

accessLevels[]

string

A list of access level resource names that allow resources to be accessed by authenticated requester. It is part of Secure GCP processing for the incoming request. An access level string has the format: "//{api_service_name}/accessPolicies/{policy_id}/accessLevels/{short_name}"

Example: "//accesscontextmanager.googleapis.com/accessPolicies/MY_POLICY_ID/accessLevels/MY_LEVEL"

Peer

This message defines attributes for a node that handles a network request. The node can be either a service or an application that sends, forwards, or receives the request. Service peers should fill in the service, principal, and labels as appropriate.

JSON representation
{
  "ip": string,
  "port": string,
  "service": string,
  "labels": {
    string: string,
    ...
  },
  "principal": string,
  "regionCode": string
}
Fields
ip

string

The IP address of the peer.

port

string (int64 format)

The network port of the peer.

service

string

The canonical service name of the peer.

NOTE: different systems may have different service naming schemes.

labels

map (key: string, value: string)

The labels associated with the peer.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

principal

string

The identity of this peer. Similar to Request.auth.principal, but relative to the peer instead of the request. For example, the idenity associated with a load balancer that forwared the request.

regionCode

string

The CLDR country/region code associated with the above IP address. If the IP address is private, the regionCode should reflect the physical location where this peer is running.

Was this page helpful? Let us know how we did: