xref: /aosp_15_r20/external/googleapis/google/cloud/security/privateca/v1/privateca_v1.yaml (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1type: google.api.Service
2config_version: 3
3name: privateca.googleapis.com
4title: Certificate Authority API
5
6apis:
7- name: google.cloud.location.Locations
8- name: google.cloud.security.privateca.v1.CertificateAuthorityService
9- name: google.iam.v1.IAMPolicy
10- name: google.longrunning.Operations
11
12types:
13- name: google.cloud.security.privateca.v1.OperationMetadata
14
15documentation:
16  summary: |-
17    The Certificate Authority Service API is a highly-available, scalable
18    service that enables you to simplify and automate the management of
19    private certificate authorities (CAs) while staying in control of your
20    private keys.
21  rules:
22  - selector: google.cloud.location.Locations.GetLocation
23    description: Gets information about a location.
24
25  - selector: google.cloud.location.Locations.ListLocations
26    description: Lists information about the supported locations for this service.
27
28  - selector: google.iam.v1.IAMPolicy.GetIamPolicy
29    description: |-
30      Gets the access control policy for a resource. Returns an empty policy
31      if the resource exists and does not have a policy set.
32
33  - selector: google.iam.v1.IAMPolicy.SetIamPolicy
34    description: |-
35      Sets the access control policy on the specified resource. Replaces
36      any existing policy.
37
38      Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`
39      errors.
40
41  - selector: google.iam.v1.IAMPolicy.TestIamPermissions
42    description: |-
43      Returns permissions that a caller has on the specified resource. If the
44      resource does not exist, this will return an empty set of
45      permissions, not a `NOT_FOUND` error.
46
47      Note: This operation is designed to be used for building
48      permission-aware UIs and command-line tools, not for authorization
49      checking. This operation may "fail open" without warning.
50
51backend:
52  rules:
53  - selector: google.cloud.location.Locations.GetLocation
54    deadline: 60.0
55  - selector: google.cloud.location.Locations.ListLocations
56    deadline: 60.0
57  - selector: 'google.cloud.security.privateca.v1.CertificateAuthorityService.*'
58    deadline: 60.0
59  - selector: 'google.iam.v1.IAMPolicy.*'
60    deadline: 60.0
61  - selector: 'google.longrunning.Operations.*'
62    deadline: 60.0
63  - selector: google.longrunning.Operations.GetOperation
64    deadline: 5.0
65
66http:
67  rules:
68  - selector: google.cloud.location.Locations.GetLocation
69    get: '/v1/{name=projects/*/locations/*}'
70  - selector: google.cloud.location.Locations.ListLocations
71    get: '/v1/{name=projects/*}/locations'
72  - selector: google.iam.v1.IAMPolicy.GetIamPolicy
73    get: '/v1/{resource=projects/*/locations/*/caPools/*}:getIamPolicy'
74    additional_bindings:
75    - get: '/v1/{resource=projects/*/locations/*/certificateTemplates/*}:getIamPolicy'
76    - get: '/v1/{resource=projects/*/locations/*/caPools/*/certificateAuthorities/*/certificateRevocationLists/*}:getIamPolicy'
77  - selector: google.iam.v1.IAMPolicy.SetIamPolicy
78    post: '/v1/{resource=projects/*/locations/*/caPools/*}:setIamPolicy'
79    body: '*'
80    additional_bindings:
81    - post: '/v1/{resource=projects/*/locations/*/certificateTemplates/*}:setIamPolicy'
82      body: '*'
83    - post: '/v1/{resource=projects/*/locations/*/caPools/*/certificateAuthorities/*/certificateRevocationLists/*}:setIamPolicy'
84      body: '*'
85  - selector: google.iam.v1.IAMPolicy.TestIamPermissions
86    post: '/v1/{resource=projects/*/locations/*/caPools/*}:testIamPermissions'
87    body: '*'
88    additional_bindings:
89    - post: '/v1/{resource=projects/*/locations/*/certificateTemplates/*}:testIamPermissions'
90      body: '*'
91    - post: '/v1/{resource=projects/*/locations/*/caPools/*/certificateAuthorities/*/certificateRevocationLists/*}:testIamPermissions'
92      body: '*'
93  - selector: google.longrunning.Operations.CancelOperation
94    post: '/v1/{name=projects/*/locations/*/operations/*}:cancel'
95    body: '*'
96  - selector: google.longrunning.Operations.DeleteOperation
97    delete: '/v1/{name=projects/*/locations/*/operations/*}'
98  - selector: google.longrunning.Operations.GetOperation
99    get: '/v1/{name=projects/*/locations/*/operations/*}'
100  - selector: google.longrunning.Operations.ListOperations
101    get: '/v1/{name=projects/*/locations/*}/operations'
102
103authentication:
104  rules:
105  - selector: google.cloud.location.Locations.GetLocation
106    oauth:
107      canonical_scopes: |-
108        https://www.googleapis.com/auth/cloud-platform
109  - selector: google.cloud.location.Locations.ListLocations
110    oauth:
111      canonical_scopes: |-
112        https://www.googleapis.com/auth/cloud-platform
113  - selector: 'google.cloud.security.privateca.v1.CertificateAuthorityService.*'
114    oauth:
115      canonical_scopes: |-
116        https://www.googleapis.com/auth/cloud-platform
117  - selector: 'google.iam.v1.IAMPolicy.*'
118    oauth:
119      canonical_scopes: |-
120        https://www.googleapis.com/auth/cloud-platform
121  - selector: 'google.longrunning.Operations.*'
122    oauth:
123      canonical_scopes: |-
124        https://www.googleapis.com/auth/cloud-platform
125