docs: Publish identitytoolkit request log proto

PiperOrigin-RevId: 461678527

google/cloud/identitytoolkit/logging/BUILD.bazel

@@ -0,0 +1,179 @@
+# This file was automatically generated by BuildFileGenerator
+
+# This is an API workspace, having public visibility by default makes perfect sense.
+package(default_visibility = ["//visibility:public"])
+
+##############################################################################
+# Common
+##############################################################################
+load("@rules_proto//proto:defs.bzl", "proto_library")
+
+proto_library(
+    name = "logging_proto",
+    srcs = [
+        "request_log.proto",
+    ],
+    deps = [
+        "//google/rpc:status_proto",
+        "@com_google_protobuf//:struct_proto",
+    ],
+)
+
+##############################################################################
+# Java
+##############################################################################
+load(
+    "@com_google_googleapis_imports//:imports.bzl",
+    "java_grpc_library",
+    "java_proto_library",
+)
+
+java_proto_library(
+    name = "logging_java_proto",
+    deps = [":logging_proto"],
+)
+
+java_grpc_library(
+    name = "logging_java_grpc",
+    srcs = [":logging_proto"],
+    deps = [":logging_java_proto"],
+)
+
+##############################################################################
+# Go
+##############################################################################
+load(
+    "@com_google_googleapis_imports//:imports.bzl",
+    "go_proto_library",
+)
+
+go_proto_library(
+    name = "logging_go_proto",
+    compilers = ["@io_bazel_rules_go//proto:go_grpc"],
+    importpath = "google.golang.org/genproto/googleapis/cloud/identitytoolkit/logging",
+    protos = [":logging_proto"],
+    deps = [
+        "//google/rpc:status_go_proto",
+    ],
+)
+
+##############################################################################
+# Python
+##############################################################################
+load(
+    "@com_google_googleapis_imports//:imports.bzl",
+    "moved_proto_library",
+    "py_grpc_library",
+    "py_proto_library",
+)
+
+moved_proto_library(
+    name = "logging_moved_proto",
+    srcs = [":logging_proto"],
+    deps = [
+        "//google/rpc:status_proto",
+        "@com_google_protobuf//:struct_proto",
+    ],
+)
+
+py_proto_library(
+    name = "logging_py_proto",
+    deps = [":logging_moved_proto"],
+)
+
+py_grpc_library(
+    name = "logging_py_grpc",
+    srcs = [":logging_moved_proto"],
+    deps = [":logging_py_proto"],
+)
+
+##############################################################################
+# PHP
+##############################################################################
+load(
+    "@com_google_googleapis_imports//:imports.bzl",
+    "php_grpc_library",
+    "php_proto_library",
+)
+
+php_proto_library(
+    name = "logging_php_proto",
+    deps = [":logging_proto"],
+)
+
+php_grpc_library(
+    name = "logging_php_grpc",
+    srcs = [":logging_proto"],
+    deps = [":logging_php_proto"],
+)
+
+##############################################################################
+# Node.js
+##############################################################################
+load(
+    "@com_google_googleapis_imports//:imports.bzl",
+    "nodejs_gapic_assembly_pkg",
+    "nodejs_gapic_library",
+)
+
+
+##############################################################################
+# Ruby
+##############################################################################
+load(
+    "@com_google_googleapis_imports//:imports.bzl",
+    "ruby_grpc_library",
+    "ruby_proto_library",
+)
+
+ruby_proto_library(
+    name = "logging_ruby_proto",
+    deps = [":logging_proto"],
+)
+
+ruby_grpc_library(
+    name = "logging_ruby_grpc",
+    srcs = [":logging_proto"],
+    deps = [":logging_ruby_proto"],
+)
+
+##############################################################################
+# C#
+##############################################################################
+load(
+    "@com_google_googleapis_imports//:imports.bzl",
+    "csharp_grpc_library",
+    "csharp_proto_library",
+)
+
+csharp_proto_library(
+    name = "logging_csharp_proto",
+    deps = [":logging_proto"],
+)
+
+csharp_grpc_library(
+    name = "logging_csharp_grpc",
+    srcs = [":logging_proto"],
+    deps = [":logging_csharp_proto"],
+)
+
+##############################################################################
+# C++
+##############################################################################
+load(
+    "@com_google_googleapis_imports//:imports.bzl",
+    "cc_grpc_library",
+    "cc_proto_library",
+)
+
+cc_proto_library(
+    name = "logging_cc_proto",
+    deps = [":logging_proto"],
+)
+
+cc_grpc_library(
+    name = "logging_cc_grpc",
+    srcs = [":logging_proto"],
+    grpc_only = True,
+    deps = [":logging_cc_proto"],
+)

google/cloud/identitytoolkit/logging/request_log.proto

@@ -0,0 +1,91 @@
+// Copyright 2022 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.cloud.identitytoolkit.logging;
+
+import "google/protobuf/struct.proto";
+import "google/rpc/status.proto";
+
+option go_package = "google.golang.org/genproto/googleapis/cloud/identitytoolkit/logging;logging";
+option java_multiple_files = true;
+option java_outer_classname = "RequestLogProto";
+option java_package = "com.google.cloud.identitytoolkit.logging";
+
+// Log of a request to Identitytoolkit. This proto is modeled after
+// google.cloud.audit.AuditLog so that consumers can easily query
+// for requests regardless of whether those requests were logged via
+// Cloud Audit Logging or Identitytoolkit request logging.
+message RequestLog {
+  // 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"
+  string method_name = 1;
+
+  // The status of the overall operation.
+  google.rpc.Status status = 2;
+
+  // Metadata about the operation.
+  RequestMetadata request_metadata = 3;
+
+  // 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.
+  google.protobuf.Struct request = 4;
+
+  // 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.
+  google.protobuf.Struct response = 5;
+
+  // The number of items returned from a List or Query API method,
+  // if applicable.
+  int64 num_response_items = 6;
+
+  // Other service-specific data about the request, response, and other
+  // information associated with the current event.
+  google.protobuf.Struct metadata = 7;
+}
+
+// Metadata about the request.
+message RequestMetadata {
+  // The IP address of the caller.
+  string caller_ip = 1;
+
+  // 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
+  string caller_supplied_user_agent = 2;
+}