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-premises. You can generate, use, rotate, and destroy AES256 encryption key
s.", | 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 "upload_protocol": { |
| 29 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 30 "location": "query", |
| 31 "type": "string" |
| 32 }, |
| 33 "prettyPrint": { |
| 34 "default": "true", |
| 35 "description": "Returns response with indentations and line breaks."
, |
| 36 "location": "query", |
| 37 "type": "boolean" |
| 38 }, |
28 "fields": { | 39 "fields": { |
29 "description": "Selector specifying which fields to include in a par
tial response.", | 40 "description": "Selector specifying which fields to include in a par
tial response.", |
30 "location": "query", | 41 "location": "query", |
31 "type": "string" | 42 "type": "string" |
32 }, | 43 }, |
33 "uploadType": { | 44 "uploadType": { |
34 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | 45 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
35 "location": "query", | 46 "location": "query", |
36 "type": "string" | 47 "type": "string" |
37 }, | 48 }, |
| 49 "callback": { |
| 50 "description": "JSONP", |
| 51 "location": "query", |
| 52 "type": "string" |
| 53 }, |
38 "$.xgafv": { | 54 "$.xgafv": { |
39 "description": "V1 error format.", | 55 "description": "V1 error format.", |
40 "enum": [ | 56 "enum": [ |
41 "1", | 57 "1", |
42 "2" | 58 "2" |
43 ], | 59 ], |
44 "enumDescriptions": [ | 60 "enumDescriptions": [ |
45 "v1 error format", | 61 "v1 error format", |
46 "v2 error format" | 62 "v2 error format" |
47 ], | 63 ], |
48 "location": "query", | 64 "location": "query", |
49 "type": "string" | 65 "type": "string" |
50 }, | 66 }, |
51 "callback": { | |
52 "description": "JSONP", | |
53 "location": "query", | |
54 "type": "string" | |
55 }, | |
56 "alt": { | 67 "alt": { |
57 "default": "json", | 68 "default": "json", |
58 "description": "Data format for response.", | 69 "description": "Data format for response.", |
59 "enum": [ | 70 "enum": [ |
60 "json", | 71 "json", |
61 "media", | 72 "media", |
62 "proto" | 73 "proto" |
63 ], | 74 ], |
64 "enumDescriptions": [ | 75 "enumDescriptions": [ |
65 "Responses with Content-Type of application/json", | 76 "Responses with Content-Type of application/json", |
66 "Media download with context-dependent Content-Type", | 77 "Media download with context-dependent Content-Type", |
67 "Responses with Content-Type of application/x-protobuf" | 78 "Responses with Content-Type of application/x-protobuf" |
68 ], | 79 ], |
69 "location": "query", | 80 "location": "query", |
70 "type": "string" | 81 "type": "string" |
71 }, | 82 }, |
| 83 "access_token": { |
| 84 "description": "OAuth access token.", |
| 85 "location": "query", |
| 86 "type": "string" |
| 87 }, |
72 "key": { | 88 "key": { |
73 "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.", | 89 "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.", |
74 "location": "query", | 90 "location": "query", |
75 "type": "string" | 91 "type": "string" |
76 }, | 92 }, |
77 "access_token": { | |
78 "description": "OAuth access token.", | |
79 "location": "query", | |
80 "type": "string" | |
81 }, | |
82 "quotaUser": { | 93 "quotaUser": { |
83 "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.", | 94 "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.", |
84 "location": "query", | 95 "location": "query", |
85 "type": "string" | 96 "type": "string" |
86 }, | 97 }, |
87 "pp": { | 98 "pp": { |
88 "default": "true", | 99 "default": "true", |
89 "description": "Pretty-print response.", | 100 "description": "Pretty-print response.", |
90 "location": "query", | 101 "location": "query", |
91 "type": "boolean" | 102 "type": "boolean" |
92 }, | 103 }, |
93 "bearer_token": { | |
94 "description": "OAuth bearer token.", | |
95 "location": "query", | |
96 "type": "string" | |
97 }, | |
98 "oauth_token": { | 104 "oauth_token": { |
99 "description": "OAuth 2.0 token for the current user.", | 105 "description": "OAuth 2.0 token for the current user.", |
100 "location": "query", | 106 "location": "query", |
101 "type": "string" | 107 "type": "string" |
102 }, | 108 }, |
103 "upload_protocol": { | 109 "bearer_token": { |
104 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 110 "description": "OAuth bearer token.", |
105 "location": "query", | 111 "location": "query", |
106 "type": "string" | 112 "type": "string" |
107 }, | |
108 "prettyPrint": { | |
109 "default": "true", | |
110 "description": "Returns response with indentations and line breaks."
, | |
111 "location": "query", | |
112 "type": "boolean" | |
113 } | 113 } |
114 }, | 114 }, |
115 "protocol": "rest", | 115 "protocol": "rest", |
116 "resources": { | 116 "resources": { |
117 "projects": { | 117 "projects": { |
118 "resources": { | 118 "resources": { |
119 "locations": { | 119 "locations": { |
120 "methods": { | 120 "methods": { |
121 "get": { | 121 "get": { |
122 "description": "Get information about a location.", | 122 "description": "Get information about a location.", |
(...skipping 229 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
352 "$ref": "TestIamPermissionsResponse" | 352 "$ref": "TestIamPermissionsResponse" |
353 }, | 353 }, |
354 "scopes": [ | 354 "scopes": [ |
355 "https://www.googleapis.com/auth/cloud-p
latform" | 355 "https://www.googleapis.com/auth/cloud-p
latform" |
356 ] | 356 ] |
357 } | 357 } |
358 }, | 358 }, |
359 "resources": { | 359 "resources": { |
360 "cryptoKeys": { | 360 "cryptoKeys": { |
361 "methods": { | 361 "methods": { |
362 "get": { | |
363 "description": "Returns metadata for
a given CryptoKey, as well as its\nprimary CryptoKeyVersion.", | |
364 "httpMethod": "GET", | |
365 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.get", | |
366 "parameterOrder": [ | |
367 "name" | |
368 ], | |
369 "parameters": { | |
370 "name": { | |
371 "description": "The name of
the CryptoKey to get.", | |
372 "location": "path", | |
373 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", | |
374 "required": true, | |
375 "type": "string" | |
376 } | |
377 }, | |
378 "path": "v1/{+name}", | |
379 "response": { | |
380 "$ref": "CryptoKey" | |
381 }, | |
382 "scopes": [ | |
383 "https://www.googleapis.com/auth
/cloud-platform" | |
384 ] | |
385 }, | |
386 "patch": { | |
387 "description": "Update a CryptoKey."
, | |
388 "httpMethod": "PATCH", | |
389 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.patch", | |
390 "parameterOrder": [ | |
391 "name" | |
392 ], | |
393 "parameters": { | |
394 "updateMask": { | |
395 "description": "Required lis
t of fields to be updated in this request.", | |
396 "format": "google-fieldmask"
, | |
397 "location": "query", | |
398 "type": "string" | |
399 }, | |
400 "name": { | |
401 "description": "Output only.
The resource name for this CryptoKey in the format\n`projects/*/locations/*/key
Rings/*/cryptoKeys/*`.", | |
402 "location": "path", | |
403 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", | |
404 "required": true, | |
405 "type": "string" | |
406 } | |
407 }, | |
408 "path": "v1/{+name}", | |
409 "request": { | |
410 "$ref": "CryptoKey" | |
411 }, | |
412 "response": { | |
413 "$ref": "CryptoKey" | |
414 }, | |
415 "scopes": [ | |
416 "https://www.googleapis.com/auth
/cloud-platform" | |
417 ] | |
418 }, | |
419 "testIamPermissions": { | |
420 "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.", | |
421 "httpMethod": "POST", | |
422 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.testIamPermissions", | |
423 "parameterOrder": [ | |
424 "resource" | |
425 ], | |
426 "parameters": { | |
427 "resource": { | |
428 "description": "REQUIRED: Th
e resource for which the policy detail is being requested.\nSee the operation do
cumentation for the appropriate value for this field.", | |
429 "location": "path", | |
430 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", | |
431 "required": true, | |
432 "type": "string" | |
433 } | |
434 }, | |
435 "path": "v1/{+resource}:testIamPermi
ssions", | |
436 "request": { | |
437 "$ref": "TestIamPermissionsReque
st" | |
438 }, | |
439 "response": { | |
440 "$ref": "TestIamPermissionsRespo
nse" | |
441 }, | |
442 "scopes": [ | |
443 "https://www.googleapis.com/auth
/cloud-platform" | |
444 ] | |
445 }, | |
446 "decrypt": { | |
447 "description": "Decrypts data that w
as protected by Encrypt.", | |
448 "httpMethod": "POST", | |
449 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.decrypt", | |
450 "parameterOrder": [ | |
451 "name" | |
452 ], | |
453 "parameters": { | |
454 "name": { | |
455 "description": "Required. Th
e resource name of the CryptoKey to use for decryption.\nThe server will choose
the appropriate version.", | |
456 "location": "path", | |
457 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", | |
458 "required": true, | |
459 "type": "string" | |
460 } | |
461 }, | |
462 "path": "v1/{+name}:decrypt", | |
463 "request": { | |
464 "$ref": "DecryptRequest" | |
465 }, | |
466 "response": { | |
467 "$ref": "DecryptResponse" | |
468 }, | |
469 "scopes": [ | |
470 "https://www.googleapis.com/auth
/cloud-platform" | |
471 ] | |
472 }, | |
473 "list": { | |
474 "description": "Lists CryptoKeys.", | |
475 "httpMethod": "GET", | |
476 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.list", | |
477 "parameterOrder": [ | |
478 "parent" | |
479 ], | |
480 "parameters": { | |
481 "pageToken": { | |
482 "description": "Optional pag
ination token, returned earlier via\nListCryptoKeysResponse.next_page_token.", | |
483 "location": "query", | |
484 "type": "string" | |
485 }, | |
486 "pageSize": { | |
487 "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.", | |
488 "format": "int32", | |
489 "location": "query", | |
490 "type": "integer" | |
491 }, | |
492 "parent": { | |
493 "description": "Required. Th
e resource name of the KeyRing to list, in the format\n`projects/*/locations/*/k
eyRings/*`.", | |
494 "location": "path", | |
495 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+$", | |
496 "required": true, | |
497 "type": "string" | |
498 } | |
499 }, | |
500 "path": "v1/{+parent}/cryptoKeys", | |
501 "response": { | |
502 "$ref": "ListCryptoKeysResponse" | |
503 }, | |
504 "scopes": [ | |
505 "https://www.googleapis.com/auth
/cloud-platform" | |
506 ] | |
507 }, | |
508 "encrypt": { | 362 "encrypt": { |
509 "description": "Encrypts data, so th
at it can only be recovered by a call to Decrypt.", | 363 "description": "Encrypts data, so th
at it can only be recovered by a call to Decrypt.", |
510 "httpMethod": "POST", | 364 "httpMethod": "POST", |
511 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.encrypt", | 365 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.encrypt", |
512 "parameterOrder": [ | 366 "parameterOrder": [ |
513 "name" | 367 "name" |
514 ], | 368 ], |
515 "parameters": { | 369 "parameters": { |
516 "name": { | 370 "name": { |
517 "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.", | 371 "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.", |
518 "location": "path", | 372 "location": "path", |
519 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/.+$", | 373 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/.+$", |
520 "required": true, | 374 "required": true, |
521 "type": "string" | 375 "type": "string" |
522 } | 376 } |
523 }, | 377 }, |
524 "path": "v1/{+name}:encrypt", | 378 "path": "v1/{+name}:encrypt", |
525 "request": { | 379 "request": { |
526 "$ref": "EncryptRequest" | 380 "$ref": "EncryptRequest" |
527 }, | 381 }, |
528 "response": { | 382 "response": { |
529 "$ref": "EncryptResponse" | 383 "$ref": "EncryptResponse" |
530 }, | 384 }, |
531 "scopes": [ | 385 "scopes": [ |
532 "https://www.googleapis.com/auth
/cloud-platform" | 386 "https://www.googleapis.com/auth
/cloud-platform" |
533 ] | 387 ] |
534 }, | 388 }, |
| 389 "setIamPolicy": { |
| 390 "description": "Sets the access cont
rol policy on the specified resource. Replaces any\nexisting policy.", |
| 391 "httpMethod": "POST", |
| 392 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.setIamPolicy", |
| 393 "parameterOrder": [ |
| 394 "resource" |
| 395 ], |
| 396 "parameters": { |
| 397 "resource": { |
| 398 "description": "REQUIRED: Th
e resource for which the policy is being specified.\nSee the operation documenta
tion for the appropriate value for this field.", |
| 399 "location": "path", |
| 400 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", |
| 401 "required": true, |
| 402 "type": "string" |
| 403 } |
| 404 }, |
| 405 "path": "v1/{+resource}:setIamPolicy
", |
| 406 "request": { |
| 407 "$ref": "SetIamPolicyRequest" |
| 408 }, |
| 409 "response": { |
| 410 "$ref": "Policy" |
| 411 }, |
| 412 "scopes": [ |
| 413 "https://www.googleapis.com/auth
/cloud-platform" |
| 414 ] |
| 415 }, |
535 "create": { | 416 "create": { |
536 "description": "Create a new CryptoK
ey within a KeyRing.\n\nCryptoKey.purpose is required.", | 417 "description": "Create a new CryptoK
ey within a KeyRing.\n\nCryptoKey.purpose is required.", |
537 "httpMethod": "POST", | 418 "httpMethod": "POST", |
538 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.create", | 419 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.create", |
539 "parameterOrder": [ | 420 "parameterOrder": [ |
540 "parent" | 421 "parent" |
541 ], | 422 ], |
542 "parameters": { | 423 "parameters": { |
543 "cryptoKeyId": { | 424 "cryptoKeyId": { |
544 "description": "Required. It
must be unique within a KeyRing and match the regular\nexpression `[a-zA-Z0-9_-
]{1,63}`", | 425 "description": "Required. It
must be unique within a KeyRing and match the regular\nexpression `[a-zA-Z0-9_-
]{1,63}`", |
545 "location": "query", | 426 "location": "query", |
546 "type": "string" | 427 "type": "string" |
547 }, | 428 }, |
548 "parent": { | 429 "parent": { |
549 "description": "Required. Th
e name of the KeyRing associated with the\nCryptoKeys.", | 430 "description": "Required. Th
e name of the KeyRing associated with the\nCryptoKeys.", |
550 "location": "path", | 431 "location": "path", |
551 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+$", | 432 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+$", |
552 "required": true, | 433 "required": true, |
553 "type": "string" | 434 "type": "string" |
554 } | 435 } |
555 }, | 436 }, |
556 "path": "v1/{+parent}/cryptoKeys", | 437 "path": "v1/{+parent}/cryptoKeys", |
557 "request": { | 438 "request": { |
558 "$ref": "CryptoKey" | 439 "$ref": "CryptoKey" |
559 }, | 440 }, |
560 "response": { | 441 "response": { |
561 "$ref": "CryptoKey" | 442 "$ref": "CryptoKey" |
562 }, | 443 }, |
| 444 "scopes": [ |
| 445 "https://www.googleapis.com/auth
/cloud-platform" |
| 446 ] |
| 447 }, |
| 448 "updatePrimaryVersion": { |
| 449 "description": "Update the version o
f a CryptoKey that will be used in Encrypt", |
| 450 "httpMethod": "POST", |
| 451 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.updatePrimaryVersion", |
| 452 "parameterOrder": [ |
| 453 "name" |
| 454 ], |
| 455 "parameters": { |
| 456 "name": { |
| 457 "description": "The resource
name of the CryptoKey to update.", |
| 458 "location": "path", |
| 459 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", |
| 460 "required": true, |
| 461 "type": "string" |
| 462 } |
| 463 }, |
| 464 "path": "v1/{+name}:updatePrimaryVer
sion", |
| 465 "request": { |
| 466 "$ref": "UpdateCryptoKeyPrimaryV
ersionRequest" |
| 467 }, |
| 468 "response": { |
| 469 "$ref": "CryptoKey" |
| 470 }, |
| 471 "scopes": [ |
| 472 "https://www.googleapis.com/auth
/cloud-platform" |
| 473 ] |
| 474 }, |
| 475 "getIamPolicy": { |
| 476 "description": "Gets the access cont
rol policy for a resource.\nReturns an empty policy if the resource exists and d
oes not have a policy\nset.", |
| 477 "httpMethod": "GET", |
| 478 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.getIamPolicy", |
| 479 "parameterOrder": [ |
| 480 "resource" |
| 481 ], |
| 482 "parameters": { |
| 483 "resource": { |
| 484 "description": "REQUIRED: Th
e resource for which the policy is being requested.\nSee the operation documenta
tion for the appropriate value for this field.", |
| 485 "location": "path", |
| 486 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", |
| 487 "required": true, |
| 488 "type": "string" |
| 489 } |
| 490 }, |
| 491 "path": "v1/{+resource}:getIamPolicy
", |
| 492 "response": { |
| 493 "$ref": "Policy" |
| 494 }, |
| 495 "scopes": [ |
| 496 "https://www.googleapis.com/auth
/cloud-platform" |
| 497 ] |
| 498 }, |
| 499 "patch": { |
| 500 "description": "Update a CryptoKey."
, |
| 501 "httpMethod": "PATCH", |
| 502 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.patch", |
| 503 "parameterOrder": [ |
| 504 "name" |
| 505 ], |
| 506 "parameters": { |
| 507 "name": { |
| 508 "description": "Output only.
The resource name for this CryptoKey in the format\n`projects/*/locations/*/key
Rings/*/cryptoKeys/*`.", |
| 509 "location": "path", |
| 510 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", |
| 511 "required": true, |
| 512 "type": "string" |
| 513 }, |
| 514 "updateMask": { |
| 515 "description": "Required lis
t of fields to be updated in this request.", |
| 516 "format": "google-fieldmask"
, |
| 517 "location": "query", |
| 518 "type": "string" |
| 519 } |
| 520 }, |
| 521 "path": "v1/{+name}", |
| 522 "request": { |
| 523 "$ref": "CryptoKey" |
| 524 }, |
| 525 "response": { |
| 526 "$ref": "CryptoKey" |
| 527 }, |
| 528 "scopes": [ |
| 529 "https://www.googleapis.com/auth
/cloud-platform" |
| 530 ] |
| 531 }, |
| 532 "get": { |
| 533 "description": "Returns metadata for
a given CryptoKey, as well as its\nprimary CryptoKeyVersion.", |
| 534 "httpMethod": "GET", |
| 535 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.get", |
| 536 "parameterOrder": [ |
| 537 "name" |
| 538 ], |
| 539 "parameters": { |
| 540 "name": { |
| 541 "description": "The name of
the CryptoKey to get.", |
| 542 "location": "path", |
| 543 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", |
| 544 "required": true, |
| 545 "type": "string" |
| 546 } |
| 547 }, |
| 548 "path": "v1/{+name}", |
| 549 "response": { |
| 550 "$ref": "CryptoKey" |
| 551 }, |
563 "scopes": [ | 552 "scopes": [ |
564 "https://www.googleapis.com/auth
/cloud-platform" | 553 "https://www.googleapis.com/auth
/cloud-platform" |
565 ] | 554 ] |
566 }, | 555 }, |
567 "setIamPolicy": { | 556 "testIamPermissions": { |
568 "description": "Sets the access cont
rol policy on the specified resource. Replaces any\nexisting policy.", | 557 "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.", |
569 "httpMethod": "POST", | 558 "httpMethod": "POST", |
570 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.setIamPolicy", | 559 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.testIamPermissions", |
571 "parameterOrder": [ | 560 "parameterOrder": [ |
572 "resource" | 561 "resource" |
573 ], | 562 ], |
574 "parameters": { | 563 "parameters": { |
575 "resource": { | 564 "resource": { |
576 "description": "REQUIRED: Th
e resource for which the policy is being specified.\nSee the operation documenta
tion for the appropriate value for this field.", | 565 "description": "REQUIRED: Th
e resource for which the policy detail is being requested.\nSee the operation do
cumentation for the appropriate value for this field.", |
577 "location": "path", | 566 "location": "path", |
578 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", | 567 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", |
579 "required": true, | 568 "required": true, |
580 "type": "string" | 569 "type": "string" |
581 } | 570 } |
582 }, | 571 }, |
583 "path": "v1/{+resource}:setIamPolicy
", | 572 "path": "v1/{+resource}:testIamPermi
ssions", |
584 "request": { | 573 "request": { |
585 "$ref": "SetIamPolicyRequest" | 574 "$ref": "TestIamPermissionsReque
st" |
586 }, | 575 }, |
587 "response": { | 576 "response": { |
588 "$ref": "Policy" | 577 "$ref": "TestIamPermissionsRespo
nse" |
589 }, | 578 }, |
590 "scopes": [ | 579 "scopes": [ |
591 "https://www.googleapis.com/auth
/cloud-platform" | 580 "https://www.googleapis.com/auth
/cloud-platform" |
592 ] | 581 ] |
593 }, | 582 }, |
594 "updatePrimaryVersion": { | 583 "decrypt": { |
595 "description": "Update the version o
f a CryptoKey that will be used in Encrypt", | 584 "description": "Decrypts data that w
as protected by Encrypt.", |
596 "httpMethod": "POST", | 585 "httpMethod": "POST", |
597 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.updatePrimaryVersion", | 586 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.decrypt", |
598 "parameterOrder": [ | 587 "parameterOrder": [ |
599 "name" | 588 "name" |
600 ], | 589 ], |
601 "parameters": { | 590 "parameters": { |
602 "name": { | 591 "name": { |
603 "description": "The resource
name of the CryptoKey to update.", | 592 "description": "Required. Th
e resource name of the CryptoKey to use for decryption.\nThe server will choose
the appropriate version.", |
604 "location": "path", | 593 "location": "path", |
605 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", | 594 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", |
606 "required": true, | 595 "required": true, |
607 "type": "string" | 596 "type": "string" |
608 } | 597 } |
609 }, | 598 }, |
610 "path": "v1/{+name}:updatePrimaryVer
sion", | 599 "path": "v1/{+name}:decrypt", |
611 "request": { | 600 "request": { |
612 "$ref": "UpdateCryptoKeyPrimaryV
ersionRequest" | 601 "$ref": "DecryptRequest" |
613 }, | 602 }, |
614 "response": { | 603 "response": { |
615 "$ref": "CryptoKey" | 604 "$ref": "DecryptResponse" |
616 }, | 605 }, |
617 "scopes": [ | 606 "scopes": [ |
618 "https://www.googleapis.com/auth
/cloud-platform" | 607 "https://www.googleapis.com/auth
/cloud-platform" |
619 ] | 608 ] |
620 }, | 609 }, |
621 "getIamPolicy": { | 610 "list": { |
622 "description": "Gets the access cont
rol policy for a resource.\nReturns an empty policy if the resource exists and d
oes not have a policy\nset.", | 611 "description": "Lists CryptoKeys.", |
623 "httpMethod": "GET", | 612 "httpMethod": "GET", |
624 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.getIamPolicy", | 613 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.list", |
625 "parameterOrder": [ | 614 "parameterOrder": [ |
626 "resource" | 615 "parent" |
627 ], | 616 ], |
628 "parameters": { | 617 "parameters": { |
629 "resource": { | 618 "pageToken": { |
630 "description": "REQUIRED: Th
e resource for which the policy is being requested.\nSee the operation documenta
tion for the appropriate value for this field.", | 619 "description": "Optional pag
ination token, returned earlier via\nListCryptoKeysResponse.next_page_token.", |
| 620 "location": "query", |
| 621 "type": "string" |
| 622 }, |
| 623 "pageSize": { |
| 624 "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.", |
| 625 "format": "int32", |
| 626 "location": "query", |
| 627 "type": "integer" |
| 628 }, |
| 629 "parent": { |
| 630 "description": "Required. Th
e resource name of the KeyRing to list, in the format\n`projects/*/locations/*/k
eyRings/*`.", |
631 "location": "path", | 631 "location": "path", |
632 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", | 632 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+$", |
633 "required": true, | 633 "required": true, |
634 "type": "string" | 634 "type": "string" |
635 } | 635 } |
636 }, | 636 }, |
637 "path": "v1/{+resource}:getIamPolicy
", | 637 "path": "v1/{+parent}/cryptoKeys", |
638 "response": { | 638 "response": { |
639 "$ref": "Policy" | 639 "$ref": "ListCryptoKeysResponse" |
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 "patch": { | 649 "patch": { |
(...skipping 54 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
704 ] | 704 ] |
705 }, | 705 }, |
706 "list": { | 706 "list": { |
707 "description": "Lists Crypto
KeyVersions.", | 707 "description": "Lists Crypto
KeyVersions.", |
708 "httpMethod": "GET", | 708 "httpMethod": "GET", |
709 "id": "cloudkms.projects.loc
ations.keyRings.cryptoKeys.cryptoKeyVersions.list", | 709 "id": "cloudkms.projects.loc
ations.keyRings.cryptoKeys.cryptoKeyVersions.list", |
710 "parameterOrder": [ | 710 "parameterOrder": [ |
711 "parent" | 711 "parent" |
712 ], | 712 ], |
713 "parameters": { | 713 "parameters": { |
714 "pageToken": { | |
715 "description": "Opti
onal pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_
page_token.", | |
716 "location": "query", | |
717 "type": "string" | |
718 }, | |
719 "pageSize": { | 714 "pageSize": { |
720 "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.", | 715 "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.", |
721 "format": "int32", | 716 "format": "int32", |
722 "location": "query", | 717 "location": "query", |
723 "type": "integer" | 718 "type": "integer" |
724 }, | 719 }, |
725 "parent": { | 720 "parent": { |
726 "description": "Requ
ired. The resource name of the CryptoKey to list, in the format\n`projects/*/loc
ations/*/keyRings/*/cryptoKeys/*`.", | 721 "description": "Requ
ired. The resource name of the CryptoKey to list, in the format\n`projects/*/loc
ations/*/keyRings/*/cryptoKeys/*`.", |
727 "location": "path", | 722 "location": "path", |
728 "pattern": "^project
s/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", | 723 "pattern": "^project
s/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", |
729 "required": true, | 724 "required": true, |
730 "type": "string" | 725 "type": "string" |
| 726 }, |
| 727 "pageToken": { |
| 728 "description": "Opti
onal pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_
page_token.", |
| 729 "location": "query", |
| 730 "type": "string" |
731 } | 731 } |
732 }, | 732 }, |
733 "path": "v1/{+parent}/crypto
KeyVersions", | 733 "path": "v1/{+parent}/crypto
KeyVersions", |
734 "response": { | 734 "response": { |
735 "$ref": "ListCryptoKeyVe
rsionsResponse" | 735 "$ref": "ListCryptoKeyVe
rsionsResponse" |
736 }, | 736 }, |
737 "scopes": [ | 737 "scopes": [ |
738 "https://www.googleapis.
com/auth/cloud-platform" | 738 "https://www.googleapis.
com/auth/cloud-platform" |
739 ] | 739 ] |
740 }, | 740 }, |
741 "destroy": { | 741 "create": { |
742 "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.", | 742 "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.", |
743 "httpMethod": "POST", | 743 "httpMethod": "POST", |
744 "id": "cloudkms.projects.loc
ations.keyRings.cryptoKeys.cryptoKeyVersions.destroy", | 744 "id": "cloudkms.projects.loc
ations.keyRings.cryptoKeys.cryptoKeyVersions.create", |
745 "parameterOrder": [ | 745 "parameterOrder": [ |
746 "name" | 746 "parent" |
747 ], | 747 ], |
748 "parameters": { | 748 "parameters": { |
749 "name": { | 749 "parent": { |
750 "description": "The
resource name of the CryptoKeyVersion to destroy.", | 750 "description": "Requ
ired. The name of the CryptoKey associated with\nthe CryptoKeyVersions.", |
751 "location": "path", | 751 "location": "path", |
752 "pattern": "^project
s/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$
", | 752 "pattern": "^project
s/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", |
753 "required": true, | 753 "required": true, |
754 "type": "string" | 754 "type": "string" |
755 } | 755 } |
756 }, | 756 }, |
757 "path": "v1/{+name}:destroy"
, | 757 "path": "v1/{+parent}/crypto
KeyVersions", |
758 "request": { | 758 "request": { |
759 "$ref": "DestroyCryptoKe
yVersionRequest" | 759 "$ref": "CryptoKeyVersio
n" |
760 }, | 760 }, |
761 "response": { | 761 "response": { |
762 "$ref": "CryptoKeyVersio
n" | 762 "$ref": "CryptoKeyVersio
n" |
763 }, | 763 }, |
764 "scopes": [ | 764 "scopes": [ |
765 "https://www.googleapis.
com/auth/cloud-platform" | 765 "https://www.googleapis.
com/auth/cloud-platform" |
766 ] | 766 ] |
767 }, | 767 }, |
768 "create": { | 768 "destroy": { |
769 "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.", | 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", | 770 "httpMethod": "POST", |
771 "id": "cloudkms.projects.loc
ations.keyRings.cryptoKeys.cryptoKeyVersions.create", | 771 "id": "cloudkms.projects.loc
ations.keyRings.cryptoKeys.cryptoKeyVersions.destroy", |
772 "parameterOrder": [ | 772 "parameterOrder": [ |
773 "parent" | 773 "name" |
774 ], | 774 ], |
775 "parameters": { | 775 "parameters": { |
776 "parent": { | 776 "name": { |
777 "description": "Requ
ired. The name of the CryptoKey associated with\nthe CryptoKeyVersions.", | 777 "description": "The
resource name of the CryptoKeyVersion to destroy.", |
778 "location": "path", | 778 "location": "path", |
779 "pattern": "^project
s/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", | 779 "pattern": "^project
s/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$
", |
780 "required": true, | 780 "required": true, |
781 "type": "string" | 781 "type": "string" |
782 } | 782 } |
783 }, | 783 }, |
784 "path": "v1/{+parent}/crypto
KeyVersions", | 784 "path": "v1/{+name}:destroy"
, |
785 "request": { | 785 "request": { |
786 "$ref": "CryptoKeyVersio
n" | 786 "$ref": "DestroyCryptoKe
yVersionRequest" |
787 }, | 787 }, |
788 "response": { | 788 "response": { |
789 "$ref": "CryptoKeyVersio
n" | 789 "$ref": "CryptoKeyVersio
n" |
790 }, | 790 }, |
791 "scopes": [ | 791 "scopes": [ |
792 "https://www.googleapis.
com/auth/cloud-platform" | 792 "https://www.googleapis.
com/auth/cloud-platform" |
793 ] | 793 ] |
794 }, | 794 }, |
795 "restore": { | 795 "restore": { |
796 "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
.", | 796 "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
.", |
(...skipping 26 matching lines...) Expand all Loading... |
823 } | 823 } |
824 } | 824 } |
825 } | 825 } |
826 } | 826 } |
827 } | 827 } |
828 } | 828 } |
829 } | 829 } |
830 } | 830 } |
831 } | 831 } |
832 }, | 832 }, |
833 "revision": "20170621", | 833 "revision": "20170725", |
834 "rootUrl": "https://cloudkms.googleapis.com/", | 834 "rootUrl": "https://cloudkms.googleapis.com/", |
835 "schemas": { | 835 "schemas": { |
836 "TestIamPermissionsRequest": { | 836 "EncryptResponse": { |
837 "description": "Request message for `TestIamPermissions` method.", | 837 "description": "Response message for KeyManagementService.Encrypt.", |
838 "id": "TestIamPermissionsRequest", | 838 "id": "EncryptResponse", |
839 "properties": { | 839 "properties": { |
840 "permissions": { | 840 "name": { |
841 "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).", | 841 "description": "The resource name of the CryptoKeyVersion us
ed in encryption.", |
| 842 "type": "string" |
| 843 }, |
| 844 "ciphertext": { |
| 845 "description": "The encrypted data.", |
| 846 "format": "byte", |
| 847 "type": "string" |
| 848 } |
| 849 }, |
| 850 "type": "object" |
| 851 }, |
| 852 "Policy": { |
| 853 "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).", |
| 854 "id": "Policy", |
| 855 "properties": { |
| 856 "etag": { |
| 857 "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.", |
| 858 "format": "byte", |
| 859 "type": "string" |
| 860 }, |
| 861 "iamOwned": { |
| 862 "type": "boolean" |
| 863 }, |
| 864 "rules": { |
| 865 "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.", |
842 "items": { | 866 "items": { |
843 "type": "string" | 867 "$ref": "Rule" |
| 868 }, |
| 869 "type": "array" |
| 870 }, |
| 871 "version": { |
| 872 "description": "Version of the `Policy`. The default version
is 0.", |
| 873 "format": "int32", |
| 874 "type": "integer" |
| 875 }, |
| 876 "auditConfigs": { |
| 877 "description": "Specifies cloud audit logging configuration
for this policy.", |
| 878 "items": { |
| 879 "$ref": "AuditConfig" |
| 880 }, |
| 881 "type": "array" |
| 882 }, |
| 883 "bindings": { |
| 884 "description": "Associates a list of `members` to a `role`.\
n`bindings` with no members will result in an error.", |
| 885 "items": { |
| 886 "$ref": "Binding" |
844 }, | 887 }, |
845 "type": "array" | 888 "type": "array" |
846 } | 889 } |
847 }, | 890 }, |
848 "type": "object" | 891 "type": "object" |
849 }, | |
850 "EncryptResponse": { | |
851 "description": "Response message for KeyManagementService.Encrypt.", | |
852 "id": "EncryptResponse", | |
853 "properties": { | |
854 "ciphertext": { | |
855 "description": "The encrypted data.", | |
856 "format": "byte", | |
857 "type": "string" | |
858 }, | |
859 "name": { | |
860 "description": "The resource name of the CryptoKeyVersion us
ed in encryption.", | |
861 "type": "string" | |
862 } | |
863 }, | |
864 "type": "object" | |
865 }, | 892 }, |
866 "KeyRing": { | 893 "KeyRing": { |
867 "description": "A KeyRing is a toplevel logical grouping of CryptoKe
ys.", | 894 "description": "A KeyRing is a toplevel logical grouping of CryptoKe
ys.", |
868 "id": "KeyRing", | 895 "id": "KeyRing", |
869 "properties": { | 896 "properties": { |
870 "createTime": { | 897 "createTime": { |
871 "description": "Output only. The time at which this KeyRing
was created.", | 898 "description": "Output only. The time at which this KeyRing
was created.", |
872 "format": "google-datetime", | 899 "format": "google-datetime", |
873 "type": "string" | 900 "type": "string" |
874 }, | 901 }, |
875 "name": { | 902 "name": { |
876 "description": "Output only. The resource name for the KeyRi
ng in the format\n`projects/*/locations/*/keyRings/*`.", | 903 "description": "Output only. The resource name for the KeyRi
ng in the format\n`projects/*/locations/*/keyRings/*`.", |
877 "type": "string" | 904 "type": "string" |
878 } | 905 } |
879 }, | 906 }, |
880 "type": "object" | 907 "type": "object" |
881 }, | 908 }, |
882 "ListLocationsResponse": { | 909 "ListLocationsResponse": { |
883 "description": "The response message for Locations.ListLocations.", | 910 "description": "The response message for Locations.ListLocations.", |
884 "id": "ListLocationsResponse", | 911 "id": "ListLocationsResponse", |
885 "properties": { | 912 "properties": { |
886 "nextPageToken": { | |
887 "description": "The standard List next-page token.", | |
888 "type": "string" | |
889 }, | |
890 "locations": { | 913 "locations": { |
891 "description": "A list of locations that matches the specifi
ed filter in the request.", | 914 "description": "A list of locations that matches the specifi
ed filter in the request.", |
892 "items": { | 915 "items": { |
893 "$ref": "Location" | 916 "$ref": "Location" |
894 }, | 917 }, |
895 "type": "array" | 918 "type": "array" |
| 919 }, |
| 920 "nextPageToken": { |
| 921 "description": "The standard List next-page token.", |
| 922 "type": "string" |
896 } | 923 } |
897 }, | 924 }, |
898 "type": "object" | 925 "type": "object" |
899 }, | 926 }, |
900 "Policy": { | 927 "RestoreCryptoKeyVersionRequest": { |
901 "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).", | 928 "description": "Request message for KeyManagementService.RestoreCryp
toKeyVersion.", |
902 "id": "Policy", | 929 "id": "RestoreCryptoKeyVersionRequest", |
903 "properties": { | 930 "properties": {}, |
904 "auditConfigs": { | |
905 "description": "Specifies cloud audit logging configuration
for this policy.", | |
906 "items": { | |
907 "$ref": "AuditConfig" | |
908 }, | |
909 "type": "array" | |
910 }, | |
911 "bindings": { | |
912 "description": "Associates a list of `members` to a `role`.\
n`bindings` with no members will result in an error.", | |
913 "items": { | |
914 "$ref": "Binding" | |
915 }, | |
916 "type": "array" | |
917 }, | |
918 "etag": { | |
919 "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.", | |
920 "format": "byte", | |
921 "type": "string" | |
922 }, | |
923 "iamOwned": { | |
924 "type": "boolean" | |
925 }, | |
926 "rules": { | |
927 "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.", | |
928 "items": { | |
929 "$ref": "Rule" | |
930 }, | |
931 "type": "array" | |
932 }, | |
933 "version": { | |
934 "description": "Version of the `Policy`. The default version
is 0.", | |
935 "format": "int32", | |
936 "type": "integer" | |
937 } | |
938 }, | |
939 "type": "object" | 931 "type": "object" |
940 }, | 932 }, |
941 "UpdateCryptoKeyPrimaryVersionRequest": { | 933 "UpdateCryptoKeyPrimaryVersionRequest": { |
942 "description": "Request message for KeyManagementService.UpdateCrypt
oKeyPrimaryVersion.", | 934 "description": "Request message for KeyManagementService.UpdateCrypt
oKeyPrimaryVersion.", |
943 "id": "UpdateCryptoKeyPrimaryVersionRequest", | 935 "id": "UpdateCryptoKeyPrimaryVersionRequest", |
944 "properties": { | 936 "properties": { |
945 "cryptoKeyVersionId": { | 937 "cryptoKeyVersionId": { |
946 "description": "The id of the child CryptoKeyVersion to use
as primary.", | 938 "description": "The id of the child CryptoKeyVersion to use
as primary.", |
947 "type": "string" | 939 "type": "string" |
948 } | 940 } |
949 }, | 941 }, |
950 "type": "object" | 942 "type": "object" |
951 }, | 943 }, |
952 "RestoreCryptoKeyVersionRequest": { | |
953 "description": "Request message for KeyManagementService.RestoreCryp
toKeyVersion.", | |
954 "id": "RestoreCryptoKeyVersionRequest", | |
955 "properties": {}, | |
956 "type": "object" | |
957 }, | |
958 "DataAccessOptions": { | |
959 "description": "Write a Data Access (Gin) log", | |
960 "id": "DataAccessOptions", | |
961 "properties": {}, | |
962 "type": "object" | |
963 }, | |
964 "ListKeyRingsResponse": { | 944 "ListKeyRingsResponse": { |
965 "description": "Response message for KeyManagementService.ListKeyRin
gs.", | 945 "description": "Response message for KeyManagementService.ListKeyRin
gs.", |
966 "id": "ListKeyRingsResponse", | 946 "id": "ListKeyRingsResponse", |
967 "properties": { | 947 "properties": { |
968 "keyRings": { | |
969 "description": "The list of KeyRings.", | |
970 "items": { | |
971 "$ref": "KeyRing" | |
972 }, | |
973 "type": "array" | |
974 }, | |
975 "nextPageToken": { | 948 "nextPageToken": { |
976 "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.", | 949 "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.", |
977 "type": "string" | 950 "type": "string" |
978 }, | 951 }, |
979 "totalSize": { | 952 "totalSize": { |
980 "description": "The total number of KeyRings that matched th
e query.", | 953 "description": "The total number of KeyRings that matched th
e query.", |
981 "format": "int32", | 954 "format": "int32", |
982 "type": "integer" | 955 "type": "integer" |
| 956 }, |
| 957 "keyRings": { |
| 958 "description": "The list of KeyRings.", |
| 959 "items": { |
| 960 "$ref": "KeyRing" |
| 961 }, |
| 962 "type": "array" |
983 } | 963 } |
984 }, | 964 }, |
985 "type": "object" | 965 "type": "object" |
986 }, | 966 }, |
| 967 "DataAccessOptions": { |
| 968 "description": "Write a Data Access (Gin) log", |
| 969 "id": "DataAccessOptions", |
| 970 "properties": {}, |
| 971 "type": "object" |
| 972 }, |
987 "AuditConfig": { | 973 "AuditConfig": { |
988 "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.", | 974 "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.", |
989 "id": "AuditConfig", | 975 "id": "AuditConfig", |
990 "properties": { | 976 "properties": { |
991 "service": { | 977 "service": { |
992 "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.", | 978 "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.", |
993 "type": "string" | 979 "type": "string" |
994 }, | 980 }, |
995 "auditLogConfigs": { | 981 "auditLogConfigs": { |
996 "description": "The configuration for logging of each type o
f permission.\nNext ID: 4", | 982 "description": "The configuration for logging of each type o
f permission.\nNext ID: 4", |
997 "items": { | 983 "items": { |
998 "$ref": "AuditLogConfig" | 984 "$ref": "AuditLogConfig" |
999 }, | 985 }, |
1000 "type": "array" | 986 "type": "array" |
1001 }, | 987 }, |
1002 "exemptedMembers": { | 988 "exemptedMembers": { |
1003 "items": { | 989 "items": { |
1004 "type": "string" | 990 "type": "string" |
1005 }, | 991 }, |
1006 "type": "array" | 992 "type": "array" |
1007 } | 993 } |
1008 }, | 994 }, |
1009 "type": "object" | 995 "type": "object" |
1010 }, | 996 }, |
1011 "CryptoKeyVersion": { | 997 "CryptoKeyVersion": { |
1012 "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.", | 998 "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.", |
1013 "id": "CryptoKeyVersion", | 999 "id": "CryptoKeyVersion", |
1014 "properties": { | 1000 "properties": { |
1015 "createTime": { | |
1016 "description": "Output only. The time at which this CryptoKe
yVersion was created.", | |
1017 "format": "google-datetime", | |
1018 "type": "string" | |
1019 }, | |
1020 "state": { | 1001 "state": { |
1021 "description": "The current state of the CryptoKeyVersion.", | 1002 "description": "The current state of the CryptoKeyVersion.", |
1022 "enum": [ | 1003 "enum": [ |
1023 "CRYPTO_KEY_VERSION_STATE_UNSPECIFIED", | 1004 "CRYPTO_KEY_VERSION_STATE_UNSPECIFIED", |
1024 "ENABLED", | 1005 "ENABLED", |
1025 "DISABLED", | 1006 "DISABLED", |
1026 "DESTROYED", | 1007 "DESTROYED", |
1027 "DESTROY_SCHEDULED" | 1008 "DESTROY_SCHEDULED" |
1028 ], | 1009 ], |
1029 "enumDescriptions": [ | 1010 "enumDescriptions": [ |
(...skipping 11 matching lines...) Expand all Loading... |
1041 }, | 1022 }, |
1042 "destroyEventTime": { | 1023 "destroyEventTime": { |
1043 "description": "Output only. The time this CryptoKeyVersion'
s key material was\ndestroyed. Only present if state is\nDESTROYED.", | 1024 "description": "Output only. The time this CryptoKeyVersion'
s key material was\ndestroyed. Only present if state is\nDESTROYED.", |
1044 "format": "google-datetime", | 1025 "format": "google-datetime", |
1045 "type": "string" | 1026 "type": "string" |
1046 }, | 1027 }, |
1047 "destroyTime": { | 1028 "destroyTime": { |
1048 "description": "Output only. The time this CryptoKeyVersion'
s key material is scheduled\nfor destruction. Only present if state is\nDESTROY_
SCHEDULED.", | 1029 "description": "Output only. The time this CryptoKeyVersion'
s key material is scheduled\nfor destruction. Only present if state is\nDESTROY_
SCHEDULED.", |
1049 "format": "google-datetime", | 1030 "format": "google-datetime", |
1050 "type": "string" | 1031 "type": "string" |
| 1032 }, |
| 1033 "createTime": { |
| 1034 "description": "Output only. The time at which this CryptoKe
yVersion was created.", |
| 1035 "format": "google-datetime", |
| 1036 "type": "string" |
1051 } | 1037 } |
1052 }, | 1038 }, |
1053 "type": "object" | 1039 "type": "object" |
1054 }, | 1040 }, |
1055 "CloudAuditOptions": { | 1041 "CloudAuditOptions": { |
1056 "description": "Write a Cloud Audit log", | 1042 "description": "Write a Cloud Audit log", |
1057 "id": "CloudAuditOptions", | 1043 "id": "CloudAuditOptions", |
1058 "properties": { | 1044 "properties": { |
1059 "logName": { | 1045 "logName": { |
1060 "description": "The log_name to populate in the Cloud Audit
Record.", | 1046 "description": "The log_name to populate in the Cloud Audit
Record.", |
1061 "enum": [ | 1047 "enum": [ |
1062 "UNSPECIFIED_LOG_NAME", | 1048 "UNSPECIFIED_LOG_NAME", |
1063 "ADMIN_ACTIVITY", | 1049 "ADMIN_ACTIVITY", |
1064 "DATA_ACCESS" | 1050 "DATA_ACCESS" |
1065 ], | 1051 ], |
1066 "enumDescriptions": [ | 1052 "enumDescriptions": [ |
1067 "Default. Should not be used.", | 1053 "Default. Should not be used.", |
1068 "Corresponds to \"cloudaudit.googleapis.com/activity\"", | 1054 "Corresponds to \"cloudaudit.googleapis.com/activity\"", |
1069 "Corresponds to \"cloudaudit.googleapis.com/data_access\
"" | 1055 "Corresponds to \"cloudaudit.googleapis.com/data_access\
"" |
1070 ], | 1056 ], |
1071 "type": "string" | 1057 "type": "string" |
1072 } | 1058 } |
1073 }, | 1059 }, |
1074 "type": "object" | 1060 "type": "object" |
1075 }, | 1061 }, |
1076 "Binding": { | 1062 "Binding": { |
1077 "description": "Associates `members` with a `role`.", | 1063 "description": "Associates `members` with a `role`.", |
1078 "id": "Binding", | 1064 "id": "Binding", |
1079 "properties": { | 1065 "properties": { |
| 1066 "condition": { |
| 1067 "$ref": "Expr", |
| 1068 "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." |
| 1069 }, |
1080 "members": { | 1070 "members": { |
1081 "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", | 1071 "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", |
1082 "items": { | 1072 "items": { |
1083 "type": "string" | 1073 "type": "string" |
1084 }, | 1074 }, |
1085 "type": "array" | 1075 "type": "array" |
1086 }, | 1076 }, |
1087 "role": { | 1077 "role": { |
1088 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", | 1078 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", |
1089 "type": "string" | 1079 "type": "string" |
1090 }, | |
1091 "condition": { | |
1092 "$ref": "Expr", | |
1093 "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." | |
1094 } | 1080 } |
1095 }, | 1081 }, |
1096 "type": "object" | 1082 "type": "object" |
1097 }, | 1083 }, |
1098 "Expr": { | 1084 "Expr": { |
1099 "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\"", | 1085 "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\"", |
1100 "id": "Expr", | 1086 "id": "Expr", |
1101 "properties": { | 1087 "properties": { |
1102 "description": { | 1088 "description": { |
1103 "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.", | 1089 "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.", |
(...skipping 67 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1171 } | 1157 } |
1172 }, | 1158 }, |
1173 "type": "object" | 1159 "type": "object" |
1174 }, | 1160 }, |
1175 "DestroyCryptoKeyVersionRequest": { | 1161 "DestroyCryptoKeyVersionRequest": { |
1176 "description": "Request message for KeyManagementService.DestroyCryp
toKeyVersion.", | 1162 "description": "Request message for KeyManagementService.DestroyCryp
toKeyVersion.", |
1177 "id": "DestroyCryptoKeyVersionRequest", | 1163 "id": "DestroyCryptoKeyVersionRequest", |
1178 "properties": {}, | 1164 "properties": {}, |
1179 "type": "object" | 1165 "type": "object" |
1180 }, | 1166 }, |
1181 "CryptoKey": { | |
1182 "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.", | |
1183 "id": "CryptoKey", | |
1184 "properties": { | |
1185 "createTime": { | |
1186 "description": "Output only. The time at which this CryptoKe
y was created.", | |
1187 "format": "google-datetime", | |
1188 "type": "string" | |
1189 }, | |
1190 "rotationPeriod": { | |
1191 "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.", | |
1192 "format": "google-duration", | |
1193 "type": "string" | |
1194 }, | |
1195 "primary": { | |
1196 "$ref": "CryptoKeyVersion", | |
1197 "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." | |
1198 }, | |
1199 "name": { | |
1200 "description": "Output only. The resource name for this Cryp
toKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.", | |
1201 "type": "string" | |
1202 }, | |
1203 "purpose": { | |
1204 "description": "The immutable purpose of this CryptoKey. Cur
rently, the only acceptable\npurpose is ENCRYPT_DECRYPT.", | |
1205 "enum": [ | |
1206 "CRYPTO_KEY_PURPOSE_UNSPECIFIED", | |
1207 "ENCRYPT_DECRYPT" | |
1208 ], | |
1209 "enumDescriptions": [ | |
1210 "Not specified.", | |
1211 "CryptoKeys with this purpose may be used with\nEncrypt
and\nDecrypt." | |
1212 ], | |
1213 "type": "string" | |
1214 }, | |
1215 "nextRotationTime": { | |
1216 "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.", | |
1217 "format": "google-datetime", | |
1218 "type": "string" | |
1219 } | |
1220 }, | |
1221 "type": "object" | |
1222 }, | |
1223 "Rule": { | 1167 "Rule": { |
1224 "description": "A rule to be applied in a Policy.", | 1168 "description": "A rule to be applied in a Policy.", |
1225 "id": "Rule", | 1169 "id": "Rule", |
1226 "properties": { | 1170 "properties": { |
| 1171 "permissions": { |
| 1172 "description": "A permission is a string of form '<service>.
<resource type>.<verb>'\n(e.g., 'storage.buckets.list'). A value of '*' matches
all permissions,\nand a verb part of '*' (e.g., 'storage.buckets.*') matches all
verbs.", |
| 1173 "items": { |
| 1174 "type": "string" |
| 1175 }, |
| 1176 "type": "array" |
| 1177 }, |
| 1178 "action": { |
| 1179 "description": "Required", |
| 1180 "enum": [ |
| 1181 "NO_ACTION", |
| 1182 "ALLOW", |
| 1183 "ALLOW_WITH_LOG", |
| 1184 "DENY", |
| 1185 "DENY_WITH_LOG", |
| 1186 "LOG" |
| 1187 ], |
| 1188 "enumDescriptions": [ |
| 1189 "Default no action.", |
| 1190 "Matching 'Entries' grant access.", |
| 1191 "Matching 'Entries' grant access and the caller promises
to log\nthe request per the returned log_configs.", |
| 1192 "Matching 'Entries' deny access.", |
| 1193 "Matching 'Entries' deny access and the caller promises
to log\nthe request per the returned log_configs.", |
| 1194 "Matching 'Entries' tell IAM.Check callers to generate l
ogs." |
| 1195 ], |
| 1196 "type": "string" |
| 1197 }, |
1227 "notIn": { | 1198 "notIn": { |
1228 "description": "If one or more 'not_in' clauses are specifie
d, the rule matches\nif the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entri
es.\nThe format for in and not_in entries is the same as for members in a\nBindi
ng (see google/iam/v1/policy.proto).", | 1199 "description": "If one or more 'not_in' clauses are specifie
d, the rule matches\nif the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entri
es.\nThe format for in and not_in entries is the same as for members in a\nBindi
ng (see google/iam/v1/policy.proto).", |
1229 "items": { | 1200 "items": { |
1230 "type": "string" | 1201 "type": "string" |
1231 }, | 1202 }, |
1232 "type": "array" | 1203 "type": "array" |
1233 }, | 1204 }, |
1234 "description": { | 1205 "description": { |
1235 "description": "Human-readable description of the rule.", | 1206 "description": "Human-readable description of the rule.", |
1236 "type": "string" | 1207 "type": "string" |
(...skipping 11 matching lines...) Expand all Loading... |
1248 "$ref": "LogConfig" | 1219 "$ref": "LogConfig" |
1249 }, | 1220 }, |
1250 "type": "array" | 1221 "type": "array" |
1251 }, | 1222 }, |
1252 "in": { | 1223 "in": { |
1253 "description": "If one or more 'in' clauses are specified, t
he rule matches if\nthe PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these
entries.", | 1224 "description": "If one or more 'in' clauses are specified, t
he rule matches if\nthe PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these
entries.", |
1254 "items": { | 1225 "items": { |
1255 "type": "string" | 1226 "type": "string" |
1256 }, | 1227 }, |
1257 "type": "array" | 1228 "type": "array" |
| 1229 } |
| 1230 }, |
| 1231 "type": "object" |
| 1232 }, |
| 1233 "CryptoKey": { |
| 1234 "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.", |
| 1235 "id": "CryptoKey", |
| 1236 "properties": { |
| 1237 "primary": { |
| 1238 "$ref": "CryptoKeyVersion", |
| 1239 "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." |
1258 }, | 1240 }, |
1259 "permissions": { | 1241 "name": { |
1260 "description": "A permission is a string of form '<service>.
<resource type>.<verb>'\n(e.g., 'storage.buckets.list'). A value of '*' matches
all permissions,\nand a verb part of '*' (e.g., 'storage.buckets.*') matches all
verbs.", | 1242 "description": "Output only. The resource name for this Cryp
toKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.", |
1261 "items": { | 1243 "type": "string" |
1262 "type": "string" | |
1263 }, | |
1264 "type": "array" | |
1265 }, | 1244 }, |
1266 "action": { | 1245 "purpose": { |
1267 "description": "Required", | 1246 "description": "The immutable purpose of this CryptoKey. Cur
rently, the only acceptable\npurpose is ENCRYPT_DECRYPT.", |
1268 "enum": [ | 1247 "enum": [ |
1269 "NO_ACTION", | 1248 "CRYPTO_KEY_PURPOSE_UNSPECIFIED", |
1270 "ALLOW", | 1249 "ENCRYPT_DECRYPT" |
1271 "ALLOW_WITH_LOG", | |
1272 "DENY", | |
1273 "DENY_WITH_LOG", | |
1274 "LOG" | |
1275 ], | 1250 ], |
1276 "enumDescriptions": [ | 1251 "enumDescriptions": [ |
1277 "Default no action.", | 1252 "Not specified.", |
1278 "Matching 'Entries' grant access.", | 1253 "CryptoKeys with this purpose may be used with\nEncrypt
and\nDecrypt." |
1279 "Matching 'Entries' grant access and the caller promises
to log\nthe request per the returned log_configs.", | |
1280 "Matching 'Entries' deny access.", | |
1281 "Matching 'Entries' deny access and the caller promises
to log\nthe request per the returned log_configs.", | |
1282 "Matching 'Entries' tell IAM.Check callers to generate l
ogs." | |
1283 ], | 1254 ], |
1284 "type": "string" | 1255 "type": "string" |
| 1256 }, |
| 1257 "nextRotationTime": { |
| 1258 "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.", |
| 1259 "format": "google-datetime", |
| 1260 "type": "string" |
| 1261 }, |
| 1262 "createTime": { |
| 1263 "description": "Output only. The time at which this CryptoKe
y was created.", |
| 1264 "format": "google-datetime", |
| 1265 "type": "string" |
| 1266 }, |
| 1267 "rotationPeriod": { |
| 1268 "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.", |
| 1269 "format": "google-duration", |
| 1270 "type": "string" |
1285 } | 1271 } |
1286 }, | 1272 }, |
1287 "type": "object" | 1273 "type": "object" |
1288 }, | 1274 }, |
1289 "LogConfig": { | 1275 "LogConfig": { |
1290 "description": "Specifies what kind of log the caller must write\nIn
crement a streamz counter with the specified metric and field names.\n\nMetric n
ames should start with a '/', generally be lowercase-only,\nand end in \"_count\
". Field names should not contain an initial slash.\nThe actual exported metric
names will have \"/iam/policy\" prepended.\n\nField names correspond to IAM requ
est parameters and field values are\ntheir respective values.\n\nAt present the
only supported field names are\n - \"iam_principal\", corresponding to IAMCont
ext.principal;\n - \"\" (empty string), resulting in one aggretated counter wi
th no field.\n\nExamples:\n counter { metric: \"/debug_access_count\" field: \
"iam_principal\" }\n ==> increment counter /iam/policy/backend_debug_access_cou
nt\n {iam_principal=[value of IAMContext.principal]}\n\nA
t this time we do not support:\n* multiple field names (though this may be suppo
rted in the future)\n* decrementing the counter\n* incrementing it by anything o
ther than 1", | 1276 "description": "Specifies what kind of log the caller must write\nIn
crement a streamz counter with the specified metric and field names.\n\nMetric n
ames should start with a '/', generally be lowercase-only,\nand end in \"_count\
". Field names should not contain an initial slash.\nThe actual exported metric
names will have \"/iam/policy\" prepended.\n\nField names correspond to IAM requ
est parameters and field values are\ntheir respective values.\n\nAt present the
only supported field names are\n - \"iam_principal\", corresponding to IAMCont
ext.principal;\n - \"\" (empty string), resulting in one aggretated counter wi
th no field.\n\nExamples:\n counter { metric: \"/debug_access_count\" field: \
"iam_principal\" }\n ==> increment counter /iam/policy/backend_debug_access_cou
nt\n {iam_principal=[value of IAMContext.principal]}\n\nA
t this time we do not support:\n* multiple field names (though this may be suppo
rted in the future)\n* decrementing the counter\n* incrementing it by anything o
ther than 1", |
1291 "id": "LogConfig", | 1277 "id": "LogConfig", |
1292 "properties": { | 1278 "properties": { |
1293 "dataAccess": { | |
1294 "$ref": "DataAccessOptions", | |
1295 "description": "Data access options." | |
1296 }, | |
1297 "cloudAudit": { | 1279 "cloudAudit": { |
1298 "$ref": "CloudAuditOptions", | 1280 "$ref": "CloudAuditOptions", |
1299 "description": "Cloud audit options." | 1281 "description": "Cloud audit options." |
1300 }, | 1282 }, |
1301 "counter": { | 1283 "counter": { |
1302 "$ref": "CounterOptions", | 1284 "$ref": "CounterOptions", |
1303 "description": "Counter options." | 1285 "description": "Counter options." |
| 1286 }, |
| 1287 "dataAccess": { |
| 1288 "$ref": "DataAccessOptions", |
| 1289 "description": "Data access options." |
1304 } | 1290 } |
1305 }, | 1291 }, |
1306 "type": "object" | 1292 "type": "object" |
1307 }, | 1293 }, |
1308 "SetIamPolicyRequest": { | 1294 "SetIamPolicyRequest": { |
1309 "description": "Request message for `SetIamPolicy` method.", | 1295 "description": "Request message for `SetIamPolicy` method.", |
1310 "id": "SetIamPolicyRequest", | 1296 "id": "SetIamPolicyRequest", |
1311 "properties": { | 1297 "properties": { |
1312 "policy": { | 1298 "policy": { |
1313 "$ref": "Policy", | 1299 "$ref": "Policy", |
(...skipping 21 matching lines...) Expand all Loading... |
1335 "format": "byte", | 1321 "format": "byte", |
1336 "type": "string" | 1322 "type": "string" |
1337 } | 1323 } |
1338 }, | 1324 }, |
1339 "type": "object" | 1325 "type": "object" |
1340 }, | 1326 }, |
1341 "Location": { | 1327 "Location": { |
1342 "description": "A resource that represents Google Cloud Platform loc
ation.", | 1328 "description": "A resource that represents Google Cloud Platform loc
ation.", |
1343 "id": "Location", | 1329 "id": "Location", |
1344 "properties": { | 1330 "properties": { |
| 1331 "name": { |
| 1332 "description": "Resource name for the location, which may va
ry between implementations.\nFor example: `\"projects/example-project/locations/
us-east1\"`", |
| 1333 "type": "string" |
| 1334 }, |
1345 "locationId": { | 1335 "locationId": { |
1346 "description": "The canonical id for this location. For exam
ple: `\"us-east1\"`.", | 1336 "description": "The canonical id for this location. For exam
ple: `\"us-east1\"`.", |
1347 "type": "string" | 1337 "type": "string" |
1348 }, | 1338 }, |
1349 "metadata": { | 1339 "metadata": { |
1350 "additionalProperties": { | 1340 "additionalProperties": { |
1351 "description": "Properties of the object. Contains field
@type with type URL.", | 1341 "description": "Properties of the object. Contains field
@type with type URL.", |
1352 "type": "any" | 1342 "type": "any" |
1353 }, | 1343 }, |
1354 "description": "Service-specific metadata. For example the a
vailable capacity at the given\nlocation.", | 1344 "description": "Service-specific metadata. For example the a
vailable capacity at the given\nlocation.", |
1355 "type": "object" | 1345 "type": "object" |
1356 }, | 1346 }, |
1357 "labels": { | 1347 "labels": { |
1358 "additionalProperties": { | 1348 "additionalProperties": { |
1359 "type": "string" | 1349 "type": "string" |
1360 }, | 1350 }, |
1361 "description": "Cross-service attributes for the location. F
or example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}", | 1351 "description": "Cross-service attributes for the location. F
or example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}", |
1362 "type": "object" | 1352 "type": "object" |
1363 }, | |
1364 "name": { | |
1365 "description": "Resource name for the location, which may va
ry between implementations.\nFor example: `\"projects/example-project/locations/
us-east1\"`", | |
1366 "type": "string" | |
1367 } | 1353 } |
1368 }, | 1354 }, |
1369 "type": "object" | 1355 "type": "object" |
1370 }, | 1356 }, |
1371 "ListCryptoKeysResponse": { | 1357 "ListCryptoKeysResponse": { |
1372 "description": "Response message for KeyManagementService.ListCrypto
Keys.", | 1358 "description": "Response message for KeyManagementService.ListCrypto
Keys.", |
1373 "id": "ListCryptoKeysResponse", | 1359 "id": "ListCryptoKeysResponse", |
1374 "properties": { | 1360 "properties": { |
1375 "nextPageToken": { | 1361 "nextPageToken": { |
1376 "description": "A token to retrieve next page of results. Pa
ss this value in\nListCryptoKeysRequest.page_token to retrieve the next page of
results.", | 1362 "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 60 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1437 "The condition is true if the subject (or any element of
it if it is\na set) matches any of the supplied values.", | 1423 "The condition is true if the subject (or any element of
it if it is\na set) matches any of the supplied values.", |
1438 "The condition is true if the subject (or every element
of it if it is\na set) matches none of the supplied values.", | 1424 "The condition is true if the subject (or every element
of it if it is\na set) matches none of the supplied values.", |
1439 "Subject is discharged" | 1425 "Subject is discharged" |
1440 ], | 1426 ], |
1441 "type": "string" | 1427 "type": "string" |
1442 }, | 1428 }, |
1443 "svc": { | 1429 "svc": { |
1444 "description": "Trusted attributes discharged by the service
.", | 1430 "description": "Trusted attributes discharged by the service
.", |
1445 "type": "string" | 1431 "type": "string" |
1446 }, | 1432 }, |
| 1433 "value": { |
| 1434 "description": "DEPRECATED. Use 'values' instead.", |
| 1435 "type": "string" |
| 1436 }, |
1447 "sys": { | 1437 "sys": { |
1448 "description": "Trusted attributes supplied by any service t
hat owns resources and uses\nthe IAM system for access control.", | 1438 "description": "Trusted attributes supplied by any service t
hat owns resources and uses\nthe IAM system for access control.", |
1449 "enum": [ | 1439 "enum": [ |
1450 "NO_ATTR", | 1440 "NO_ATTR", |
1451 "REGION", | 1441 "REGION", |
1452 "SERVICE", | 1442 "SERVICE", |
1453 "NAME", | 1443 "NAME", |
1454 "IP" | 1444 "IP" |
1455 ], | 1445 ], |
1456 "enumDescriptions": [ | 1446 "enumDescriptions": [ |
1457 "Default non-attribute type", | 1447 "Default non-attribute type", |
1458 "Region of the resource", | 1448 "Region of the resource", |
1459 "Service name", | 1449 "Service name", |
1460 "Resource name", | 1450 "Resource name", |
1461 "IP address of the caller" | 1451 "IP address of the caller" |
1462 ], | 1452 ], |
1463 "type": "string" | 1453 "type": "string" |
1464 }, | |
1465 "value": { | |
1466 "description": "DEPRECATED. Use 'values' instead.", | |
1467 "type": "string" | |
1468 } | 1454 } |
1469 }, | 1455 }, |
1470 "type": "object" | 1456 "type": "object" |
1471 }, | 1457 }, |
1472 "CounterOptions": { | 1458 "CounterOptions": { |
1473 "description": "Options for counters", | 1459 "description": "Options for counters", |
1474 "id": "CounterOptions", | 1460 "id": "CounterOptions", |
1475 "properties": { | 1461 "properties": { |
1476 "field": { | 1462 "field": { |
1477 "description": "The field value to attribute.", | 1463 "description": "The field value to attribute.", |
(...skipping 40 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1518 "description": "Response message for KeyManagementService.Decrypt.", | 1504 "description": "Response message for KeyManagementService.Decrypt.", |
1519 "id": "DecryptResponse", | 1505 "id": "DecryptResponse", |
1520 "properties": { | 1506 "properties": { |
1521 "plaintext": { | 1507 "plaintext": { |
1522 "description": "The decrypted data originally supplied in En
cryptRequest.plaintext.", | 1508 "description": "The decrypted data originally supplied in En
cryptRequest.plaintext.", |
1523 "format": "byte", | 1509 "format": "byte", |
1524 "type": "string" | 1510 "type": "string" |
1525 } | 1511 } |
1526 }, | 1512 }, |
1527 "type": "object" | 1513 "type": "object" |
| 1514 }, |
| 1515 "TestIamPermissionsRequest": { |
| 1516 "description": "Request message for `TestIamPermissions` method.", |
| 1517 "id": "TestIamPermissionsRequest", |
| 1518 "properties": { |
| 1519 "permissions": { |
| 1520 "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).", |
| 1521 "items": { |
| 1522 "type": "string" |
| 1523 }, |
| 1524 "type": "array" |
| 1525 } |
| 1526 }, |
| 1527 "type": "object" |
1528 } | 1528 } |
1529 }, | 1529 }, |
1530 "servicePath": "", | 1530 "servicePath": "", |
1531 "title": "Google Cloud Key Management Service (KMS) API", | 1531 "title": "Google Cloud Key Management Service (KMS) API", |
1532 "version": "v1" | 1532 "version": "v1" |
1533 } | 1533 } |
OLD | NEW |