1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="cloudkms_v1.html">Cloud Key Management Service (KMS) API</a> . <a href="cloudkms_v1.projects.html">projects</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="cloudkms_v1.projects.locations.html">locations()</a></code>
</p>
<p class="firstline">Returns the locations Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#getAutokeyConfig">getAutokeyConfig(name, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the AutokeyConfig for a folder or project.</p>
<p class="toc_element">
<code><a href="#getKajPolicyConfig">getKajPolicyConfig(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.</p>
<p class="toc_element">
<code><a href="#showEffectiveAutokeyConfig">showEffectiveAutokeyConfig(parent, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the effective Cloud KMS Autokey configuration for a given project.</p>
<p class="toc_element">
<code><a href="#showEffectiveKeyAccessJustificationsEnrollmentConfig">showEffectiveKeyAccessJustificationsEnrollmentConfig(project, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the KeyAccessJustificationsEnrollmentConfig of the resource closest to the given project in hierarchy.</p>
<p class="toc_element">
<code><a href="#showEffectiveKeyAccessJustificationsPolicyConfig">showEffectiveKeyAccessJustificationsPolicyConfig(project, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the KeyAccessJustificationsPolicyConfig of the resource closest to the given project in hierarchy.</p>
<p class="toc_element">
<code><a href="#updateAutokeyConfig">updateAutokeyConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the AutokeyConfig for a folder. 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>
<p class="toc_element">
<code><a href="#updateKajPolicyConfig">updateKajPolicyConfig(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="getAutokeyConfig">getAutokeyConfig(name, x__xgafv=None)</code>
<pre>Returns the AutokeyConfig for a folder or project.
Args:
name: string, Required. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` or `projects/{PROJECT_NUMBER}/autokeyConfig`. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Cloud KMS Autokey configuration for a folder or project.
"etag": "A String", # 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.
"keyProject": "A String", # 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.
"name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` `projects/{PROJECT_NUMBER}/autokeyConfig`.
"state": "A String", # Output only. The state for the AutokeyConfig.
}</pre>
</div>
<div class="method">
<code class="details" id="getKajPolicyConfig">getKajPolicyConfig(name, x__xgafv=None)</code>
<pre>Gets the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.
Args:
name: string, Required. The name of the KeyAccessJustificationsPolicyConfig to get. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A singleton configuration for Key Access Justifications policies.
"defaultKeyAccessJustificationPolicy": { # A KeyAccessJustificationsPolicy specifies zero or more allowed AccessReason values for encrypt, decrypt, and sign operations on a CryptoKey. # Optional. The default key access justification 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.
"allowedAccessReasons": [ # The list of allowed reasons for access to a CryptoKey. Zero allowed access reasons means all encrypt, decrypt, and sign operations for the CryptoKey associated with this policy will fail.
"A String",
],
},
"name": "A String", # Identifier. The resource name for this KeyAccessJustificationsPolicyConfig in the format of "{organizations|folders|projects}/*/kajPolicyConfig".
}</pre>
</div>
<div class="method">
<code class="details" id="showEffectiveAutokeyConfig">showEffectiveAutokeyConfig(parent, x__xgafv=None)</code>
<pre>Returns the effective Cloud KMS Autokey configuration for a given project.
Args:
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)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for ShowEffectiveAutokeyConfig.
"keyProject": "A String", # Name of the key project configured in the resource project's folder ancestry.
}</pre>
</div>
<div class="method">
<code class="details" id="showEffectiveKeyAccessJustificationsEnrollmentConfig">showEffectiveKeyAccessJustificationsEnrollmentConfig(project, x__xgafv=None)</code>
<pre>Returns the KeyAccessJustificationsEnrollmentConfig of the resource closest to the given project in hierarchy.
Args:
project: string, Required. The number or id of the project to get the effective KeyAccessJustificationsEnrollmentConfig for. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for KeyAccessJustificationsConfig.ShowEffectiveKeyAccessJustificationsEnrollmentConfig
"externalConfig": { # The configuration of a protection level for a project's Key Access Justifications enrollment. # The effective KeyAccessJustificationsEnrollmentConfig for external keys.
"auditLogging": True or False, # Whether the project has KAJ logging enabled.
"policyEnforcement": True or False, # Whether the project is enrolled in KAJ policy enforcement.
},
"hardwareConfig": { # The configuration of a protection level for a project's Key Access Justifications enrollment. # The effective KeyAccessJustificationsEnrollmentConfig for hardware keys.
"auditLogging": True or False, # Whether the project has KAJ logging enabled.
"policyEnforcement": True or False, # Whether the project is enrolled in KAJ policy enforcement.
},
"softwareConfig": { # The configuration of a protection level for a project's Key Access Justifications enrollment. # The effective KeyAccessJustificationsEnrollmentConfig for software keys.
"auditLogging": True or False, # Whether the project has KAJ logging enabled.
"policyEnforcement": True or False, # Whether the project is enrolled in KAJ policy enforcement.
},
}</pre>
</div>
<div class="method">
<code class="details" id="showEffectiveKeyAccessJustificationsPolicyConfig">showEffectiveKeyAccessJustificationsPolicyConfig(project, x__xgafv=None)</code>
<pre>Returns the KeyAccessJustificationsPolicyConfig of the resource closest to the given project in hierarchy.
Args:
project: string, Required. The number or id of the project to get the effective KeyAccessJustificationsPolicyConfig. In the format of "projects/{|}" (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for KeyAccessJustificationsConfig.ShowEffectiveKeyAccessJustificationsPolicyConfig.
"effectiveKajPolicy": { # A singleton configuration for Key Access Justifications policies. # The effective KeyAccessJustificationsPolicyConfig.
"defaultKeyAccessJustificationPolicy": { # A KeyAccessJustificationsPolicy specifies zero or more allowed AccessReason values for encrypt, decrypt, and sign operations on a CryptoKey. # Optional. The default key access justification 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.
"allowedAccessReasons": [ # The list of allowed reasons for access to a CryptoKey. Zero allowed access reasons means all encrypt, decrypt, and sign operations for the CryptoKey associated with this policy will fail.
"A String",
],
},
"name": "A String", # Identifier. The resource name for this KeyAccessJustificationsPolicyConfig in the format of "{organizations|folders|projects}/*/kajPolicyConfig".
},
}</pre>
</div>
<div class="method">
<code class="details" id="updateAutokeyConfig">updateAutokeyConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the AutokeyConfig for a folder. 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.
Args:
name: string, Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` `projects/{PROJECT_NUMBER}/autokeyConfig`. (required)
body: object, The request body.
The object takes the form of:
{ # Cloud KMS Autokey configuration for a folder or project.
"etag": "A String", # 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.
"keyProject": "A String", # 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.
"name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` `projects/{PROJECT_NUMBER}/autokeyConfig`.
"state": "A String", # Output only. The state for the AutokeyConfig.
}
updateMask: string, Required. Masks which fields of the AutokeyConfig to update, e.g. `keyProject`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Cloud KMS Autokey configuration for a folder or project.
"etag": "A String", # 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.
"keyProject": "A String", # 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.
"name": "A String", # Identifier. Name of the AutokeyConfig resource, e.g. `folders/{FOLDER_NUMBER}/autokeyConfig` `projects/{PROJECT_NUMBER}/autokeyConfig`.
"state": "A String", # Output only. The state for the AutokeyConfig.
}</pre>
</div>
<div class="method">
<code class="details" id="updateKajPolicyConfig">updateKajPolicyConfig(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates the KeyAccessJustificationsPolicyConfig for a given organization, folder, or project.
Args:
name: string, Identifier. The resource name for this KeyAccessJustificationsPolicyConfig in the format of "{organizations|folders|projects}/*/kajPolicyConfig". (required)
body: object, The request body.
The object takes the form of:
{ # A singleton configuration for Key Access Justifications policies.
"defaultKeyAccessJustificationPolicy": { # A KeyAccessJustificationsPolicy specifies zero or more allowed AccessReason values for encrypt, decrypt, and sign operations on a CryptoKey. # Optional. The default key access justification 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.
"allowedAccessReasons": [ # The list of allowed reasons for access to a CryptoKey. Zero allowed access reasons means all encrypt, decrypt, and sign operations for the CryptoKey associated with this policy will fail.
"A String",
],
},
"name": "A String", # Identifier. The resource name for this KeyAccessJustificationsPolicyConfig in the format of "{organizations|folders|projects}/*/kajPolicyConfig".
}
updateMask: string, Optional. The list of fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A singleton configuration for Key Access Justifications policies.
"defaultKeyAccessJustificationPolicy": { # A KeyAccessJustificationsPolicy specifies zero or more allowed AccessReason values for encrypt, decrypt, and sign operations on a CryptoKey. # Optional. The default key access justification 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.
"allowedAccessReasons": [ # The list of allowed reasons for access to a CryptoKey. Zero allowed access reasons means all encrypt, decrypt, and sign operations for the CryptoKey associated with this policy will fail.
"A String",
],
},
"name": "A String", # Identifier. The resource name for this KeyAccessJustificationsPolicyConfig in the format of "{organizations|folders|projects}/*/kajPolicyConfig".
}</pre>
</div>
</body></html>
|
