Debian Codegraph @

docs/dyn/cloudkms_v1.projects.html

raw
1 <html><body>
2 <style>
3
4 body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13 }
14
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51 }
52
53 .toc_element {
54 margin-top: 0.5em;
55 }
56
57 .firstline {
58 margin-left: 2 em;
59 }
60
61 .method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66 }
67
68 .details {
69 font-weight: bold;
70 font-size: 14px;
71 }
72
73 </style>
74
75 <h1><a href="cloudkms_v1.html">Cloud Key Management Service (KMS) API</a> . <a href="cloudkms_v1.projects.html">projects</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="cloudkms_v1.projects.locations.html">locations()</a></code>
79 </p>
80 <p class="firstline">Returns the locations Resource.</p>
81
82 <p class="toc_element">
83 <code><a href="#close">close()</a></code></p>
84 <p class="firstline">Close httplib2 connections.</p>
85 <p class="toc_element">
86 <code><a href="#getAutokeyConfig">getAutokeyConfig(name, x__xgafv=None)</a></code></p>
87 <p class="firstline">Returns the AutokeyConfig for a folder or project.</p>
88 <p class="toc_element">
89 <code><a href="#getKajPolicyConfig">getKajPolicyConfig(name, x__xgafv=None)</a></code></p>
90 <p class="firstline">Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.</p>
91 <p class="toc_element">
92 <code><a href="#showEffectiveAutokeyConfig">showEffectiveAutokeyConfig(parent, x__xgafv=None)</a></code></p>
93 <p class="firstline">Returns the effective Cloud KMS Autokey configuration for a given project.</p>
94 <p class="toc_element">
95 <code><a href="#showEffectiveKeyAccessJustificationsEnrollmentConfig">showEffectiveKeyAccessJustificationsEnrollmentConfig(project, x__xgafv=None)</a></code></p>
96 <p class="firstline">Returns the KeyAccessJustificationsEnrollmentConfig of the resource closest to the given project in hierarchy.</p>
97 <p class="toc_element">
98 <code><a href="#showEffectiveKeyAccessJustificationsPolicyConfig">showEffectiveKeyAccessJustificationsPolicyConfig(project, x__xgafv=None)</a></code></p>
99 <p class="firstline">Returns the KeyAccessJustificationsPolicyConfig of the resource closest to the given project in hierarchy.</p>
100 <p class="toc_element">
101 <code><a href="#updateAutokeyConfig">updateAutokeyConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
102 <p class="firstline">Updates the AutokeyConfig for a folder or a project. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder's descendant projects will use this configuration to determine where to create the resulting CryptoKey.</p>
103 <p class="toc_element">
104 <code><a href="#updateKajPolicyConfig">updateKajPolicyConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
105 <p class="firstline">Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.</p>
106 <h3>Method Details</h3>
107 <div class="method">
108 <code class="details" id="close">close()</code>
109 <pre>Close httplib2 connections.</pre>
110 </div>
111
112 <div class="method">
113 <code class="details" id="getAutokeyConfig">getAutokeyConfig(name, x__xgafv=None)</code>
114 <pre>Returns the AutokeyConfig for a folder or project.
115
116 Args:
117 name: string, Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`. (required)
118 x__xgafv: string, V1 error format.
119 Allowed values
120 1 - v1 error format
121 2 - v2 error format
122
123 Returns:
124 An object of the form:
125
126 { # Cloud KMS Autokey configuration for a folder.
127 &quot;etag&quot;: &quot;A String&quot;, # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.
128 &quot;keyProject&quot;: &quot;A String&quot;, # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration.
129 &quot;keyProjectResolutionMode&quot;: &quot;A String&quot;, # Optional. KeyProjectResolutionMode for the AutokeyConfig. Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or `DISABLED`.
130 &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`.
131 &quot;state&quot;: &quot;A String&quot;, # Output only. The state for the AutokeyConfig.
132 }</pre>
133 </div>
134
135 <div class="method">
136 <code class="details" id="getKajPolicyConfig">getKajPolicyConfig(name, x__xgafv=None)</code>
137 <pre>Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.
138
139 Args:
140 name: string, Required. Specifies the name of the KeyAccessJustificationsPolicyConfig to get. (required)
141 x__xgafv: string, V1 error format.
142 Allowed values
143 1 - v1 error format
144 2 - v2 error format
145
146 Returns:
147 An object of the form:
148
149 { # Represents a singleton configuration for Key Access Justifications policies.
150 &quot;defaultKeyAccessJustificationPolicy&quot;: { # A KeyAccessJustificationsPolicy specifies zero or more allowed AccessReason values for encrypt, decrypt, and sign operations on a CryptoKey or KeyAccessJustificationsPolicyConfig (the default Key Access Justifications policy). # Optional. Specifies the default key access justifications (KAJ) policy used when a CryptoKey is created in this folder. This is only used when a Key Access Justifications policy is not provided in the CreateCryptoKeyRequest. This overrides any default policies in its ancestry. If this field is unset, or is set but contains an empty allowed_access_reasons list, no default Key Access Justifications (KAJ) policy configuration is active. In this scenario, all newly created keys will default to an &quot;allow-all&quot; policy.
151 &quot;allowedAccessReasons&quot;: [ # The list of allowed reasons for access to a CryptoKey. Note that empty allowed_access_reasons has a different meaning depending on where this message appears. If this is under KeyAccessJustificationsPolicyConfig, it means allow-all. If this is under CryptoKey, it means deny-all.
152 &quot;A String&quot;,
153 ],
154 },
155 &quot;defaultPolicyAvailable&quot;: True or False, # Output only. Indicates whether this parent resource is available to default policy feature. Please consult [the prerequisite of default policy feature](https://cloud.google.com/assured-workloads/key-access-justifications/docs/set-default-policy#before) for more details.
156 &quot;name&quot;: &quot;A String&quot;, # Identifier. Represents the resource name for this KeyAccessJustificationsPolicyConfig in the format of &quot;{organizations|folders|projects}/*/kajPolicyConfig&quot;.
157 }</pre>
158 </div>
159
160 <div class="method">
161 <code class="details" id="showEffectiveAutokeyConfig">showEffectiveAutokeyConfig(parent, x__xgafv=None)</code>
162 <pre>Returns the effective Cloud KMS Autokey configuration for a given project.
163
164 Args:
165 parent: string, Required. Name of the resource project to the show effective Cloud KMS Autokey configuration for. This may be helpful for interrogating the effect of nested folder configurations on a given resource project. (required)
166 x__xgafv: string, V1 error format.
167 Allowed values
168 1 - v1 error format
169 2 - v2 error format
170
171 Returns:
172 An object of the form:
173
174 { # Response message for ShowEffectiveAutokeyConfig.
175 &quot;keyProject&quot;: &quot;A String&quot;, # Name of the key project configured in the resource project&#x27;s folder ancestry.
176 }</pre>
177 </div>
178
179 <div class="method">
180 <code class="details" id="showEffectiveKeyAccessJustificationsEnrollmentConfig">showEffectiveKeyAccessJustificationsEnrollmentConfig(project, x__xgafv=None)</code>
181 <pre>Returns the KeyAccessJustificationsEnrollmentConfig of the resource closest to the given project in hierarchy.
182
183 Args:
184 project: string, Required. Specifies the number or id of the project to get the effective KeyAccessJustificationsEnrollmentConfig for. (required)
185 x__xgafv: string, V1 error format.
186 Allowed values
187 1 - v1 error format
188 2 - v2 error format
189
190 Returns:
191 An object of the form:
192
193 { # Represents a response message for KeyAccessJustificationsConfig.ShowEffectiveKeyAccessJustificationsEnrollmentConfig
194 &quot;externalConfig&quot;: { # Represents the configuration of a protection level for a project&#x27;s Key Access Justifications enrollment. # Contains the effective KeyAccessJustificationsEnrollmentConfig for external keys.
195 &quot;auditLogging&quot;: True or False, # Indicates whether the project has KAJ logging enabled.
196 &quot;policyEnforcement&quot;: True or False, # Indicates whether the project is enrolled in KAJ policy enforcement.
197 },
198 &quot;hardwareConfig&quot;: { # Represents the configuration of a protection level for a project&#x27;s Key Access Justifications enrollment. # Contains the effective KeyAccessJustificationsEnrollmentConfig for hardware keys.
199 &quot;auditLogging&quot;: True or False, # Indicates whether the project has KAJ logging enabled.
200 &quot;policyEnforcement&quot;: True or False, # Indicates whether the project is enrolled in KAJ policy enforcement.
201 },
202 &quot;softwareConfig&quot;: { # Represents the configuration of a protection level for a project&#x27;s Key Access Justifications enrollment. # Contains the effective KeyAccessJustificationsEnrollmentConfig for software keys.
203 &quot;auditLogging&quot;: True or False, # Indicates whether the project has KAJ logging enabled.
204 &quot;policyEnforcement&quot;: True or False, # Indicates whether the project is enrolled in KAJ policy enforcement.
205 },
206 }</pre>
207 </div>
208
209 <div class="method">
210 <code class="details" id="showEffectiveKeyAccessJustificationsPolicyConfig">showEffectiveKeyAccessJustificationsPolicyConfig(project, x__xgafv=None)</code>
211 <pre>Returns the KeyAccessJustificationsPolicyConfig of the resource closest to the given project in hierarchy.
212
213 Args:
214 project: string, Required. Specifies the number or id of the project to get the effective KeyAccessJustificationsPolicyConfig. In the format of &quot;projects/{|}&quot; (required)
215 x__xgafv: string, V1 error format.
216 Allowed values
217 1 - v1 error format
218 2 - v2 error format
219
220 Returns:
221 An object of the form:
222
223 { # Represents a response message for KeyAccessJustificationsConfig.ShowEffectiveKeyAccessJustificationsPolicyConfig.
224 &quot;effectiveKajPolicy&quot;: { # Represents a singleton configuration for Key Access Justifications policies. # Contains the effective KeyAccessJustificationsPolicyConfig.
225 &quot;defaultKeyAccessJustificationPolicy&quot;: { # A KeyAccessJustificationsPolicy specifies zero or more allowed AccessReason values for encrypt, decrypt, and sign operations on a CryptoKey or KeyAccessJustificationsPolicyConfig (the default Key Access Justifications policy). # Optional. Specifies the default key access justifications (KAJ) policy used when a CryptoKey is created in this folder. This is only used when a Key Access Justifications policy is not provided in the CreateCryptoKeyRequest. This overrides any default policies in its ancestry. If this field is unset, or is set but contains an empty allowed_access_reasons list, no default Key Access Justifications (KAJ) policy configuration is active. In this scenario, all newly created keys will default to an &quot;allow-all&quot; policy.
226 &quot;allowedAccessReasons&quot;: [ # The list of allowed reasons for access to a CryptoKey. Note that empty allowed_access_reasons has a different meaning depending on where this message appears. If this is under KeyAccessJustificationsPolicyConfig, it means allow-all. If this is under CryptoKey, it means deny-all.
227 &quot;A String&quot;,
228 ],
229 },
230 &quot;defaultPolicyAvailable&quot;: True or False, # Output only. Indicates whether this parent resource is available to default policy feature. Please consult [the prerequisite of default policy feature](https://cloud.google.com/assured-workloads/key-access-justifications/docs/set-default-policy#before) for more details.
231 &quot;name&quot;: &quot;A String&quot;, # Identifier. Represents the resource name for this KeyAccessJustificationsPolicyConfig in the format of &quot;{organizations|folders|projects}/*/kajPolicyConfig&quot;.
232 },
233 }</pre>
234 </div>
235
236 <div class="method">
237 <code class="details" id="updateAutokeyConfig">updateAutokeyConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
238 <pre>Updates the AutokeyConfig for a folder or a project. The caller must have both `cloudkms.autokeyConfigs.update` permission on the parent folder and `cloudkms.cryptoKeys.setIamPolicy` permission on the provided key project. A KeyHandle creation in the folder&#x27;s descendant projects will use this configuration to determine where to create the resulting CryptoKey.
239
240 Args:
241 name: string, Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`. (required)
242 body: object, The request body.
243 The object takes the form of:
244
245 { # Cloud KMS Autokey configuration for a folder.
246 &quot;etag&quot;: &quot;A String&quot;, # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.
247 &quot;keyProject&quot;: &quot;A String&quot;, # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration.
248 &quot;keyProjectResolutionMode&quot;: &quot;A String&quot;, # Optional. KeyProjectResolutionMode for the AutokeyConfig. Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or `DISABLED`.
249 &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`.
250 &quot;state&quot;: &quot;A String&quot;, # Output only. The state for the AutokeyConfig.
251 }
252
253 updateMask: string, Required. Masks which fields of the AutokeyConfig to update, e.g. `keyProject`.
254 x__xgafv: string, V1 error format.
255 Allowed values
256 1 - v1 error format
257 2 - v2 error format
258
259 Returns:
260 An object of the form:
261
262 { # Cloud KMS Autokey configuration for a folder.
263 &quot;etag&quot;: &quot;A String&quot;, # Optional. A checksum computed by the server based on the value of other fields. This may be sent on update requests to ensure that the client has an up-to-date value before proceeding. The request will be rejected with an ABORTED error on a mismatched etag.
264 &quot;keyProject&quot;: &quot;A String&quot;, # Optional. Name of the key project, e.g. `projects/{PROJECT_ID}` or `projects/{PROJECT_NUMBER}`, where Cloud KMS Autokey will provision a new CryptoKey when a KeyHandle is created. On UpdateAutokeyConfig, the caller will require `cloudkms.cryptoKeys.setIamPolicy` permission on this key project. Once configured, for Cloud KMS Autokey to function properly, this key project must have the Cloud KMS API activated and the Cloud KMS Service Agent for this key project must be granted the `cloudkms.admin` role (or pertinent permissions). A request with an empty key project field will clear the configuration.
265 &quot;keyProjectResolutionMode&quot;: &quot;A String&quot;, # Optional. KeyProjectResolutionMode for the AutokeyConfig. Valid values are `DEDICATED_KEY_PROJECT`, `RESOURCE_PROJECT`, or `DISABLED`.
266 &quot;name&quot;: &quot;A String&quot;, # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig`, `projects/{PROJECT_NUMBER}/autokeyConfig`, or `projects/{PROJECT_ID}/autokeyConfig`.
267 &quot;state&quot;: &quot;A String&quot;, # Output only. The state for the AutokeyConfig.
268 }</pre>
269 </div>
270
271 <div class="method">
272 <code class="details" id="updateKajPolicyConfig">updateKajPolicyConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
273 <pre>Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.
274
275 Args:
276 name: string, Identifier. Represents the resource name for this KeyAccessJustificationsPolicyConfig in the format of &quot;{organizations|folders|projects}/*/kajPolicyConfig&quot;. (required)
277 body: object, The request body.
278 The object takes the form of:
279
280 { # Represents a singleton configuration for Key Access Justifications policies.
281 &quot;defaultKeyAccessJustificationPolicy&quot;: { # A KeyAccessJustificationsPolicy specifies zero or more allowed AccessReason values for encrypt, decrypt, and sign operations on a CryptoKey or KeyAccessJustificationsPolicyConfig (the default Key Access Justifications policy). # Optional. Specifies the default key access justifications (KAJ) policy used when a CryptoKey is created in this folder. This is only used when a Key Access Justifications policy is not provided in the CreateCryptoKeyRequest. This overrides any default policies in its ancestry. If this field is unset, or is set but contains an empty allowed_access_reasons list, no default Key Access Justifications (KAJ) policy configuration is active. In this scenario, all newly created keys will default to an &quot;allow-all&quot; policy.
282 &quot;allowedAccessReasons&quot;: [ # The list of allowed reasons for access to a CryptoKey. Note that empty allowed_access_reasons has a different meaning depending on where this message appears. If this is under KeyAccessJustificationsPolicyConfig, it means allow-all. If this is under CryptoKey, it means deny-all.
283 &quot;A String&quot;,
284 ],
285 },
286 &quot;defaultPolicyAvailable&quot;: True or False, # Output only. Indicates whether this parent resource is available to default policy feature. Please consult [the prerequisite of default policy feature](https://cloud.google.com/assured-workloads/key-access-justifications/docs/set-default-policy#before) for more details.
287 &quot;name&quot;: &quot;A String&quot;, # Identifier. Represents the resource name for this KeyAccessJustificationsPolicyConfig in the format of &quot;{organizations|folders|projects}/*/kajPolicyConfig&quot;.
288 }
289
290 updateMask: string, Optional. Specifies the list of fields to update.
291 x__xgafv: string, V1 error format.
292 Allowed values
293 1 - v1 error format
294 2 - v2 error format
295
296 Returns:
297 An object of the form:
298
299 { # Represents a singleton configuration for Key Access Justifications policies.
300 &quot;defaultKeyAccessJustificationPolicy&quot;: { # A KeyAccessJustificationsPolicy specifies zero or more allowed AccessReason values for encrypt, decrypt, and sign operations on a CryptoKey or KeyAccessJustificationsPolicyConfig (the default Key Access Justifications policy). # Optional. Specifies the default key access justifications (KAJ) policy used when a CryptoKey is created in this folder. This is only used when a Key Access Justifications policy is not provided in the CreateCryptoKeyRequest. This overrides any default policies in its ancestry. If this field is unset, or is set but contains an empty allowed_access_reasons list, no default Key Access Justifications (KAJ) policy configuration is active. In this scenario, all newly created keys will default to an &quot;allow-all&quot; policy.
301 &quot;allowedAccessReasons&quot;: [ # The list of allowed reasons for access to a CryptoKey. Note that empty allowed_access_reasons has a different meaning depending on where this message appears. If this is under KeyAccessJustificationsPolicyConfig, it means allow-all. If this is under CryptoKey, it means deny-all.
302 &quot;A String&quot;,
303 ],
304 },
305 &quot;defaultPolicyAvailable&quot;: True or False, # Output only. Indicates whether this parent resource is available to default policy feature. Please consult [the prerequisite of default policy feature](https://cloud.google.com/assured-workloads/key-access-justifications/docs/set-default-policy#before) for more details.
306 &quot;name&quot;: &quot;A String&quot;, # Identifier. Represents the resource name for this KeyAccessJustificationsPolicyConfig in the format of &quot;{organizations|folders|projects}/*/kajPolicyConfig&quot;.
307 }</pre>
308 </div>
309
310 </body></html>