xref: /aosp_15_r20/external/googleapis/google/cloud/security/publicca/v1beta1/service.proto (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1// Copyright 2023 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto3";
16
17package google.cloud.security.publicca.v1beta1;
18
19import "google/api/annotations.proto";
20import "google/api/client.proto";
21import "google/api/field_behavior.proto";
22import "google/api/resource.proto";
23import "google/cloud/security/publicca/v1beta1/resources.proto";
24
25option cc_enable_arenas = true;
26option csharp_namespace = "Google.Cloud.Security.PublicCA.V1Beta1";
27option go_package = "cloud.google.com/go/security/publicca/apiv1beta1/publiccapb;publiccapb";
28option java_multiple_files = true;
29option java_outer_classname = "ServiceProto";
30option java_package = "com.google.cloud.security.publicca.v1beta1";
31option php_namespace = "Google\\Cloud\\Security\\PublicCA\\V1beta1";
32option ruby_package = "Google::Cloud::Security::PublicCA::V1beta1";
33
34// Manages the resources required for ACME [external account
35// binding](https://tools.ietf.org/html/rfc8555#section-7.3.4) for
36// the public certificate authority service.
37service PublicCertificateAuthorityService {
38  option (google.api.default_host) = "publicca.googleapis.com";
39  option (google.api.oauth_scopes) = "https://www.googleapis.com/auth/cloud-platform";
40
41  // Creates a new [ExternalAccountKey][google.cloud.security.publicca.v1beta1.ExternalAccountKey] bound to the project.
42  rpc CreateExternalAccountKey(CreateExternalAccountKeyRequest) returns (ExternalAccountKey) {
43    option (google.api.http) = {
44      post: "/v1beta1/{parent=projects/*/locations/*}/externalAccountKeys"
45      body: "external_account_key"
46    };
47    option (google.api.method_signature) = "parent,external_account_key";
48  }
49}
50
51// Creates a new [ExternalAccountKey][google.cloud.security.publicca.v1beta1.ExternalAccountKey] in a given project.
52message CreateExternalAccountKeyRequest {
53  // Required. The parent resource where this external_account_key will be created.
54  // Format: projects/[project_id]/locations/[location].
55  // At present only the "global" location is supported.
56  string parent = 1 [
57    (google.api.field_behavior) = REQUIRED,
58    (google.api.resource_reference) = {
59      child_type: "publicca.googleapis.com/ExternalAccountKey"
60    }
61  ];
62
63  // Required. The external account key to create. This field only exists to future-proof
64  // the API. At present, all fields in ExternalAccountKey are output only and
65  // all values are ignored. For the purpose of the
66  // CreateExternalAccountKeyRequest, set it to a default/empty value.
67  ExternalAccountKey external_account_key = 2 [(google.api.field_behavior) = REQUIRED];
68}
69