OLD | NEW |
1 { | 1 { |
2 "auth": { | 2 "auth": { |
3 "oauth2": { | 3 "oauth2": { |
4 "scopes": { | 4 "scopes": { |
5 "https://www.googleapis.com/auth/cloud-platform": { | 5 "https://www.googleapis.com/auth/cloud-platform": { |
6 "description": "View and manage your data across Google Clou
d Platform services" | 6 "description": "View and manage your data across Google Clou
d Platform services" |
7 } | 7 } |
8 } | 8 } |
9 } | 9 } |
10 }, | 10 }, |
11 "basePath": "", | 11 "basePath": "", |
12 "baseUrl": "https://cloudkms.googleapis.com/", | 12 "baseUrl": "https://cloudkms.googleapis.com/", |
13 "batchPath": "batch", | 13 "batchPath": "batch", |
14 "canonicalName": "Cloud KMS", | 14 "canonicalName": "Cloud KMS", |
15 "description": "Manages encryption for your cloud services the same way you
do on-premise. You can generate, use, rotate, and destroy AES256 encryption keys
.", | 15 "description": "Manages encryption for your cloud services the same way you
do on-premises. You can generate, use, rotate, and destroy AES256 encryption key
s.", |
16 "discoveryVersion": "v1", | 16 "discoveryVersion": "v1", |
17 "documentationLink": "https://cloud.google.com/kms/", | 17 "documentationLink": "https://cloud.google.com/kms/", |
18 "icons": { | 18 "icons": { |
19 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 19 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
20 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 20 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
21 }, | 21 }, |
22 "id": "cloudkms:v1", | 22 "id": "cloudkms:v1", |
23 "kind": "discovery#restDescription", | 23 "kind": "discovery#restDescription", |
24 "name": "cloudkms", | 24 "name": "cloudkms", |
25 "ownerDomain": "google.com", | 25 "ownerDomain": "google.com", |
26 "ownerName": "Google", | 26 "ownerName": "Google", |
27 "parameters": { | 27 "parameters": { |
| 28 "key": { |
| 29 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", |
| 30 "location": "query", |
| 31 "type": "string" |
| 32 }, |
28 "access_token": { | 33 "access_token": { |
29 "description": "OAuth access token.", | 34 "description": "OAuth access token.", |
30 "location": "query", | 35 "location": "query", |
31 "type": "string" | 36 "type": "string" |
32 }, | 37 }, |
33 "key": { | |
34 "description": "API key. Your API key identifies your project and pr
ovides you with API access, quota, and reports. Required unless you provide an O
Auth 2.0 token.", | |
35 "location": "query", | |
36 "type": "string" | |
37 }, | |
38 "quotaUser": { | 38 "quotaUser": { |
39 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", | 39 "description": "Available to use for quota purposes for server-side
applications. Can be any arbitrary string assigned to a user, but should not exc
eed 40 characters.", |
40 "location": "query", | 40 "location": "query", |
41 "type": "string" | 41 "type": "string" |
42 }, | 42 }, |
43 "pp": { | 43 "pp": { |
44 "default": "true", | 44 "default": "true", |
45 "description": "Pretty-print response.", | 45 "description": "Pretty-print response.", |
46 "location": "query", | 46 "location": "query", |
47 "type": "boolean" | 47 "type": "boolean" |
(...skipping 71 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
119 "locations": { | 119 "locations": { |
120 "methods": { | 120 "methods": { |
121 "list": { | 121 "list": { |
122 "description": "Lists information about the supporte
d locations for this service.", | 122 "description": "Lists information about the supporte
d locations for this service.", |
123 "httpMethod": "GET", | 123 "httpMethod": "GET", |
124 "id": "cloudkms.projects.locations.list", | 124 "id": "cloudkms.projects.locations.list", |
125 "parameterOrder": [ | 125 "parameterOrder": [ |
126 "name" | 126 "name" |
127 ], | 127 ], |
128 "parameters": { | 128 "parameters": { |
| 129 "pageSize": { |
| 130 "description": "The standard list page size.
", |
| 131 "format": "int32", |
| 132 "location": "query", |
| 133 "type": "integer" |
| 134 }, |
| 135 "filter": { |
| 136 "description": "The standard list filter.", |
| 137 "location": "query", |
| 138 "type": "string" |
| 139 }, |
129 "name": { | 140 "name": { |
130 "description": "The resource that owns the l
ocations collection, if applicable.", | 141 "description": "The resource that owns the l
ocations collection, if applicable.", |
131 "location": "path", | 142 "location": "path", |
132 "pattern": "^projects/[^/]+$", | 143 "pattern": "^projects/[^/]+$", |
133 "required": true, | 144 "required": true, |
134 "type": "string" | 145 "type": "string" |
135 }, | 146 }, |
136 "pageToken": { | 147 "pageToken": { |
137 "description": "The standard list page token
.", | 148 "description": "The standard list page token
.", |
138 "location": "query", | 149 "location": "query", |
139 "type": "string" | 150 "type": "string" |
140 }, | |
141 "pageSize": { | |
142 "description": "The standard list page size.
", | |
143 "format": "int32", | |
144 "location": "query", | |
145 "type": "integer" | |
146 }, | |
147 "filter": { | |
148 "description": "The standard list filter.", | |
149 "location": "query", | |
150 "type": "string" | |
151 } | 151 } |
152 }, | 152 }, |
153 "path": "v1/{+name}/locations", | 153 "path": "v1/{+name}/locations", |
154 "response": { | 154 "response": { |
155 "$ref": "ListLocationsResponse" | 155 "$ref": "ListLocationsResponse" |
156 }, | 156 }, |
157 "scopes": [ | 157 "scopes": [ |
158 "https://www.googleapis.com/auth/cloud-platform" | 158 "https://www.googleapis.com/auth/cloud-platform" |
159 ] | 159 ] |
160 }, | 160 }, |
(...skipping 18 matching lines...) Expand all Loading... |
179 "$ref": "Location" | 179 "$ref": "Location" |
180 }, | 180 }, |
181 "scopes": [ | 181 "scopes": [ |
182 "https://www.googleapis.com/auth/cloud-platform" | 182 "https://www.googleapis.com/auth/cloud-platform" |
183 ] | 183 ] |
184 } | 184 } |
185 }, | 185 }, |
186 "resources": { | 186 "resources": { |
187 "keyRings": { | 187 "keyRings": { |
188 "methods": { | 188 "methods": { |
| 189 "get": { |
| 190 "description": "Returns metadata for a given
KeyRing.", |
| 191 "httpMethod": "GET", |
| 192 "id": "cloudkms.projects.locations.keyRings.
get", |
| 193 "parameterOrder": [ |
| 194 "name" |
| 195 ], |
| 196 "parameters": { |
| 197 "name": { |
| 198 "description": "The name of the KeyR
ing to get.", |
| 199 "location": "path", |
| 200 "pattern": "^projects/[^/]+/location
s/[^/]+/keyRings/[^/]+$", |
| 201 "required": true, |
| 202 "type": "string" |
| 203 } |
| 204 }, |
| 205 "path": "v1/{+name}", |
| 206 "response": { |
| 207 "$ref": "KeyRing" |
| 208 }, |
| 209 "scopes": [ |
| 210 "https://www.googleapis.com/auth/cloud-p
latform" |
| 211 ] |
| 212 }, |
189 "testIamPermissions": { | 213 "testIamPermissions": { |
190 "description": "Returns permissions that a c
aller has on the specified resource.\nIf the resource does not exist, this will
return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operat
ion is designed to be used for building permission-aware\nUIs and command-line t
ools, not for authorization checking. This operation\nmay \"fail open\" without
warning.", | 214 "description": "Returns permissions that a c
aller has on the specified resource.\nIf the resource does not exist, this will
return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operat
ion is designed to be used for building permission-aware\nUIs and command-line t
ools, not for authorization checking. This operation\nmay \"fail open\" without
warning.", |
191 "httpMethod": "POST", | 215 "httpMethod": "POST", |
192 "id": "cloudkms.projects.locations.keyRings.
testIamPermissions", | 216 "id": "cloudkms.projects.locations.keyRings.
testIamPermissions", |
193 "parameterOrder": [ | 217 "parameterOrder": [ |
194 "resource" | 218 "resource" |
195 ], | 219 ], |
196 "parameters": { | 220 "parameters": { |
197 "resource": { | 221 "resource": { |
198 "description": "REQUIRED: The resour
ce for which the policy detail is being requested.\nSee the operation documentat
ion for the appropriate value for this field.", | 222 "description": "REQUIRED: The resour
ce for which the policy detail is being requested.\nSee the operation documentat
ion for the appropriate value for this field.", |
(...skipping 15 matching lines...) Expand all Loading... |
214 ] | 238 ] |
215 }, | 239 }, |
216 "list": { | 240 "list": { |
217 "description": "Lists KeyRings.", | 241 "description": "Lists KeyRings.", |
218 "httpMethod": "GET", | 242 "httpMethod": "GET", |
219 "id": "cloudkms.projects.locations.keyRings.
list", | 243 "id": "cloudkms.projects.locations.keyRings.
list", |
220 "parameterOrder": [ | 244 "parameterOrder": [ |
221 "parent" | 245 "parent" |
222 ], | 246 ], |
223 "parameters": { | 247 "parameters": { |
224 "parent": { | |
225 "description": "Required. The resour
ce name of the location associated with the\nKeyRings, in the format `projects/*
/locations/*`.", | |
226 "location": "path", | |
227 "pattern": "^projects/[^/]+/location
s/[^/]+$", | |
228 "required": true, | |
229 "type": "string" | |
230 }, | |
231 "pageToken": { | 248 "pageToken": { |
232 "description": "Optional pagination
token, returned earlier via\nListKeyRingsResponse.next_page_token.", | 249 "description": "Optional pagination
token, returned earlier via\nListKeyRingsResponse.next_page_token.", |
233 "location": "query", | 250 "location": "query", |
234 "type": "string" | 251 "type": "string" |
235 }, | 252 }, |
236 "pageSize": { | 253 "pageSize": { |
237 "description": "Optional limit on th
e number of KeyRings to include in the\nresponse. Further KeyRings can subseque
ntly be obtained by\nincluding the ListKeyRingsResponse.next_page_token in a sub
sequent\nrequest. If unspecified, the server will pick an appropriate default."
, | 254 "description": "Optional limit on th
e number of KeyRings to include in the\nresponse. Further KeyRings can subseque
ntly be obtained by\nincluding the ListKeyRingsResponse.next_page_token in a sub
sequent\nrequest. If unspecified, the server will pick an appropriate default."
, |
238 "format": "int32", | 255 "format": "int32", |
239 "location": "query", | 256 "location": "query", |
240 "type": "integer" | 257 "type": "integer" |
| 258 }, |
| 259 "parent": { |
| 260 "description": "Required. The resour
ce name of the location associated with the\nKeyRings, in the format `projects/*
/locations/*`.", |
| 261 "location": "path", |
| 262 "pattern": "^projects/[^/]+/location
s/[^/]+$", |
| 263 "required": true, |
| 264 "type": "string" |
241 } | 265 } |
242 }, | 266 }, |
243 "path": "v1/{+parent}/keyRings", | 267 "path": "v1/{+parent}/keyRings", |
244 "response": { | 268 "response": { |
245 "$ref": "ListKeyRingsResponse" | 269 "$ref": "ListKeyRingsResponse" |
246 }, | 270 }, |
247 "scopes": [ | 271 "scopes": [ |
248 "https://www.googleapis.com/auth/cloud-p
latform" | 272 "https://www.googleapis.com/auth/cloud-p
latform" |
249 ] | 273 ] |
250 }, | 274 }, |
(...skipping 25 matching lines...) Expand all Loading... |
276 ] | 300 ] |
277 }, | 301 }, |
278 "create": { | 302 "create": { |
279 "description": "Create a new KeyRing in a gi
ven Project and Location.", | 303 "description": "Create a new KeyRing in a gi
ven Project and Location.", |
280 "httpMethod": "POST", | 304 "httpMethod": "POST", |
281 "id": "cloudkms.projects.locations.keyRings.
create", | 305 "id": "cloudkms.projects.locations.keyRings.
create", |
282 "parameterOrder": [ | 306 "parameterOrder": [ |
283 "parent" | 307 "parent" |
284 ], | 308 ], |
285 "parameters": { | 309 "parameters": { |
| 310 "keyRingId": { |
| 311 "description": "Required. It must be
unique within a location and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}
`", |
| 312 "location": "query", |
| 313 "type": "string" |
| 314 }, |
286 "parent": { | 315 "parent": { |
287 "description": "Required. The resour
ce name of the location associated with the\nKeyRings, in the format `projects/*
/locations/*`.", | 316 "description": "Required. The resour
ce name of the location associated with the\nKeyRings, in the format `projects/*
/locations/*`.", |
288 "location": "path", | 317 "location": "path", |
289 "pattern": "^projects/[^/]+/location
s/[^/]+$", | 318 "pattern": "^projects/[^/]+/location
s/[^/]+$", |
290 "required": true, | 319 "required": true, |
291 "type": "string" | 320 "type": "string" |
292 }, | |
293 "keyRingId": { | |
294 "description": "Required. It must be
unique within a location and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}
`", | |
295 "location": "query", | |
296 "type": "string" | |
297 } | 321 } |
298 }, | 322 }, |
299 "path": "v1/{+parent}/keyRings", | 323 "path": "v1/{+parent}/keyRings", |
300 "request": { | 324 "request": { |
301 "$ref": "KeyRing" | 325 "$ref": "KeyRing" |
302 }, | 326 }, |
303 "response": { | 327 "response": { |
304 "$ref": "KeyRing" | 328 "$ref": "KeyRing" |
305 }, | 329 }, |
306 "scopes": [ | 330 "scopes": [ |
(...skipping 16 matching lines...) Expand all Loading... |
323 "type": "string" | 347 "type": "string" |
324 } | 348 } |
325 }, | 349 }, |
326 "path": "v1/{+resource}:getIamPolicy", | 350 "path": "v1/{+resource}:getIamPolicy", |
327 "response": { | 351 "response": { |
328 "$ref": "Policy" | 352 "$ref": "Policy" |
329 }, | 353 }, |
330 "scopes": [ | 354 "scopes": [ |
331 "https://www.googleapis.com/auth/cloud-p
latform" | 355 "https://www.googleapis.com/auth/cloud-p
latform" |
332 ] | 356 ] |
333 }, | |
334 "get": { | |
335 "description": "Returns metadata for a given
KeyRing.", | |
336 "httpMethod": "GET", | |
337 "id": "cloudkms.projects.locations.keyRings.
get", | |
338 "parameterOrder": [ | |
339 "name" | |
340 ], | |
341 "parameters": { | |
342 "name": { | |
343 "description": "The name of the KeyR
ing to get.", | |
344 "location": "path", | |
345 "pattern": "^projects/[^/]+/location
s/[^/]+/keyRings/[^/]+$", | |
346 "required": true, | |
347 "type": "string" | |
348 } | |
349 }, | |
350 "path": "v1/{+name}", | |
351 "response": { | |
352 "$ref": "KeyRing" | |
353 }, | |
354 "scopes": [ | |
355 "https://www.googleapis.com/auth/cloud-p
latform" | |
356 ] | |
357 } | 357 } |
358 }, | 358 }, |
359 "resources": { | 359 "resources": { |
360 "cryptoKeys": { | 360 "cryptoKeys": { |
361 "methods": { | 361 "methods": { |
362 "testIamPermissions": { | 362 "testIamPermissions": { |
363 "description": "Returns permissions
that a caller has on the specified resource.\nIf the resource does not exist, th
is will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: Thi
s operation is designed to be used for building permission-aware\nUIs and comman
d-line tools, not for authorization checking. This operation\nmay \"fail open\"
without warning.", | 363 "description": "Returns permissions
that a caller has on the specified resource.\nIf the resource does not exist, th
is will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: Thi
s operation is designed to be used for building permission-aware\nUIs and comman
d-line tools, not for authorization checking. This operation\nmay \"fail open\"
without warning.", |
364 "httpMethod": "POST", | 364 "httpMethod": "POST", |
365 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.testIamPermissions", | 365 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.testIamPermissions", |
366 "parameterOrder": [ | 366 "parameterOrder": [ |
(...skipping 13 matching lines...) Expand all Loading... |
380 "$ref": "TestIamPermissionsReque
st" | 380 "$ref": "TestIamPermissionsReque
st" |
381 }, | 381 }, |
382 "response": { | 382 "response": { |
383 "$ref": "TestIamPermissionsRespo
nse" | 383 "$ref": "TestIamPermissionsRespo
nse" |
384 }, | 384 }, |
385 "scopes": [ | 385 "scopes": [ |
386 "https://www.googleapis.com/auth
/cloud-platform" | 386 "https://www.googleapis.com/auth
/cloud-platform" |
387 ] | 387 ] |
388 }, | 388 }, |
389 "decrypt": { | 389 "decrypt": { |
390 "description": "Decrypt data that wa
s protected by Encrypt.", | 390 "description": "Decrypts data that w
as protected by Encrypt.", |
391 "httpMethod": "POST", | 391 "httpMethod": "POST", |
392 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.decrypt", | 392 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.decrypt", |
393 "parameterOrder": [ | 393 "parameterOrder": [ |
394 "name" | 394 "name" |
395 ], | 395 ], |
396 "parameters": { | 396 "parameters": { |
397 "name": { | 397 "name": { |
398 "description": "Required. Th
e resource name of the CryptoKey to use for decryption.\nThe server will choose
the appropriate version.", | 398 "description": "Required. Th
e resource name of the CryptoKey to use for decryption.\nThe server will choose
the appropriate version.", |
399 "location": "path", | 399 "location": "path", |
400 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", | 400 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", |
(...skipping 13 matching lines...) Expand all Loading... |
414 ] | 414 ] |
415 }, | 415 }, |
416 "list": { | 416 "list": { |
417 "description": "Lists CryptoKeys.", | 417 "description": "Lists CryptoKeys.", |
418 "httpMethod": "GET", | 418 "httpMethod": "GET", |
419 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.list", | 419 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.list", |
420 "parameterOrder": [ | 420 "parameterOrder": [ |
421 "parent" | 421 "parent" |
422 ], | 422 ], |
423 "parameters": { | 423 "parameters": { |
| 424 "pageSize": { |
| 425 "description": "Optional lim
it on the number of CryptoKeys to include in the\nresponse. Further CryptoKeys
can subsequently be obtained by\nincluding the ListCryptoKeysResponse.next_page_
token in a subsequent\nrequest. If unspecified, the server will pick an appropr
iate default.", |
| 426 "format": "int32", |
| 427 "location": "query", |
| 428 "type": "integer" |
| 429 }, |
424 "parent": { | 430 "parent": { |
425 "description": "Required. Th
e resource name of the KeyRing to list, in the format\n`projects/*/locations/*/k
eyRings/*`.", | 431 "description": "Required. Th
e resource name of the KeyRing to list, in the format\n`projects/*/locations/*/k
eyRings/*`.", |
426 "location": "path", | 432 "location": "path", |
427 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+$", | 433 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+$", |
428 "required": true, | 434 "required": true, |
429 "type": "string" | 435 "type": "string" |
430 }, | 436 }, |
431 "pageToken": { | 437 "pageToken": { |
432 "description": "Optional pag
ination token, returned earlier via\nListCryptoKeysResponse.next_page_token.", | 438 "description": "Optional pag
ination token, returned earlier via\nListCryptoKeysResponse.next_page_token.", |
433 "location": "query", | 439 "location": "query", |
434 "type": "string" | 440 "type": "string" |
435 }, | |
436 "pageSize": { | |
437 "description": "Optional lim
it on the number of CryptoKeys to include in the\nresponse. Further CryptoKeys
can subsequently be obtained by\nincluding the ListCryptoKeysResponse.next_page_
token in a subsequent\nrequest. If unspecified, the server will pick an appropr
iate default.", | |
438 "format": "int32", | |
439 "location": "query", | |
440 "type": "integer" | |
441 } | 441 } |
442 }, | 442 }, |
443 "path": "v1/{+parent}/cryptoKeys", | 443 "path": "v1/{+parent}/cryptoKeys", |
444 "response": { | 444 "response": { |
445 "$ref": "ListCryptoKeysResponse" | 445 "$ref": "ListCryptoKeysResponse" |
446 }, | 446 }, |
447 "scopes": [ | 447 "scopes": [ |
448 "https://www.googleapis.com/auth
/cloud-platform" | 448 "https://www.googleapis.com/auth
/cloud-platform" |
449 ] | 449 ] |
450 }, | 450 }, |
451 "encrypt": { | 451 "encrypt": { |
452 "description": "Encrypt data, so tha
t it can only be recovered by a call to Decrypt.", | 452 "description": "Encrypts data, so th
at it can only be recovered by a call to Decrypt.", |
453 "httpMethod": "POST", | 453 "httpMethod": "POST", |
454 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.encrypt", | 454 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.encrypt", |
455 "parameterOrder": [ | 455 "parameterOrder": [ |
456 "name" | 456 "name" |
457 ], | 457 ], |
458 "parameters": { | 458 "parameters": { |
459 "name": { | 459 "name": { |
460 "description": "Required. Th
e resource name of the CryptoKey or CryptoKeyVersion\nto use for encryption.\n\n
If a CryptoKey is specified, the server will use its\nprimary version.", | 460 "description": "Required. Th
e resource name of the CryptoKey or CryptoKeyVersion\nto use for encryption.\n\n
If a CryptoKey is specified, the server will use its\nprimary version.", |
461 "location": "path", | 461 "location": "path", |
462 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/.+$", | 462 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/.+$", |
(...skipping 13 matching lines...) Expand all Loading... |
476 ] | 476 ] |
477 }, | 477 }, |
478 "create": { | 478 "create": { |
479 "description": "Create a new CryptoK
ey within a KeyRing.\n\nCryptoKey.purpose is required.", | 479 "description": "Create a new CryptoK
ey within a KeyRing.\n\nCryptoKey.purpose is required.", |
480 "httpMethod": "POST", | 480 "httpMethod": "POST", |
481 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.create", | 481 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.create", |
482 "parameterOrder": [ | 482 "parameterOrder": [ |
483 "parent" | 483 "parent" |
484 ], | 484 ], |
485 "parameters": { | 485 "parameters": { |
| 486 "cryptoKeyId": { |
| 487 "description": "Required. It
must be unique within a KeyRing and match the regular\nexpression `[a-zA-Z0-9_-
]{1,63}`", |
| 488 "location": "query", |
| 489 "type": "string" |
| 490 }, |
486 "parent": { | 491 "parent": { |
487 "description": "Required. Th
e name of the KeyRing associated with the\nCryptoKeys.", | 492 "description": "Required. Th
e name of the KeyRing associated with the\nCryptoKeys.", |
488 "location": "path", | 493 "location": "path", |
489 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+$", | 494 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+$", |
490 "required": true, | 495 "required": true, |
491 "type": "string" | 496 "type": "string" |
492 }, | |
493 "cryptoKeyId": { | |
494 "description": "Required. It
must be unique within a KeyRing and match the regular\nexpression `[a-zA-Z0-9_-
]{1,63}`", | |
495 "location": "query", | |
496 "type": "string" | |
497 } | 497 } |
498 }, | 498 }, |
499 "path": "v1/{+parent}/cryptoKeys", | 499 "path": "v1/{+parent}/cryptoKeys", |
500 "request": { | 500 "request": { |
501 "$ref": "CryptoKey" | 501 "$ref": "CryptoKey" |
502 }, | 502 }, |
503 "response": { | 503 "response": { |
504 "$ref": "CryptoKey" | 504 "$ref": "CryptoKey" |
505 }, | 505 }, |
506 "scopes": [ | 506 "scopes": [ |
(...skipping 132 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
639 "$ref": "CryptoKey" | 639 "$ref": "CryptoKey" |
640 }, | 640 }, |
641 "scopes": [ | 641 "scopes": [ |
642 "https://www.googleapis.com/auth
/cloud-platform" | 642 "https://www.googleapis.com/auth
/cloud-platform" |
643 ] | 643 ] |
644 } | 644 } |
645 }, | 645 }, |
646 "resources": { | 646 "resources": { |
647 "cryptoKeyVersions": { | 647 "cryptoKeyVersions": { |
648 "methods": { | 648 "methods": { |
649 "restore": { | 649 "list": { |
650 "description": "Restore a Cr
yptoKeyVersion in the\nDESTROY_SCHEDULED,\nstate.\n\nUpon restoration of the Cry
ptoKeyVersion, state\nwill be set to DISABLED,\nand destroy_time will be cleared
.", | 650 "description": "Lists Crypto
KeyVersions.", |
651 "httpMethod": "POST", | 651 "httpMethod": "GET", |
652 "id": "cloudkms.projects.loc
ations.keyRings.cryptoKeys.cryptoKeyVersions.restore", | 652 "id": "cloudkms.projects.loc
ations.keyRings.cryptoKeys.cryptoKeyVersions.list", |
653 "parameterOrder": [ | 653 "parameterOrder": [ |
654 "name" | 654 "parent" |
655 ], | 655 ], |
656 "parameters": { | 656 "parameters": { |
657 "name": { | 657 "pageToken": { |
658 "description": "The
resource name of the CryptoKeyVersion to restore.", | 658 "description": "Opti
onal pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_
page_token.", |
| 659 "location": "query", |
| 660 "type": "string" |
| 661 }, |
| 662 "pageSize": { |
| 663 "description": "Opti
onal limit on the number of CryptoKeyVersions to\ninclude in the response. Furth
er CryptoKeyVersions can\nsubsequently be obtained by including the\nListCryptoK
eyVersionsResponse.next_page_token in a subsequent request.\nIf unspecified, the
server will pick an appropriate default.", |
| 664 "format": "int32", |
| 665 "location": "query", |
| 666 "type": "integer" |
| 667 }, |
| 668 "parent": { |
| 669 "description": "Requ
ired. The resource name of the CryptoKey to list, in the format\n`projects/*/loc
ations/*/keyRings/*/cryptoKeys/*`.", |
659 "location": "path", | 670 "location": "path", |
660 "pattern": "^project
s/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$
", | 671 "pattern": "^project
s/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", |
661 "required": true, | 672 "required": true, |
662 "type": "string" | 673 "type": "string" |
663 } | 674 } |
664 }, | 675 }, |
665 "path": "v1/{+name}:restore"
, | 676 "path": "v1/{+parent}/crypto
KeyVersions", |
666 "request": { | |
667 "$ref": "RestoreCryptoKe
yVersionRequest" | |
668 }, | |
669 "response": { | 677 "response": { |
670 "$ref": "CryptoKeyVersio
n" | 678 "$ref": "ListCryptoKeyVe
rsionsResponse" |
671 }, | 679 }, |
672 "scopes": [ | 680 "scopes": [ |
673 "https://www.googleapis.
com/auth/cloud-platform" | 681 "https://www.googleapis.
com/auth/cloud-platform" |
674 ] | 682 ] |
675 }, | 683 }, |
676 "patch": { | 684 "create": { |
677 "description": "Update a Cry
ptoKeyVersion's metadata.\n\nstate may be changed between\nENABLED and\nDISABLED
using this\nmethod. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to\
nmove between other states.", | 685 "description": "Create a new
CryptoKeyVersion in a CryptoKey.\n\nThe server will assign the next sequential
id. If unset,\nstate will be set to\nENABLED.", |
678 "httpMethod": "PATCH", | 686 "httpMethod": "POST", |
679 "id": "cloudkms.projects.loc
ations.keyRings.cryptoKeys.cryptoKeyVersions.patch", | 687 "id": "cloudkms.projects.loc
ations.keyRings.cryptoKeys.cryptoKeyVersions.create", |
680 "parameterOrder": [ | 688 "parameterOrder": [ |
681 "name" | 689 "parent" |
682 ], | 690 ], |
683 "parameters": { | 691 "parameters": { |
684 "updateMask": { | 692 "parent": { |
685 "description": "Requ
ired list of fields to be updated in this request.", | 693 "description": "Requ
ired. The name of the CryptoKey associated with\nthe CryptoKeyVersions.", |
686 "format": "google-fi
eldmask", | |
687 "location": "query", | |
688 "type": "string" | |
689 }, | |
690 "name": { | |
691 "description": "Outp
ut only. The resource name for this CryptoKeyVersion in the format\n`projects/*/
locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.", | |
692 "location": "path", | 694 "location": "path", |
693 "pattern": "^project
s/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$
", | 695 "pattern": "^project
s/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", |
694 "required": true, | 696 "required": true, |
695 "type": "string" | 697 "type": "string" |
696 } | 698 } |
697 }, | 699 }, |
698 "path": "v1/{+name}", | 700 "path": "v1/{+parent}/crypto
KeyVersions", |
699 "request": { | 701 "request": { |
700 "$ref": "CryptoKeyVersio
n" | 702 "$ref": "CryptoKeyVersio
n" |
701 }, | 703 }, |
702 "response": { | 704 "response": { |
703 "$ref": "CryptoKeyVersio
n" | 705 "$ref": "CryptoKeyVersio
n" |
704 }, | 706 }, |
705 "scopes": [ | 707 "scopes": [ |
706 "https://www.googleapis.
com/auth/cloud-platform" | 708 "https://www.googleapis.
com/auth/cloud-platform" |
707 ] | 709 ] |
708 }, | 710 }, |
709 "get": { | 711 "destroy": { |
710 "description": "Returns meta
data for a given CryptoKeyVersion.", | 712 "description": "Schedule a C
ryptoKeyVersion for destruction.\n\nUpon calling this method, CryptoKeyVersion.s
tate will be set to\nDESTROY_SCHEDULED\nand destroy_time will be set to a time 2
4\nhours in the future, at which point the state\nwill be changed to\nDESTROYED,
and the key\nmaterial will be irrevocably destroyed.\n\nBefore the destroy_time
is reached,\nRestoreCryptoKeyVersion may be called to reverse the process.", |
711 "httpMethod": "GET", | 713 "httpMethod": "POST", |
712 "id": "cloudkms.projects.loc
ations.keyRings.cryptoKeys.cryptoKeyVersions.get", | 714 "id": "cloudkms.projects.loc
ations.keyRings.cryptoKeys.cryptoKeyVersions.destroy", |
713 "parameterOrder": [ | 715 "parameterOrder": [ |
714 "name" | 716 "name" |
715 ], | 717 ], |
716 "parameters": { | 718 "parameters": { |
717 "name": { | 719 "name": { |
718 "description": "The
name of the CryptoKeyVersion to get.", | 720 "description": "The
resource name of the CryptoKeyVersion to destroy.", |
719 "location": "path", | 721 "location": "path", |
720 "pattern": "^project
s/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$
", | 722 "pattern": "^project
s/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$
", |
721 "required": true, | 723 "required": true, |
722 "type": "string" | 724 "type": "string" |
723 } | 725 } |
724 }, | 726 }, |
725 "path": "v1/{+name}", | 727 "path": "v1/{+name}:destroy"
, |
| 728 "request": { |
| 729 "$ref": "DestroyCryptoKe
yVersionRequest" |
| 730 }, |
726 "response": { | 731 "response": { |
727 "$ref": "CryptoKeyVersio
n" | 732 "$ref": "CryptoKeyVersio
n" |
728 }, | 733 }, |
729 "scopes": [ | 734 "scopes": [ |
730 "https://www.googleapis.
com/auth/cloud-platform" | 735 "https://www.googleapis.
com/auth/cloud-platform" |
731 ] | 736 ] |
732 }, | 737 }, |
733 "list": { | 738 "restore": { |
734 "description": "Lists Crypto
KeyVersions.", | 739 "description": "Restore a Cr
yptoKeyVersion in the\nDESTROY_SCHEDULED,\nstate.\n\nUpon restoration of the Cry
ptoKeyVersion, state\nwill be set to DISABLED,\nand destroy_time will be cleared
.", |
735 "httpMethod": "GET", | |
736 "id": "cloudkms.projects.loc
ations.keyRings.cryptoKeys.cryptoKeyVersions.list", | |
737 "parameterOrder": [ | |
738 "parent" | |
739 ], | |
740 "parameters": { | |
741 "pageToken": { | |
742 "description": "Opti
onal pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_
page_token.", | |
743 "location": "query", | |
744 "type": "string" | |
745 }, | |
746 "pageSize": { | |
747 "description": "Opti
onal limit on the number of CryptoKeyVersions to\ninclude in the response. Furth
er CryptoKeyVersions can\nsubsequently be obtained by including the\nListCryptoK
eyVersionsResponse.next_page_token in a subsequent request.\nIf unspecified, the
server will pick an appropriate default.", | |
748 "format": "int32", | |
749 "location": "query", | |
750 "type": "integer" | |
751 }, | |
752 "parent": { | |
753 "description": "Requ
ired. The resource name of the CryptoKey to list, in the format\n`projects/*/loc
ations/*/keyRings/*/cryptoKeys/*`.", | |
754 "location": "path", | |
755 "pattern": "^project
s/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", | |
756 "required": true, | |
757 "type": "string" | |
758 } | |
759 }, | |
760 "path": "v1/{+parent}/crypto
KeyVersions", | |
761 "response": { | |
762 "$ref": "ListCryptoKeyVe
rsionsResponse" | |
763 }, | |
764 "scopes": [ | |
765 "https://www.googleapis.
com/auth/cloud-platform" | |
766 ] | |
767 }, | |
768 "destroy": { | |
769 "description": "Schedule a C
ryptoKeyVersion for destruction.\n\nUpon calling this method, CryptoKeyVersion.s
tate will be set to\nDESTROY_SCHEDULED\nand destroy_time will be set to a time 2
4\nhours in the future, at which point the state\nwill be changed to\nDESTROYED,
and the key\nmaterial will be irrevocably destroyed.\n\nBefore the destroy_time
is reached,\nRestoreCryptoKeyVersion may be called to reverse the process.", | |
770 "httpMethod": "POST", | 740 "httpMethod": "POST", |
771 "id": "cloudkms.projects.loc
ations.keyRings.cryptoKeys.cryptoKeyVersions.destroy", | 741 "id": "cloudkms.projects.loc
ations.keyRings.cryptoKeys.cryptoKeyVersions.restore", |
772 "parameterOrder": [ | 742 "parameterOrder": [ |
773 "name" | 743 "name" |
774 ], | 744 ], |
775 "parameters": { | 745 "parameters": { |
776 "name": { | 746 "name": { |
777 "description": "The
resource name of the CryptoKeyVersion to destroy.", | 747 "description": "The
resource name of the CryptoKeyVersion to restore.", |
778 "location": "path", | 748 "location": "path", |
779 "pattern": "^project
s/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$
", | 749 "pattern": "^project
s/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$
", |
780 "required": true, | 750 "required": true, |
781 "type": "string" | 751 "type": "string" |
782 } | 752 } |
783 }, | 753 }, |
784 "path": "v1/{+name}:destroy"
, | 754 "path": "v1/{+name}:restore"
, |
785 "request": { | 755 "request": { |
786 "$ref": "DestroyCryptoKe
yVersionRequest" | 756 "$ref": "RestoreCryptoKe
yVersionRequest" |
787 }, | 757 }, |
788 "response": { | 758 "response": { |
789 "$ref": "CryptoKeyVersio
n" | 759 "$ref": "CryptoKeyVersio
n" |
790 }, | 760 }, |
| 761 "scopes": [ |
| 762 "https://www.googleapis.
com/auth/cloud-platform" |
| 763 ] |
| 764 }, |
| 765 "get": { |
| 766 "description": "Returns meta
data for a given CryptoKeyVersion.", |
| 767 "httpMethod": "GET", |
| 768 "id": "cloudkms.projects.loc
ations.keyRings.cryptoKeys.cryptoKeyVersions.get", |
| 769 "parameterOrder": [ |
| 770 "name" |
| 771 ], |
| 772 "parameters": { |
| 773 "name": { |
| 774 "description": "The
name of the CryptoKeyVersion to get.", |
| 775 "location": "path", |
| 776 "pattern": "^project
s/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$
", |
| 777 "required": true, |
| 778 "type": "string" |
| 779 } |
| 780 }, |
| 781 "path": "v1/{+name}", |
| 782 "response": { |
| 783 "$ref": "CryptoKeyVersio
n" |
| 784 }, |
791 "scopes": [ | 785 "scopes": [ |
792 "https://www.googleapis.
com/auth/cloud-platform" | 786 "https://www.googleapis.
com/auth/cloud-platform" |
793 ] | 787 ] |
794 }, | 788 }, |
795 "create": { | 789 "patch": { |
796 "description": "Create a new
CryptoKeyVersion in a CryptoKey.\n\nThe server will assign the next sequential
id. If unset,\nstate will be set to\nENABLED.", | 790 "description": "Update a Cry
ptoKeyVersion's metadata.\n\nstate may be changed between\nENABLED and\nDISABLED
using this\nmethod. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to\
nmove between other states.", |
797 "httpMethod": "POST", | 791 "httpMethod": "PATCH", |
798 "id": "cloudkms.projects.loc
ations.keyRings.cryptoKeys.cryptoKeyVersions.create", | 792 "id": "cloudkms.projects.loc
ations.keyRings.cryptoKeys.cryptoKeyVersions.patch", |
799 "parameterOrder": [ | 793 "parameterOrder": [ |
800 "parent" | 794 "name" |
801 ], | 795 ], |
802 "parameters": { | 796 "parameters": { |
803 "parent": { | 797 "updateMask": { |
804 "description": "Requ
ired. The name of the CryptoKey associated with\nthe CryptoKeyVersions.", | 798 "description": "Requ
ired list of fields to be updated in this request.", |
| 799 "format": "google-fi
eldmask", |
| 800 "location": "query", |
| 801 "type": "string" |
| 802 }, |
| 803 "name": { |
| 804 "description": "Outp
ut only. The resource name for this CryptoKeyVersion in the format\n`projects/*/
locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.", |
805 "location": "path", | 805 "location": "path", |
806 "pattern": "^project
s/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", | 806 "pattern": "^project
s/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$
", |
807 "required": true, | 807 "required": true, |
808 "type": "string" | 808 "type": "string" |
809 } | 809 } |
810 }, | 810 }, |
811 "path": "v1/{+parent}/crypto
KeyVersions", | 811 "path": "v1/{+name}", |
812 "request": { | 812 "request": { |
813 "$ref": "CryptoKeyVersio
n" | 813 "$ref": "CryptoKeyVersio
n" |
814 }, | 814 }, |
815 "response": { | 815 "response": { |
816 "$ref": "CryptoKeyVersio
n" | 816 "$ref": "CryptoKeyVersio
n" |
817 }, | 817 }, |
818 "scopes": [ | 818 "scopes": [ |
819 "https://www.googleapis.
com/auth/cloud-platform" | 819 "https://www.googleapis.
com/auth/cloud-platform" |
820 ] | 820 ] |
821 } | 821 } |
822 } | 822 } |
823 } | 823 } |
824 } | 824 } |
825 } | 825 } |
826 } | 826 } |
827 } | 827 } |
828 } | 828 } |
829 } | 829 } |
830 } | 830 } |
831 } | 831 } |
832 }, | 832 }, |
833 "revision": "20170515", | 833 "revision": "20170530", |
834 "rootUrl": "https://cloudkms.googleapis.com/", | 834 "rootUrl": "https://cloudkms.googleapis.com/", |
835 "schemas": { | 835 "schemas": { |
836 "AuditConfig": { | 836 "Expr": { |
837 "description": "Specifies the audit configuration for a service.\nTh
e configuration determines which permission types are logged, and what\nidentiti
es, if any, are exempted from logging.\nAn AuditConfig must have one or more Aud
itLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific
service,\nthe union of the two AuditConfigs is used for that service: the log_t
ypes\nspecified in each AuditConfig are enabled, and the exempted_members in eac
h\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n
{\n \"audit_configs\": [\n {\n \"service\": \"allServices
\"\n \"audit_log_configs\": [\n {\n \"log_type\
": \"DATA_READ\",\n \"exempted_members\": [\n \"user
:foo@gmail.com\"\n ]\n },\n {\n
\"log_type\": \"DATA_WRITE\",\n },\n {\n \"lo
g_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n
\"service\": \"fooservice.googleapis.com\"\n \"audit_log_config
s\": [\n {\n \"log_type\": \"DATA_READ\",\n }
,\n {\n \"log_type\": \"DATA_WRITE\",\n \"e
xempted_members\": [\n \"user:bar@gmail.com\"\n ]\n
}\n ]\n }\n ]\n }\n\nFor fooservice, this pol
icy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@g
mail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.", | 837 "description": "Represents an expression text. Example:\n\n title
: \"User account presence\"\n description: \"Determines whether the request h
as a user account\"\n expression: \"size(request.user) > 0\"", |
838 "id": "AuditConfig", | 838 "id": "Expr", |
839 "properties": { | 839 "properties": { |
840 "exemptedMembers": { | 840 "description": { |
841 "items": { | 841 "description": "An optional description of the expression. T
his is a longer text which\ndescribes the expression, e.g. when hovered over it
in a UI.", |
842 "type": "string" | |
843 }, | |
844 "type": "array" | |
845 }, | |
846 "service": { | |
847 "description": "Specifies a service that will be enabled for
audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com
`.\n`allServices` is a special value that covers all services.", | |
848 "type": "string" | 842 "type": "string" |
849 }, | 843 }, |
850 "auditLogConfigs": { | 844 "expression": { |
851 "description": "The configuration for logging of each type o
f permission.\nNext ID: 4", | 845 "description": "Textual representation of an expression in\n
[Common Expression Language](http://go/api-expr) syntax.\n\nThe application cont
ext of the containing message determines which\nwell-known feature set of CEL is
supported.", |
852 "items": { | |
853 "$ref": "AuditLogConfig" | |
854 }, | |
855 "type": "array" | |
856 } | |
857 }, | |
858 "type": "object" | |
859 }, | |
860 "CryptoKeyVersion": { | |
861 "description": "A CryptoKeyVersion represents an individual cryptogr
aphic key, and the\nassociated key material.\n\nIt can be used for cryptographic
operations either directly, or via its\nparent CryptoKey, in which case the ser
ver will choose the appropriate\nversion for the operation.", | |
862 "id": "CryptoKeyVersion", | |
863 "properties": { | |
864 "createTime": { | |
865 "description": "Output only. The time at which this CryptoKe
yVersion was created.", | |
866 "format": "google-datetime", | |
867 "type": "string" | 846 "type": "string" |
868 }, | 847 }, |
869 "state": { | 848 "title": { |
870 "description": "The current state of the CryptoKeyVersion.", | 849 "description": "An optional title for the expression, i.e. a
short string describing\nits purpose. This can be used e.g. in UIs which allow
to enter the\nexpression.", |
871 "enum": [ | |
872 "CRYPTO_KEY_VERSION_STATE_UNSPECIFIED", | |
873 "ENABLED", | |
874 "DISABLED", | |
875 "DESTROYED", | |
876 "DESTROY_SCHEDULED" | |
877 ], | |
878 "enumDescriptions": [ | |
879 "Not specified.", | |
880 "This version may be used in Encrypt and\nDecrypt reques
ts.", | |
881 "This version may not be used, but the key material is s
till available,\nand the version can be placed back into the ENABLED state.", | |
882 "This version is destroyed, and the key material is no l
onger stored.\nA version may not leave this state once entered.", | |
883 "This version is scheduled for destruction, and will be
destroyed soon.\nCall\nRestoreCryptoKeyVersion\nto put it back into the DISABLED
state." | |
884 ], | |
885 "type": "string" | 850 "type": "string" |
886 }, | 851 }, |
887 "name": { | 852 "location": { |
888 "description": "Output only. The resource name for this Cryp
toKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryp
toKeyVersions/*`.", | 853 "description": "An optional string indicating the location o
f the expression for error\nreporting, e.g. a file name and a position in the fi
le.", |
889 "type": "string" | |
890 }, | |
891 "destroyEventTime": { | |
892 "description": "Output only. The time this CryptoKeyVersion'
s key material was\ndestroyed. Only present if state is\nDESTROYED.", | |
893 "format": "google-datetime", | |
894 "type": "string" | |
895 }, | |
896 "destroyTime": { | |
897 "description": "Output only. The time this CryptoKeyVersion'
s key material is scheduled\nfor destruction. Only present if state is\nDESTROY_
SCHEDULED.", | |
898 "format": "google-datetime", | |
899 "type": "string" | 854 "type": "string" |
900 } | 855 } |
901 }, | 856 }, |
902 "type": "object" | |
903 }, | |
904 "CloudAuditOptions": { | |
905 "description": "Write a Cloud Audit log", | |
906 "id": "CloudAuditOptions", | |
907 "properties": { | |
908 "logName": { | |
909 "description": "The log_name to populate in the Cloud Audit
Record.", | |
910 "enum": [ | |
911 "UNSPECIFIED_LOG_NAME", | |
912 "ADMIN_ACTIVITY", | |
913 "DATA_ACCESS" | |
914 ], | |
915 "enumDescriptions": [ | |
916 "Default. Should not be used.", | |
917 "Corresponds to \"cloudaudit.googleapis.com/activity\"", | |
918 "Corresponds to \"cloudaudit.googleapis.com/data_access\
"" | |
919 ], | |
920 "type": "string" | |
921 } | |
922 }, | |
923 "type": "object" | |
924 }, | |
925 "Binding": { | |
926 "description": "Associates `members` with a `role`.", | |
927 "id": "Binding", | |
928 "properties": { | |
929 "members": { | |
930 "description": "Specifies the identities requesting access f
or a Cloud Platform resource.\n`members` can have the following values:\n\n* `al
lUsers`: A special identifier that represents anyone who is\n on the internet;
with or without a Google account.\n\n* `allAuthenticatedUsers`: A special ident
ifier that represents anyone\n who is authenticated with a Google account or a
service account.\n\n* `user:{emailid}`: An email address that represents a spec
ific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\
n\n* `serviceAccount:{emailid}`: An email address that represents a service\n
account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{e
mailid}`: An email address that represents a Google group.\n For example, `adm
ins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that repre
sents all the\n users of that domain. For example, `google.com` or `example.co
m`.\n\n", | |
931 "items": { | |
932 "type": "string" | |
933 }, | |
934 "type": "array" | |
935 }, | |
936 "role": { | |
937 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", | |
938 "type": "string" | |
939 } | |
940 }, | |
941 "type": "object" | 857 "type": "object" |
942 }, | 858 }, |
943 "EncryptRequest": { | 859 "EncryptRequest": { |
944 "description": "Request message for KeyManagementService.Encrypt.", | 860 "description": "Request message for KeyManagementService.Encrypt.", |
945 "id": "EncryptRequest", | 861 "id": "EncryptRequest", |
946 "properties": { | 862 "properties": { |
| 863 "additionalAuthenticatedData": { |
| 864 "description": "Optional data that, if specified, must also
be provided during decryption\nthrough DecryptRequest.additional_authenticated_d
ata. Must be no\nlarger than 64KiB.", |
| 865 "format": "byte", |
| 866 "type": "string" |
| 867 }, |
947 "plaintext": { | 868 "plaintext": { |
948 "description": "Required. The data to encrypt. Must be no la
rger than 64KiB.", | 869 "description": "Required. The data to encrypt. Must be no la
rger than 64KiB.", |
949 "format": "byte", | 870 "format": "byte", |
950 "type": "string" | 871 "type": "string" |
951 }, | |
952 "additionalAuthenticatedData": { | |
953 "description": "Optional data that, if specified, must also
be provided during decryption\nthrough DecryptRequest.additional_authenticated_d
ata. Must be no\nlarger than 64KiB.", | |
954 "format": "byte", | |
955 "type": "string" | |
956 } | 872 } |
957 }, | 873 }, |
958 "type": "object" | 874 "type": "object" |
959 }, | 875 }, |
960 "ListCryptoKeyVersionsResponse": { | 876 "ListCryptoKeyVersionsResponse": { |
961 "description": "Response message for KeyManagementService.ListCrypto
KeyVersions.", | 877 "description": "Response message for KeyManagementService.ListCrypto
KeyVersions.", |
962 "id": "ListCryptoKeyVersionsResponse", | 878 "id": "ListCryptoKeyVersionsResponse", |
963 "properties": { | 879 "properties": { |
964 "cryptoKeyVersions": { | 880 "cryptoKeyVersions": { |
965 "description": "The list of CryptoKeyVersions.", | 881 "description": "The list of CryptoKeyVersions.", |
(...skipping 97 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1063 ], | 979 ], |
1064 "type": "string" | 980 "type": "string" |
1065 } | 981 } |
1066 }, | 982 }, |
1067 "type": "object" | 983 "type": "object" |
1068 }, | 984 }, |
1069 "CryptoKey": { | 985 "CryptoKey": { |
1070 "description": "A CryptoKey represents a logical key that can be use
d for cryptographic\noperations.\n\nA CryptoKey is made up of one or more versio
ns, which\nrepresent the actual key material used in cryptographic operations.", | 986 "description": "A CryptoKey represents a logical key that can be use
d for cryptographic\noperations.\n\nA CryptoKey is made up of one or more versio
ns, which\nrepresent the actual key material used in cryptographic operations.", |
1071 "id": "CryptoKey", | 987 "id": "CryptoKey", |
1072 "properties": { | 988 "properties": { |
1073 "purpose": { | |
1074 "description": "The immutable purpose of this CryptoKey. Cur
rently, the only acceptable\npurpose is ENCRYPT_DECRYPT.", | |
1075 "enum": [ | |
1076 "CRYPTO_KEY_PURPOSE_UNSPECIFIED", | |
1077 "ENCRYPT_DECRYPT" | |
1078 ], | |
1079 "enumDescriptions": [ | |
1080 "Not specified.", | |
1081 "CryptoKeys with this purpose may be used with\nEncrypt
and\nDecrypt." | |
1082 ], | |
1083 "type": "string" | |
1084 }, | |
1085 "nextRotationTime": { | |
1086 "description": "At next_rotation_time, the Key Management Se
rvice will automatically:\n\n1. Create a new version of this CryptoKey.\n2. Mark
the new version as primary.\n\nKey rotations performed manually via\nCreateCryp
toKeyVersion and\nUpdateCryptoKeyPrimaryVersion\ndo not affect next_rotation_tim
e.", | |
1087 "format": "google-datetime", | |
1088 "type": "string" | |
1089 }, | |
1090 "createTime": { | 989 "createTime": { |
1091 "description": "Output only. The time at which this CryptoKe
y was created.", | 990 "description": "Output only. The time at which this CryptoKe
y was created.", |
1092 "format": "google-datetime", | 991 "format": "google-datetime", |
1093 "type": "string" | 992 "type": "string" |
1094 }, | 993 }, |
1095 "rotationPeriod": { | 994 "rotationPeriod": { |
1096 "description": "next_rotation_time will be advanced by this
period when the service\nautomatically rotates a key. Must be at least one day.\
n\nIf rotation_period is set, next_rotation_time must also be set.", | 995 "description": "next_rotation_time will be advanced by this
period when the service\nautomatically rotates a key. Must be at least one day.\
n\nIf rotation_period is set, next_rotation_time must also be set.", |
1097 "format": "google-duration", | 996 "format": "google-duration", |
1098 "type": "string" | 997 "type": "string" |
1099 }, | 998 }, |
1100 "primary": { | 999 "primary": { |
1101 "$ref": "CryptoKeyVersion", | 1000 "$ref": "CryptoKeyVersion", |
1102 "description": "Output only. A copy of the \"primary\" Crypt
oKeyVersion that will be used\nby Encrypt when this CryptoKey is given\nin Encry
ptRequest.name.\n\nThe CryptoKey's primary version can be updated via\nUpdateCry
ptoKeyPrimaryVersion." | 1001 "description": "Output only. A copy of the \"primary\" Crypt
oKeyVersion that will be used\nby Encrypt when this CryptoKey is given\nin Encry
ptRequest.name.\n\nThe CryptoKey's primary version can be updated via\nUpdateCry
ptoKeyPrimaryVersion." |
1103 }, | 1002 }, |
1104 "name": { | 1003 "name": { |
1105 "description": "Output only. The resource name for this Cryp
toKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.", | 1004 "description": "Output only. The resource name for this Cryp
toKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.", |
1106 "type": "string" | 1005 "type": "string" |
| 1006 }, |
| 1007 "purpose": { |
| 1008 "description": "The immutable purpose of this CryptoKey. Cur
rently, the only acceptable\npurpose is ENCRYPT_DECRYPT.", |
| 1009 "enum": [ |
| 1010 "CRYPTO_KEY_PURPOSE_UNSPECIFIED", |
| 1011 "ENCRYPT_DECRYPT" |
| 1012 ], |
| 1013 "enumDescriptions": [ |
| 1014 "Not specified.", |
| 1015 "CryptoKeys with this purpose may be used with\nEncrypt
and\nDecrypt." |
| 1016 ], |
| 1017 "type": "string" |
| 1018 }, |
| 1019 "nextRotationTime": { |
| 1020 "description": "At next_rotation_time, the Key Management Se
rvice will automatically:\n\n1. Create a new version of this CryptoKey.\n2. Mark
the new version as primary.\n\nKey rotations performed manually via\nCreateCryp
toKeyVersion and\nUpdateCryptoKeyPrimaryVersion\ndo not affect next_rotation_tim
e.", |
| 1021 "format": "google-datetime", |
| 1022 "type": "string" |
1107 } | 1023 } |
1108 }, | 1024 }, |
1109 "type": "object" | 1025 "type": "object" |
1110 }, | 1026 }, |
1111 "LogConfig": { | 1027 "LogConfig": { |
1112 "description": "Specifies what kind of log the caller must write", | 1028 "description": "Specifies what kind of log the caller must write", |
1113 "id": "LogConfig", | 1029 "id": "LogConfig", |
1114 "properties": { | 1030 "properties": { |
1115 "dataAccess": { | 1031 "dataAccess": { |
1116 "$ref": "DataAccessOptions", | 1032 "$ref": "DataAccessOptions", |
(...skipping 40 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1157 "format": "byte", | 1073 "format": "byte", |
1158 "type": "string" | 1074 "type": "string" |
1159 } | 1075 } |
1160 }, | 1076 }, |
1161 "type": "object" | 1077 "type": "object" |
1162 }, | 1078 }, |
1163 "Location": { | 1079 "Location": { |
1164 "description": "A resource that represents Google Cloud Platform loc
ation.", | 1080 "description": "A resource that represents Google Cloud Platform loc
ation.", |
1165 "id": "Location", | 1081 "id": "Location", |
1166 "properties": { | 1082 "properties": { |
| 1083 "labels": { |
| 1084 "additionalProperties": { |
| 1085 "type": "string" |
| 1086 }, |
| 1087 "description": "Cross-service attributes for the location. F
or example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}", |
| 1088 "type": "object" |
| 1089 }, |
| 1090 "name": { |
| 1091 "description": "Resource name for the location, which may va
ry between implementations.\nFor example: `\"projects/example-project/locations/
us-east1\"`", |
| 1092 "type": "string" |
| 1093 }, |
1167 "locationId": { | 1094 "locationId": { |
1168 "description": "The canonical id for this location. For exam
ple: `\"us-east1\"`.", | 1095 "description": "The canonical id for this location. For exam
ple: `\"us-east1\"`.", |
1169 "type": "string" | 1096 "type": "string" |
1170 }, | 1097 }, |
1171 "metadata": { | 1098 "metadata": { |
1172 "additionalProperties": { | 1099 "additionalProperties": { |
1173 "description": "Properties of the object. Contains field
@type with type URL.", | 1100 "description": "Properties of the object. Contains field
@type with type URL.", |
1174 "type": "any" | 1101 "type": "any" |
1175 }, | 1102 }, |
1176 "description": "Service-specific metadata. For example the a
vailable capacity at the given\nlocation.", | 1103 "description": "Service-specific metadata. For example the a
vailable capacity at the given\nlocation.", |
1177 "type": "object" | 1104 "type": "object" |
1178 }, | |
1179 "labels": { | |
1180 "additionalProperties": { | |
1181 "type": "string" | |
1182 }, | |
1183 "description": "Cross-service attributes for the location. F
or example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}", | |
1184 "type": "object" | |
1185 }, | |
1186 "name": { | |
1187 "description": "Resource name for the location, which may va
ry between implementations.\nFor example: `\"projects/example-project/locations/
us-east1\"`", | |
1188 "type": "string" | |
1189 } | 1105 } |
1190 }, | 1106 }, |
1191 "type": "object" | 1107 "type": "object" |
1192 }, | 1108 }, |
1193 "ListCryptoKeysResponse": { | 1109 "ListCryptoKeysResponse": { |
1194 "description": "Response message for KeyManagementService.ListCrypto
Keys.", | 1110 "description": "Response message for KeyManagementService.ListCrypto
Keys.", |
1195 "id": "ListCryptoKeysResponse", | 1111 "id": "ListCryptoKeysResponse", |
1196 "properties": { | 1112 "properties": { |
1197 "nextPageToken": { | 1113 "nextPageToken": { |
1198 "description": "A token to retrieve next page of results. Pa
ss this value in\nListCryptoKeysRequest.page_token to retrieve the next page of
results.", | 1114 "description": "A token to retrieve next page of results. Pa
ss this value in\nListCryptoKeysRequest.page_token to retrieve the next page of
results.", |
(...skipping 11 matching lines...) Expand all Loading... |
1210 "format": "int32", | 1126 "format": "int32", |
1211 "type": "integer" | 1127 "type": "integer" |
1212 } | 1128 } |
1213 }, | 1129 }, |
1214 "type": "object" | 1130 "type": "object" |
1215 }, | 1131 }, |
1216 "Condition": { | 1132 "Condition": { |
1217 "description": "A condition to be met.", | 1133 "description": "A condition to be met.", |
1218 "id": "Condition", | 1134 "id": "Condition", |
1219 "properties": { | 1135 "properties": { |
| 1136 "op": { |
| 1137 "description": "An operator to apply the subject with.", |
| 1138 "enum": [ |
| 1139 "NO_OP", |
| 1140 "EQUALS", |
| 1141 "NOT_EQUALS", |
| 1142 "IN", |
| 1143 "NOT_IN", |
| 1144 "DISCHARGED" |
| 1145 ], |
| 1146 "enumDescriptions": [ |
| 1147 "Default no-op.", |
| 1148 "DEPRECATED. Use IN instead.", |
| 1149 "DEPRECATED. Use NOT_IN instead.", |
| 1150 "The condition is true if the subject (or any element of
it if it is\na set) matches any of the supplied values.", |
| 1151 "The condition is true if the subject (or every element
of it if it is\na set) matches none of the supplied values.", |
| 1152 "Subject is discharged" |
| 1153 ], |
| 1154 "type": "string" |
| 1155 }, |
1220 "svc": { | 1156 "svc": { |
1221 "description": "Trusted attributes discharged by the service
.", | 1157 "description": "Trusted attributes discharged by the service
.", |
1222 "type": "string" | 1158 "type": "string" |
1223 }, | 1159 }, |
| 1160 "value": { |
| 1161 "description": "DEPRECATED. Use 'values' instead.", |
| 1162 "type": "string" |
| 1163 }, |
1224 "sys": { | 1164 "sys": { |
1225 "description": "Trusted attributes supplied by any service t
hat owns resources and uses\nthe IAM system for access control.", | 1165 "description": "Trusted attributes supplied by any service t
hat owns resources and uses\nthe IAM system for access control.", |
1226 "enum": [ | 1166 "enum": [ |
1227 "NO_ATTR", | 1167 "NO_ATTR", |
1228 "REGION", | 1168 "REGION", |
1229 "SERVICE", | 1169 "SERVICE", |
1230 "NAME", | 1170 "NAME", |
1231 "IP" | 1171 "IP" |
1232 ], | 1172 ], |
1233 "enumDescriptions": [ | 1173 "enumDescriptions": [ |
1234 "Default non-attribute type", | 1174 "Default non-attribute type", |
1235 "Region of the resource", | 1175 "Region of the resource", |
1236 "Service name", | 1176 "Service name", |
1237 "Resource name", | 1177 "Resource name", |
1238 "IP address of the caller" | 1178 "IP address of the caller" |
1239 ], | 1179 ], |
1240 "type": "string" | 1180 "type": "string" |
1241 }, | 1181 }, |
1242 "value": { | 1182 "values": { |
1243 "description": "DEPRECATED. Use 'values' instead.", | 1183 "description": "The objects of the condition. This is mutual
ly exclusive with 'value'.", |
1244 "type": "string" | 1184 "items": { |
| 1185 "type": "string" |
| 1186 }, |
| 1187 "type": "array" |
1245 }, | 1188 }, |
1246 "iam": { | 1189 "iam": { |
1247 "description": "Trusted attributes supplied by the IAM syste
m.", | 1190 "description": "Trusted attributes supplied by the IAM syste
m.", |
1248 "enum": [ | 1191 "enum": [ |
1249 "NO_ATTR", | 1192 "NO_ATTR", |
1250 "AUTHORITY", | 1193 "AUTHORITY", |
1251 "ATTRIBUTION", | 1194 "ATTRIBUTION", |
1252 "APPROVER", | 1195 "APPROVER", |
1253 "JUSTIFICATION_TYPE" | 1196 "JUSTIFICATION_TYPE" |
1254 ], | 1197 ], |
1255 "enumDescriptions": [ | 1198 "enumDescriptions": [ |
1256 "Default non-attribute.", | 1199 "Default non-attribute.", |
1257 "Either principal or (if present) authority selector.", | 1200 "Either principal or (if present) authority selector.", |
1258 "The principal (even if an authority selector is present
), which\nmust only be used for attribution, not authorization.", | 1201 "The principal (even if an authority selector is present
), which\nmust only be used for attribution, not authorization.", |
1259 "An approver (distinct from the requester) that has auth
orized this\nrequest.\nWhen used with IN, the condition indicates that one of th
e approvers\nassociated with the request matches the specified principal, or is
a\nmember of the specified group. Approvers can only grant additional\naccess, a
nd are thus only used in a strictly positive context\n(e.g. ALLOW/IN or DENY/NOT
_IN).\nSee: go/rpc-security-policy-dynamicauth.", | 1202 "An approver (distinct from the requester) that has auth
orized this\nrequest.\nWhen used with IN, the condition indicates that one of th
e approvers\nassociated with the request matches the specified principal, or is
a\nmember of the specified group. Approvers can only grant additional\naccess, a
nd are thus only used in a strictly positive context\n(e.g. ALLOW/IN or DENY/NOT
_IN).", |
1260 "What types of justifications have been supplied with th
is request.\nString values should match enum names from tech.iam.JustificationTy
pe,\ne.g. \"MANUAL_STRING\". It is not permitted to grant access based on\nthe *
absence* of a justification, so justification conditions can only\nbe used in a
\"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN).\n\nMultiple justifications
, e.g., a Buganizer ID and a manually-entered\nreason, are normal and supported.
" | 1203 "What types of justifications have been supplied with th
is request.\nString values should match enum names from tech.iam.JustificationTy
pe,\ne.g. \"MANUAL_STRING\". It is not permitted to grant access based on\nthe *
absence* of a justification, so justification conditions can only\nbe used in a
\"positive\" context (e.g., ALLOW/IN or DENY/NOT_IN).\n\nMultiple justifications
, e.g., a Buganizer ID and a manually-entered\nreason, are normal and supported.
" |
1261 ], | 1204 ], |
1262 "type": "string" | 1205 "type": "string" |
1263 }, | |
1264 "values": { | |
1265 "description": "The objects of the condition. This is mutual
ly exclusive with 'value'.", | |
1266 "items": { | |
1267 "type": "string" | |
1268 }, | |
1269 "type": "array" | |
1270 }, | |
1271 "op": { | |
1272 "description": "An operator to apply the subject with.", | |
1273 "enum": [ | |
1274 "NO_OP", | |
1275 "EQUALS", | |
1276 "NOT_EQUALS", | |
1277 "IN", | |
1278 "NOT_IN", | |
1279 "DISCHARGED" | |
1280 ], | |
1281 "enumDescriptions": [ | |
1282 "Default no-op.", | |
1283 "DEPRECATED. Use IN instead.", | |
1284 "DEPRECATED. Use NOT_IN instead.", | |
1285 "The condition is true if the subject (or any element of
it if it is\na set) matches any of the supplied values.", | |
1286 "The condition is true if the subject (or every element
of it if it is\na set) matches none of the supplied values.", | |
1287 "Subject is discharged" | |
1288 ], | |
1289 "type": "string" | |
1290 } | 1206 } |
1291 }, | 1207 }, |
1292 "type": "object" | 1208 "type": "object" |
1293 }, | 1209 }, |
1294 "CounterOptions": { | 1210 "CounterOptions": { |
1295 "description": "Options for counters", | 1211 "description": "Options for counters", |
1296 "id": "CounterOptions", | 1212 "id": "CounterOptions", |
1297 "properties": { | 1213 "properties": { |
1298 "metric": { | 1214 "metric": { |
1299 "description": "The metric to update.", | 1215 "description": "The metric to update.", |
1300 "type": "string" | 1216 "type": "string" |
1301 }, | 1217 }, |
1302 "field": { | 1218 "field": { |
1303 "description": "The field value to attribute.", | 1219 "description": "The field value to attribute.", |
1304 "type": "string" | 1220 "type": "string" |
1305 } | 1221 } |
1306 }, | 1222 }, |
1307 "type": "object" | 1223 "type": "object" |
1308 }, | 1224 }, |
1309 "AuditLogConfig": { | 1225 "AuditLogConfig": { |
1310 "description": "Provides the configuration for logging a type of per
missions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n
\"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n
\"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type
\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and '
DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.", | 1226 "description": "Provides the configuration for logging a type of per
missions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n
\"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n
\"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type
\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and '
DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.", |
1311 "id": "AuditLogConfig", | 1227 "id": "AuditLogConfig", |
1312 "properties": { | 1228 "properties": { |
1313 "exemptedMembers": { | |
1314 "description": "Specifies the identities that do not cause l
ogging for this type of\npermission.\nFollows the same format of Binding.members
.", | |
1315 "items": { | |
1316 "type": "string" | |
1317 }, | |
1318 "type": "array" | |
1319 }, | |
1320 "logType": { | 1229 "logType": { |
1321 "description": "The log type that this config enables.", | 1230 "description": "The log type that this config enables.", |
1322 "enum": [ | 1231 "enum": [ |
1323 "LOG_TYPE_UNSPECIFIED", | 1232 "LOG_TYPE_UNSPECIFIED", |
1324 "ADMIN_READ", | 1233 "ADMIN_READ", |
1325 "DATA_WRITE", | 1234 "DATA_WRITE", |
1326 "DATA_READ" | 1235 "DATA_READ" |
1327 ], | 1236 ], |
1328 "enumDescriptions": [ | 1237 "enumDescriptions": [ |
1329 "Default case. Should never be this.", | 1238 "Default case. Should never be this.", |
1330 "Admin reads. Example: CloudIAM getIamPolicy", | 1239 "Admin reads. Example: CloudIAM getIamPolicy", |
1331 "Data writes. Example: CloudSQL Users create", | 1240 "Data writes. Example: CloudSQL Users create", |
1332 "Data reads. Example: CloudSQL Users list" | 1241 "Data reads. Example: CloudSQL Users list" |
1333 ], | 1242 ], |
1334 "type": "string" | 1243 "type": "string" |
| 1244 }, |
| 1245 "exemptedMembers": { |
| 1246 "description": "Specifies the identities that do not cause l
ogging for this type of\npermission.\nFollows the same format of Binding.members
.", |
| 1247 "items": { |
| 1248 "type": "string" |
| 1249 }, |
| 1250 "type": "array" |
1335 } | 1251 } |
1336 }, | 1252 }, |
1337 "type": "object" | 1253 "type": "object" |
1338 }, | 1254 }, |
1339 "DecryptResponse": { | 1255 "DecryptResponse": { |
1340 "description": "Response message for KeyManagementService.Decrypt.", | 1256 "description": "Response message for KeyManagementService.Decrypt.", |
1341 "id": "DecryptResponse", | 1257 "id": "DecryptResponse", |
1342 "properties": { | 1258 "properties": { |
1343 "plaintext": { | 1259 "plaintext": { |
1344 "description": "The decrypted data originally supplied in En
cryptRequest.plaintext.", | 1260 "description": "The decrypted data originally supplied in En
cryptRequest.plaintext.", |
(...skipping 10 matching lines...) Expand all Loading... |
1355 "permissions": { | 1271 "permissions": { |
1356 "description": "The set of permissions to check for the `res
ource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed
. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/ov
erview#permissions).", | 1272 "description": "The set of permissions to check for the `res
ource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed
. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/ov
erview#permissions).", |
1357 "items": { | 1273 "items": { |
1358 "type": "string" | 1274 "type": "string" |
1359 }, | 1275 }, |
1360 "type": "array" | 1276 "type": "array" |
1361 } | 1277 } |
1362 }, | 1278 }, |
1363 "type": "object" | 1279 "type": "object" |
1364 }, | 1280 }, |
| 1281 "KeyRing": { |
| 1282 "description": "A KeyRing is a toplevel logical grouping of CryptoKe
ys.", |
| 1283 "id": "KeyRing", |
| 1284 "properties": { |
| 1285 "createTime": { |
| 1286 "description": "Output only. The time at which this KeyRing
was created.", |
| 1287 "format": "google-datetime", |
| 1288 "type": "string" |
| 1289 }, |
| 1290 "name": { |
| 1291 "description": "Output only. The resource name for the KeyRi
ng in the format\n`projects/*/locations/*/keyRings/*`.", |
| 1292 "type": "string" |
| 1293 } |
| 1294 }, |
| 1295 "type": "object" |
| 1296 }, |
1365 "EncryptResponse": { | 1297 "EncryptResponse": { |
1366 "description": "Response message for KeyManagementService.Encrypt.", | 1298 "description": "Response message for KeyManagementService.Encrypt.", |
1367 "id": "EncryptResponse", | 1299 "id": "EncryptResponse", |
1368 "properties": { | 1300 "properties": { |
1369 "ciphertext": { | 1301 "ciphertext": { |
1370 "description": "The encrypted data.", | 1302 "description": "The encrypted data.", |
1371 "format": "byte", | 1303 "format": "byte", |
1372 "type": "string" | 1304 "type": "string" |
1373 }, | 1305 }, |
1374 "name": { | 1306 "name": { |
1375 "description": "The resource name of the CryptoKeyVersion us
ed in encryption.", | 1307 "description": "The resource name of the CryptoKeyVersion us
ed in encryption.", |
1376 "type": "string" | 1308 "type": "string" |
1377 } | 1309 } |
1378 }, | 1310 }, |
1379 "type": "object" | |
1380 }, | |
1381 "KeyRing": { | |
1382 "description": "A KeyRing is a toplevel logical grouping of CryptoKe
ys.", | |
1383 "id": "KeyRing", | |
1384 "properties": { | |
1385 "createTime": { | |
1386 "description": "Output only. The time at which this KeyRing
was created.", | |
1387 "format": "google-datetime", | |
1388 "type": "string" | |
1389 }, | |
1390 "name": { | |
1391 "description": "Output only. The resource name for the KeyRi
ng in the format\n`projects/*/locations/*/keyRings/*`.", | |
1392 "type": "string" | |
1393 } | |
1394 }, | |
1395 "type": "object" | 1311 "type": "object" |
1396 }, | 1312 }, |
1397 "ListLocationsResponse": { | 1313 "ListLocationsResponse": { |
1398 "description": "The response message for Locations.ListLocations.", | 1314 "description": "The response message for Locations.ListLocations.", |
1399 "id": "ListLocationsResponse", | 1315 "id": "ListLocationsResponse", |
1400 "properties": { | 1316 "properties": { |
1401 "nextPageToken": { | 1317 "nextPageToken": { |
1402 "description": "The standard List next-page token.", | 1318 "description": "The standard List next-page token.", |
1403 "type": "string" | 1319 "type": "string" |
1404 }, | 1320 }, |
1405 "locations": { | 1321 "locations": { |
1406 "description": "A list of locations that matches the specifi
ed filter in the request.", | 1322 "description": "A list of locations that matches the specifi
ed filter in the request.", |
1407 "items": { | 1323 "items": { |
1408 "$ref": "Location" | 1324 "$ref": "Location" |
1409 }, | 1325 }, |
1410 "type": "array" | 1326 "type": "array" |
1411 } | 1327 } |
1412 }, | 1328 }, |
1413 "type": "object" | 1329 "type": "object" |
1414 }, | 1330 }, |
1415 "Policy": { | 1331 "Policy": { |
1416 "description": "Defines an Identity and Access Management (IAM) poli
cy. It is used to\nspecify access control policies for Cloud Platform resources.
\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n
`members` to a `role`, where the members can be user accounts, Google groups,\nG
oogle domains, and service accounts. A `role` is a named list of permissions\nde
fined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n
\"role\": \"roles/owner\",\n \"members\": [\n \"user:mike
@example.com\",\n \"group:admins@example.com\",\n \"domain
:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccoun
t.com\",\n ]\n },\n {\n \"role\": \"roles/viewer
\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n
}\n\nFor a description of IAM and its features, see the\n[IAM developer's guide
](https://cloud.google.com/iam).", | 1332 "description": "Defines an Identity and Access Management (IAM) poli
cy. It is used to\nspecify access control policies for Cloud Platform resources.
\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n
`members` to a `role`, where the members can be user accounts, Google groups,\nG
oogle domains, and service accounts. A `role` is a named list of permissions\nde
fined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n
\"role\": \"roles/owner\",\n \"members\": [\n \"user:mike
@example.com\",\n \"group:admins@example.com\",\n \"domain
:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccoun
t.com\",\n ]\n },\n {\n \"role\": \"roles/viewer
\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n
}\n\nFor a description of IAM and its features, see the\n[IAM developer's guide
](https://cloud.google.com/iam).", |
1417 "id": "Policy", | 1333 "id": "Policy", |
1418 "properties": { | 1334 "properties": { |
1419 "iamOwned": { | |
1420 "type": "boolean" | |
1421 }, | |
1422 "rules": { | |
1423 "description": "If more than one rule is specified, the rule
s are applied in the following\nmanner:\n- All matching LOG rules are always app
lied.\n- If any DENY/DENY_WITH_LOG rule matches, permission is denied.\n Loggin
g will be applied if one or more matching rule requires logging.\n- Otherwise, i
f any ALLOW/ALLOW_WITH_LOG rule matches, permission is\n granted.\n Logging wi
ll be applied if one or more matching rule requires logging.\n- Otherwise, if no
rule applies, permission is denied.", | |
1424 "items": { | |
1425 "$ref": "Rule" | |
1426 }, | |
1427 "type": "array" | |
1428 }, | |
1429 "version": { | 1335 "version": { |
1430 "description": "Version of the `Policy`. The default version
is 0.", | 1336 "description": "Version of the `Policy`. The default version
is 0.", |
1431 "format": "int32", | 1337 "format": "int32", |
1432 "type": "integer" | 1338 "type": "integer" |
1433 }, | 1339 }, |
1434 "auditConfigs": { | 1340 "auditConfigs": { |
1435 "description": "Specifies cloud audit logging configuration
for this policy.", | 1341 "description": "Specifies cloud audit logging configuration
for this policy.", |
1436 "items": { | 1342 "items": { |
1437 "$ref": "AuditConfig" | 1343 "$ref": "AuditConfig" |
1438 }, | 1344 }, |
1439 "type": "array" | 1345 "type": "array" |
1440 }, | 1346 }, |
1441 "bindings": { | 1347 "bindings": { |
1442 "description": "Associates a list of `members` to a `role`.\
nMultiple `bindings` must not be specified for the same `role`.\n`bindings` with
no members will result in an error.", | 1348 "description": "Associates a list of `members` to a `role`.\
n`bindings` with no members will result in an error.", |
1443 "items": { | 1349 "items": { |
1444 "$ref": "Binding" | 1350 "$ref": "Binding" |
1445 }, | 1351 }, |
1446 "type": "array" | 1352 "type": "array" |
1447 }, | 1353 }, |
1448 "etag": { | 1354 "etag": { |
1449 "description": "`etag` is used for optimistic concurrency co
ntrol as a way to help\nprevent simultaneous updates of a policy from overwritin
g each other.\nIt is strongly suggested that systems make use of the `etag` in t
he\nread-modify-write cycle to perform policy updates in order to avoid race\nco
nditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems
are expected to put that etag in the request to `setIamPolicy` to\nensure that t
heir change will be applied to the same version of the policy.\n\nIf no `etag` i
s provided in the call to `setIamPolicy`, then the existing\npolicy is overwritt
en blindly.", | 1355 "description": "`etag` is used for optimistic concurrency co
ntrol as a way to help\nprevent simultaneous updates of a policy from overwritin
g each other.\nIt is strongly suggested that systems make use of the `etag` in t
he\nread-modify-write cycle to perform policy updates in order to avoid race\nco
nditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems
are expected to put that etag in the request to `setIamPolicy` to\nensure that t
heir change will be applied to the same version of the policy.\n\nIf no `etag` i
s provided in the call to `setIamPolicy`, then the existing\npolicy is overwritt
en blindly.", |
1450 "format": "byte", | 1356 "format": "byte", |
1451 "type": "string" | 1357 "type": "string" |
| 1358 }, |
| 1359 "iamOwned": { |
| 1360 "type": "boolean" |
| 1361 }, |
| 1362 "rules": { |
| 1363 "description": "If more than one rule is specified, the rule
s are applied in the following\nmanner:\n- All matching LOG rules are always app
lied.\n- If any DENY/DENY_WITH_LOG rule matches, permission is denied.\n Loggin
g will be applied if one or more matching rule requires logging.\n- Otherwise, i
f any ALLOW/ALLOW_WITH_LOG rule matches, permission is\n granted.\n Logging wi
ll be applied if one or more matching rule requires logging.\n- Otherwise, if no
rule applies, permission is denied.", |
| 1364 "items": { |
| 1365 "$ref": "Rule" |
| 1366 }, |
| 1367 "type": "array" |
1452 } | 1368 } |
1453 }, | 1369 }, |
1454 "type": "object" | 1370 "type": "object" |
1455 }, | 1371 }, |
1456 "RestoreCryptoKeyVersionRequest": { | |
1457 "description": "Request message for KeyManagementService.RestoreCryp
toKeyVersion.", | |
1458 "id": "RestoreCryptoKeyVersionRequest", | |
1459 "properties": {}, | |
1460 "type": "object" | |
1461 }, | |
1462 "UpdateCryptoKeyPrimaryVersionRequest": { | 1372 "UpdateCryptoKeyPrimaryVersionRequest": { |
1463 "description": "Request message for KeyManagementService.UpdateCrypt
oKeyPrimaryVersion.", | 1373 "description": "Request message for KeyManagementService.UpdateCrypt
oKeyPrimaryVersion.", |
1464 "id": "UpdateCryptoKeyPrimaryVersionRequest", | 1374 "id": "UpdateCryptoKeyPrimaryVersionRequest", |
1465 "properties": { | 1375 "properties": { |
1466 "cryptoKeyVersionId": { | 1376 "cryptoKeyVersionId": { |
1467 "description": "The id of the child CryptoKeyVersion to use
as primary.", | 1377 "description": "The id of the child CryptoKeyVersion to use
as primary.", |
1468 "type": "string" | 1378 "type": "string" |
1469 } | 1379 } |
1470 }, | 1380 }, |
1471 "type": "object" | 1381 "type": "object" |
1472 }, | 1382 }, |
| 1383 "RestoreCryptoKeyVersionRequest": { |
| 1384 "description": "Request message for KeyManagementService.RestoreCryp
toKeyVersion.", |
| 1385 "id": "RestoreCryptoKeyVersionRequest", |
| 1386 "properties": {}, |
| 1387 "type": "object" |
| 1388 }, |
| 1389 "DataAccessOptions": { |
| 1390 "description": "Write a Data Access (Gin) log", |
| 1391 "id": "DataAccessOptions", |
| 1392 "properties": {}, |
| 1393 "type": "object" |
| 1394 }, |
1473 "ListKeyRingsResponse": { | 1395 "ListKeyRingsResponse": { |
1474 "description": "Response message for KeyManagementService.ListKeyRin
gs.", | 1396 "description": "Response message for KeyManagementService.ListKeyRin
gs.", |
1475 "id": "ListKeyRingsResponse", | 1397 "id": "ListKeyRingsResponse", |
1476 "properties": { | 1398 "properties": { |
1477 "nextPageToken": { | 1399 "nextPageToken": { |
1478 "description": "A token to retrieve next page of results. Pa
ss this value in\nListKeyRingsRequest.page_token to retrieve the next page of re
sults.", | 1400 "description": "A token to retrieve next page of results. Pa
ss this value in\nListKeyRingsRequest.page_token to retrieve the next page of re
sults.", |
1479 "type": "string" | 1401 "type": "string" |
1480 }, | 1402 }, |
1481 "totalSize": { | 1403 "totalSize": { |
1482 "description": "The total number of KeyRings that matched th
e query.", | 1404 "description": "The total number of KeyRings that matched th
e query.", |
1483 "format": "int32", | 1405 "format": "int32", |
1484 "type": "integer" | 1406 "type": "integer" |
1485 }, | 1407 }, |
1486 "keyRings": { | 1408 "keyRings": { |
1487 "description": "The list of KeyRings.", | 1409 "description": "The list of KeyRings.", |
1488 "items": { | 1410 "items": { |
1489 "$ref": "KeyRing" | 1411 "$ref": "KeyRing" |
1490 }, | 1412 }, |
1491 "type": "array" | 1413 "type": "array" |
1492 } | 1414 } |
1493 }, | 1415 }, |
1494 "type": "object" | 1416 "type": "object" |
1495 }, | 1417 }, |
1496 "DataAccessOptions": { | 1418 "AuditConfig": { |
1497 "description": "Write a Data Access (Gin) log", | 1419 "description": "Specifies the audit configuration for a service.\nTh
e configuration determines which permission types are logged, and what\nidentiti
es, if any, are exempted from logging.\nAn AuditConfig must have one or more Aud
itLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific
service,\nthe union of the two AuditConfigs is used for that service: the log_t
ypes\nspecified in each AuditConfig are enabled, and the exempted_members in eac
h\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n
{\n \"audit_configs\": [\n {\n \"service\": \"allServices
\"\n \"audit_log_configs\": [\n {\n \"log_type\
": \"DATA_READ\",\n \"exempted_members\": [\n \"user
:foo@gmail.com\"\n ]\n },\n {\n
\"log_type\": \"DATA_WRITE\",\n },\n {\n \"lo
g_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n
\"service\": \"fooservice.googleapis.com\"\n \"audit_log_config
s\": [\n {\n \"log_type\": \"DATA_READ\",\n }
,\n {\n \"log_type\": \"DATA_WRITE\",\n \"e
xempted_members\": [\n \"user:bar@gmail.com\"\n ]\n
}\n ]\n }\n ]\n }\n\nFor fooservice, this pol
icy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@g
mail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.", |
1498 "id": "DataAccessOptions", | 1420 "id": "AuditConfig", |
1499 "properties": {}, | 1421 "properties": { |
| 1422 "service": { |
| 1423 "description": "Specifies a service that will be enabled for
audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com
`.\n`allServices` is a special value that covers all services.", |
| 1424 "type": "string" |
| 1425 }, |
| 1426 "auditLogConfigs": { |
| 1427 "description": "The configuration for logging of each type o
f permission.\nNext ID: 4", |
| 1428 "items": { |
| 1429 "$ref": "AuditLogConfig" |
| 1430 }, |
| 1431 "type": "array" |
| 1432 }, |
| 1433 "exemptedMembers": { |
| 1434 "items": { |
| 1435 "type": "string" |
| 1436 }, |
| 1437 "type": "array" |
| 1438 } |
| 1439 }, |
| 1440 "type": "object" |
| 1441 }, |
| 1442 "CryptoKeyVersion": { |
| 1443 "description": "A CryptoKeyVersion represents an individual cryptogr
aphic key, and the\nassociated key material.\n\nIt can be used for cryptographic
operations either directly, or via its\nparent CryptoKey, in which case the ser
ver will choose the appropriate\nversion for the operation.", |
| 1444 "id": "CryptoKeyVersion", |
| 1445 "properties": { |
| 1446 "destroyEventTime": { |
| 1447 "description": "Output only. The time this CryptoKeyVersion'
s key material was\ndestroyed. Only present if state is\nDESTROYED.", |
| 1448 "format": "google-datetime", |
| 1449 "type": "string" |
| 1450 }, |
| 1451 "destroyTime": { |
| 1452 "description": "Output only. The time this CryptoKeyVersion'
s key material is scheduled\nfor destruction. Only present if state is\nDESTROY_
SCHEDULED.", |
| 1453 "format": "google-datetime", |
| 1454 "type": "string" |
| 1455 }, |
| 1456 "createTime": { |
| 1457 "description": "Output only. The time at which this CryptoKe
yVersion was created.", |
| 1458 "format": "google-datetime", |
| 1459 "type": "string" |
| 1460 }, |
| 1461 "state": { |
| 1462 "description": "The current state of the CryptoKeyVersion.", |
| 1463 "enum": [ |
| 1464 "CRYPTO_KEY_VERSION_STATE_UNSPECIFIED", |
| 1465 "ENABLED", |
| 1466 "DISABLED", |
| 1467 "DESTROYED", |
| 1468 "DESTROY_SCHEDULED" |
| 1469 ], |
| 1470 "enumDescriptions": [ |
| 1471 "Not specified.", |
| 1472 "This version may be used in Encrypt and\nDecrypt reques
ts.", |
| 1473 "This version may not be used, but the key material is s
till available,\nand the version can be placed back into the ENABLED state.", |
| 1474 "This version is destroyed, and the key material is no l
onger stored.\nA version may not leave this state once entered.", |
| 1475 "This version is scheduled for destruction, and will be
destroyed soon.\nCall\nRestoreCryptoKeyVersion\nto put it back into the DISABLED
state." |
| 1476 ], |
| 1477 "type": "string" |
| 1478 }, |
| 1479 "name": { |
| 1480 "description": "Output only. The resource name for this Cryp
toKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryp
toKeyVersions/*`.", |
| 1481 "type": "string" |
| 1482 } |
| 1483 }, |
| 1484 "type": "object" |
| 1485 }, |
| 1486 "CloudAuditOptions": { |
| 1487 "description": "Write a Cloud Audit log", |
| 1488 "id": "CloudAuditOptions", |
| 1489 "properties": { |
| 1490 "logName": { |
| 1491 "description": "The log_name to populate in the Cloud Audit
Record.", |
| 1492 "enum": [ |
| 1493 "UNSPECIFIED_LOG_NAME", |
| 1494 "ADMIN_ACTIVITY", |
| 1495 "DATA_ACCESS" |
| 1496 ], |
| 1497 "enumDescriptions": [ |
| 1498 "Default. Should not be used.", |
| 1499 "Corresponds to \"cloudaudit.googleapis.com/activity\"", |
| 1500 "Corresponds to \"cloudaudit.googleapis.com/data_access\
"" |
| 1501 ], |
| 1502 "type": "string" |
| 1503 } |
| 1504 }, |
| 1505 "type": "object" |
| 1506 }, |
| 1507 "Binding": { |
| 1508 "description": "Associates `members` with a `role`.", |
| 1509 "id": "Binding", |
| 1510 "properties": { |
| 1511 "members": { |
| 1512 "description": "Specifies the identities requesting access f
or a Cloud Platform resource.\n`members` can have the following values:\n\n* `al
lUsers`: A special identifier that represents anyone who is\n on the internet;
with or without a Google account.\n\n* `allAuthenticatedUsers`: A special ident
ifier that represents anyone\n who is authenticated with a Google account or a
service account.\n\n* `user:{emailid}`: An email address that represents a spec
ific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\
n\n* `serviceAccount:{emailid}`: An email address that represents a service\n
account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{e
mailid}`: An email address that represents a Google group.\n For example, `adm
ins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that repre
sents all the\n users of that domain. For example, `google.com` or `example.co
m`.\n\n", |
| 1513 "items": { |
| 1514 "type": "string" |
| 1515 }, |
| 1516 "type": "array" |
| 1517 }, |
| 1518 "role": { |
| 1519 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", |
| 1520 "type": "string" |
| 1521 }, |
| 1522 "condition": { |
| 1523 "$ref": "Expr", |
| 1524 "description": "The condition that is associated with this b
inding.\nNOTE: an unsatisfied condition will not allow user access via current\n
binding. Different bindings, including their conditions, are examined\nindepende
ntly.\nThis field is GOOGLE_INTERNAL." |
| 1525 } |
| 1526 }, |
1500 "type": "object" | 1527 "type": "object" |
1501 } | 1528 } |
1502 }, | 1529 }, |
1503 "servicePath": "", | 1530 "servicePath": "", |
1504 "title": "Google Cloud Key Management Service (KMS) API", | 1531 "title": "Google Cloud Key Management Service (KMS) API", |
1505 "version": "v1" | 1532 "version": "v1" |
1506 } | 1533 } |
OLD | NEW |