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 "pp": { |
| 29 "default": "true", |
| 30 "description": "Pretty-print response.", |
| 31 "location": "query", |
| 32 "type": "boolean" |
| 33 }, |
| 34 "oauth_token": { |
| 35 "description": "OAuth 2.0 token for the current user.", |
| 36 "location": "query", |
| 37 "type": "string" |
| 38 }, |
| 39 "bearer_token": { |
| 40 "description": "OAuth bearer token.", |
| 41 "location": "query", |
| 42 "type": "string" |
| 43 }, |
28 "upload_protocol": { | 44 "upload_protocol": { |
29 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | 45 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
30 "location": "query", | 46 "location": "query", |
31 "type": "string" | 47 "type": "string" |
32 }, | 48 }, |
33 "prettyPrint": { | 49 "prettyPrint": { |
34 "default": "true", | 50 "default": "true", |
35 "description": "Returns response with indentations and line breaks."
, | 51 "description": "Returns response with indentations and line breaks."
, |
36 "location": "query", | 52 "location": "query", |
37 "type": "boolean" | 53 "type": "boolean" |
(...skipping 49 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
87 }, | 103 }, |
88 "key": { | 104 "key": { |
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.", | 105 "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.", |
90 "location": "query", | 106 "location": "query", |
91 "type": "string" | 107 "type": "string" |
92 }, | 108 }, |
93 "quotaUser": { | 109 "quotaUser": { |
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.", | 110 "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.", |
95 "location": "query", | 111 "location": "query", |
96 "type": "string" | 112 "type": "string" |
97 }, | |
98 "pp": { | |
99 "default": "true", | |
100 "description": "Pretty-print response.", | |
101 "location": "query", | |
102 "type": "boolean" | |
103 }, | |
104 "oauth_token": { | |
105 "description": "OAuth 2.0 token for the current user.", | |
106 "location": "query", | |
107 "type": "string" | |
108 }, | |
109 "bearer_token": { | |
110 "description": "OAuth bearer token.", | |
111 "location": "query", | |
112 "type": "string" | |
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 20 matching lines...) Expand all Loading... |
143 ] | 143 ] |
144 }, | 144 }, |
145 "list": { | 145 "list": { |
146 "description": "Lists information about the supporte
d locations for this service.", | 146 "description": "Lists information about the supporte
d locations for this service.", |
147 "httpMethod": "GET", | 147 "httpMethod": "GET", |
148 "id": "cloudkms.projects.locations.list", | 148 "id": "cloudkms.projects.locations.list", |
149 "parameterOrder": [ | 149 "parameterOrder": [ |
150 "name" | 150 "name" |
151 ], | 151 ], |
152 "parameters": { | 152 "parameters": { |
| 153 "pageSize": { |
| 154 "description": "The standard list page size.
", |
| 155 "format": "int32", |
| 156 "location": "query", |
| 157 "type": "integer" |
| 158 }, |
153 "filter": { | 159 "filter": { |
154 "description": "The standard list filter.", | 160 "description": "The standard list filter.", |
155 "location": "query", | 161 "location": "query", |
156 "type": "string" | 162 "type": "string" |
157 }, | 163 }, |
158 "pageToken": { | 164 "pageToken": { |
159 "description": "The standard list page token
.", | 165 "description": "The standard list page token
.", |
160 "location": "query", | 166 "location": "query", |
161 "type": "string" | 167 "type": "string" |
162 }, | 168 }, |
163 "name": { | 169 "name": { |
164 "description": "The resource that owns the l
ocations collection, if applicable.", | 170 "description": "The resource that owns the l
ocations collection, if applicable.", |
165 "location": "path", | 171 "location": "path", |
166 "pattern": "^projects/[^/]+$", | 172 "pattern": "^projects/[^/]+$", |
167 "required": true, | 173 "required": true, |
168 "type": "string" | 174 "type": "string" |
169 }, | |
170 "pageSize": { | |
171 "description": "The standard list page size.
", | |
172 "format": "int32", | |
173 "location": "query", | |
174 "type": "integer" | |
175 } | 175 } |
176 }, | 176 }, |
177 "path": "v1/{+name}/locations", | 177 "path": "v1/{+name}/locations", |
178 "response": { | 178 "response": { |
179 "$ref": "ListLocationsResponse" | 179 "$ref": "ListLocationsResponse" |
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 "list": { | 189 "list": { |
190 "description": "Lists KeyRings.", | 190 "description": "Lists KeyRings.", |
191 "httpMethod": "GET", | 191 "httpMethod": "GET", |
192 "id": "cloudkms.projects.locations.keyRings.
list", | 192 "id": "cloudkms.projects.locations.keyRings.
list", |
193 "parameterOrder": [ | 193 "parameterOrder": [ |
194 "parent" | 194 "parent" |
195 ], | 195 ], |
196 "parameters": { | 196 "parameters": { |
197 "pageToken": { | |
198 "description": "Optional pagination
token, returned earlier via\nListKeyRingsResponse.next_page_token.", | |
199 "location": "query", | |
200 "type": "string" | |
201 }, | |
202 "pageSize": { | 197 "pageSize": { |
203 "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."
, | 198 "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."
, |
204 "format": "int32", | 199 "format": "int32", |
205 "location": "query", | 200 "location": "query", |
206 "type": "integer" | 201 "type": "integer" |
207 }, | 202 }, |
208 "parent": { | 203 "parent": { |
209 "description": "Required. The resour
ce name of the location associated with the\nKeyRings, in the format `projects/*
/locations/*`.", | 204 "description": "Required. The resour
ce name of the location associated with the\nKeyRings, in the format `projects/*
/locations/*`.", |
210 "location": "path", | 205 "location": "path", |
211 "pattern": "^projects/[^/]+/location
s/[^/]+$", | 206 "pattern": "^projects/[^/]+/location
s/[^/]+$", |
212 "required": true, | 207 "required": true, |
213 "type": "string" | 208 "type": "string" |
| 209 }, |
| 210 "pageToken": { |
| 211 "description": "Optional pagination
token, returned earlier via\nListKeyRingsResponse.next_page_token.", |
| 212 "location": "query", |
| 213 "type": "string" |
214 } | 214 } |
215 }, | 215 }, |
216 "path": "v1/{+parent}/keyRings", | 216 "path": "v1/{+parent}/keyRings", |
217 "response": { | 217 "response": { |
218 "$ref": "ListKeyRingsResponse" | 218 "$ref": "ListKeyRingsResponse" |
219 }, | 219 }, |
220 "scopes": [ | 220 "scopes": [ |
221 "https://www.googleapis.com/auth/cloud-p
latform" | 221 "https://www.googleapis.com/auth/cloud-p
latform" |
222 ] | 222 ] |
223 }, | 223 }, |
(...skipping 128 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 "encrypt": { | |
363 "description": "Encrypts data, so th
at it can only be recovered by a call to Decrypt.", | |
364 "httpMethod": "POST", | |
365 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.encrypt", | |
366 "parameterOrder": [ | |
367 "name" | |
368 ], | |
369 "parameters": { | |
370 "name": { | |
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.", | |
372 "location": "path", | |
373 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/.+$", | |
374 "required": true, | |
375 "type": "string" | |
376 } | |
377 }, | |
378 "path": "v1/{+name}:encrypt", | |
379 "request": { | |
380 "$ref": "EncryptRequest" | |
381 }, | |
382 "response": { | |
383 "$ref": "EncryptResponse" | |
384 }, | |
385 "scopes": [ | |
386 "https://www.googleapis.com/auth
/cloud-platform" | |
387 ] | |
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 }, | |
416 "create": { | |
417 "description": "Create a new CryptoK
ey within a KeyRing.\n\nCryptoKey.purpose is required.", | |
418 "httpMethod": "POST", | |
419 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.create", | |
420 "parameterOrder": [ | |
421 "parent" | |
422 ], | |
423 "parameters": { | |
424 "cryptoKeyId": { | |
425 "description": "Required. It
must be unique within a KeyRing and match the regular\nexpression `[a-zA-Z0-9_-
]{1,63}`", | |
426 "location": "query", | |
427 "type": "string" | |
428 }, | |
429 "parent": { | |
430 "description": "Required. Th
e name of the KeyRing associated with the\nCryptoKeys.", | |
431 "location": "path", | |
432 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+$", | |
433 "required": true, | |
434 "type": "string" | |
435 } | |
436 }, | |
437 "path": "v1/{+parent}/cryptoKeys", | |
438 "request": { | |
439 "$ref": "CryptoKey" | |
440 }, | |
441 "response": { | |
442 "$ref": "CryptoKey" | |
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": { | 362 "patch": { |
500 "description": "Update a CryptoKey."
, | 363 "description": "Update a CryptoKey."
, |
501 "httpMethod": "PATCH", | 364 "httpMethod": "PATCH", |
502 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.patch", | 365 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.patch", |
503 "parameterOrder": [ | 366 "parameterOrder": [ |
504 "name" | 367 "name" |
505 ], | 368 ], |
506 "parameters": { | 369 "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": { | 370 "updateMask": { |
515 "description": "Required lis
t of fields to be updated in this request.", | 371 "description": "Required lis
t of fields to be updated in this request.", |
516 "format": "google-fieldmask"
, | 372 "format": "google-fieldmask"
, |
517 "location": "query", | 373 "location": "query", |
518 "type": "string" | 374 "type": "string" |
| 375 }, |
| 376 "name": { |
| 377 "description": "Output only.
The resource name for this CryptoKey in the format\n`projects/*/locations/*/key
Rings/*/cryptoKeys/*`.", |
| 378 "location": "path", |
| 379 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", |
| 380 "required": true, |
| 381 "type": "string" |
519 } | 382 } |
520 }, | 383 }, |
521 "path": "v1/{+name}", | 384 "path": "v1/{+name}", |
522 "request": { | 385 "request": { |
523 "$ref": "CryptoKey" | 386 "$ref": "CryptoKey" |
524 }, | 387 }, |
525 "response": { | 388 "response": { |
526 "$ref": "CryptoKey" | 389 "$ref": "CryptoKey" |
527 }, | 390 }, |
528 "scopes": [ | 391 "scopes": [ |
(...skipping 13 matching lines...) Expand all Loading... |
542 "location": "path", | 405 "location": "path", |
543 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", | 406 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", |
544 "required": true, | 407 "required": true, |
545 "type": "string" | 408 "type": "string" |
546 } | 409 } |
547 }, | 410 }, |
548 "path": "v1/{+name}", | 411 "path": "v1/{+name}", |
549 "response": { | 412 "response": { |
550 "$ref": "CryptoKey" | 413 "$ref": "CryptoKey" |
551 }, | 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 "pageSize": { |
| 482 "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.", |
| 483 "format": "int32", |
| 484 "location": "query", |
| 485 "type": "integer" |
| 486 }, |
| 487 "parent": { |
| 488 "description": "Required. Th
e resource name of the KeyRing to list, in the format\n`projects/*/locations/*/k
eyRings/*`.", |
| 489 "location": "path", |
| 490 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+$", |
| 491 "required": true, |
| 492 "type": "string" |
| 493 }, |
| 494 "pageToken": { |
| 495 "description": "Optional pag
ination token, returned earlier via\nListCryptoKeysResponse.next_page_token.", |
| 496 "location": "query", |
| 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": { |
| 509 "description": "Encrypts data, so th
at it can only be recovered by a call to Decrypt.", |
| 510 "httpMethod": "POST", |
| 511 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.encrypt", |
| 512 "parameterOrder": [ |
| 513 "name" |
| 514 ], |
| 515 "parameters": { |
| 516 "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.", |
| 518 "location": "path", |
| 519 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/.+$", |
| 520 "required": true, |
| 521 "type": "string" |
| 522 } |
| 523 }, |
| 524 "path": "v1/{+name}:encrypt", |
| 525 "request": { |
| 526 "$ref": "EncryptRequest" |
| 527 }, |
| 528 "response": { |
| 529 "$ref": "EncryptResponse" |
| 530 }, |
| 531 "scopes": [ |
| 532 "https://www.googleapis.com/auth
/cloud-platform" |
| 533 ] |
| 534 }, |
| 535 "create": { |
| 536 "description": "Create a new CryptoK
ey within a KeyRing.\n\nCryptoKey.purpose is required.", |
| 537 "httpMethod": "POST", |
| 538 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.create", |
| 539 "parameterOrder": [ |
| 540 "parent" |
| 541 ], |
| 542 "parameters": { |
| 543 "parent": { |
| 544 "description": "Required. Th
e name of the KeyRing associated with the\nCryptoKeys.", |
| 545 "location": "path", |
| 546 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+$", |
| 547 "required": true, |
| 548 "type": "string" |
| 549 }, |
| 550 "cryptoKeyId": { |
| 551 "description": "Required. It
must be unique within a KeyRing and match the regular\nexpression `[a-zA-Z0-9_-
]{1,63}`", |
| 552 "location": "query", |
| 553 "type": "string" |
| 554 } |
| 555 }, |
| 556 "path": "v1/{+parent}/cryptoKeys", |
| 557 "request": { |
| 558 "$ref": "CryptoKey" |
| 559 }, |
| 560 "response": { |
| 561 "$ref": "CryptoKey" |
| 562 }, |
552 "scopes": [ | 563 "scopes": [ |
553 "https://www.googleapis.com/auth
/cloud-platform" | 564 "https://www.googleapis.com/auth
/cloud-platform" |
554 ] | 565 ] |
555 }, | 566 }, |
556 "testIamPermissions": { | 567 "setIamPolicy": { |
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.", | 568 "description": "Sets the access cont
rol policy on the specified resource. Replaces any\nexisting policy.", |
558 "httpMethod": "POST", | 569 "httpMethod": "POST", |
559 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.testIamPermissions", | 570 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.setIamPolicy", |
560 "parameterOrder": [ | 571 "parameterOrder": [ |
561 "resource" | 572 "resource" |
562 ], | 573 ], |
563 "parameters": { | 574 "parameters": { |
564 "resource": { | 575 "resource": { |
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.", | 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.", |
566 "location": "path", | 577 "location": "path", |
567 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", | 578 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", |
568 "required": true, | 579 "required": true, |
569 "type": "string" | 580 "type": "string" |
570 } | 581 } |
571 }, | 582 }, |
572 "path": "v1/{+resource}:testIamPermi
ssions", | 583 "path": "v1/{+resource}:setIamPolicy
", |
573 "request": { | 584 "request": { |
574 "$ref": "TestIamPermissionsReque
st" | 585 "$ref": "SetIamPolicyRequest" |
575 }, | 586 }, |
576 "response": { | 587 "response": { |
577 "$ref": "TestIamPermissionsRespo
nse" | 588 "$ref": "Policy" |
578 }, | 589 }, |
579 "scopes": [ | 590 "scopes": [ |
580 "https://www.googleapis.com/auth
/cloud-platform" | 591 "https://www.googleapis.com/auth
/cloud-platform" |
581 ] | 592 ] |
582 }, | 593 }, |
583 "decrypt": { | 594 "updatePrimaryVersion": { |
584 "description": "Decrypts data that w
as protected by Encrypt.", | 595 "description": "Update the version o
f a CryptoKey that will be used in Encrypt", |
585 "httpMethod": "POST", | 596 "httpMethod": "POST", |
586 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.decrypt", | 597 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.updatePrimaryVersion", |
587 "parameterOrder": [ | 598 "parameterOrder": [ |
588 "name" | 599 "name" |
589 ], | 600 ], |
590 "parameters": { | 601 "parameters": { |
591 "name": { | 602 "name": { |
592 "description": "Required. Th
e resource name of the CryptoKey to use for decryption.\nThe server will choose
the appropriate version.", | 603 "description": "The resource
name of the CryptoKey to update.", |
593 "location": "path", | 604 "location": "path", |
594 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", | 605 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", |
595 "required": true, | 606 "required": true, |
596 "type": "string" | 607 "type": "string" |
597 } | 608 } |
598 }, | 609 }, |
599 "path": "v1/{+name}:decrypt", | 610 "path": "v1/{+name}:updatePrimaryVer
sion", |
600 "request": { | 611 "request": { |
601 "$ref": "DecryptRequest" | 612 "$ref": "UpdateCryptoKeyPrimaryV
ersionRequest" |
602 }, | 613 }, |
603 "response": { | 614 "response": { |
604 "$ref": "DecryptResponse" | 615 "$ref": "CryptoKey" |
605 }, | 616 }, |
606 "scopes": [ | 617 "scopes": [ |
607 "https://www.googleapis.com/auth
/cloud-platform" | 618 "https://www.googleapis.com/auth
/cloud-platform" |
608 ] | 619 ] |
609 }, | 620 }, |
610 "list": { | 621 "getIamPolicy": { |
611 "description": "Lists CryptoKeys.", | 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.", |
612 "httpMethod": "GET", | 623 "httpMethod": "GET", |
613 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.list", | 624 "id": "cloudkms.projects.locations.k
eyRings.cryptoKeys.getIamPolicy", |
614 "parameterOrder": [ | 625 "parameterOrder": [ |
615 "parent" | 626 "resource" |
616 ], | 627 ], |
617 "parameters": { | 628 "parameters": { |
618 "pageToken": { | 629 "resource": { |
619 "description": "Optional pag
ination token, returned earlier via\nListCryptoKeysResponse.next_page_token.", | 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.", |
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/[^/]+$", | 632 "pattern": "^projects/[^/]+/
locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", |
633 "required": true, | 633 "required": true, |
634 "type": "string" | 634 "type": "string" |
635 } | 635 } |
636 }, | 636 }, |
637 "path": "v1/{+parent}/cryptoKeys", | 637 "path": "v1/{+resource}:getIamPolicy
", |
638 "response": { | 638 "response": { |
639 "$ref": "ListCryptoKeysResponse" | 639 "$ref": "Policy" |
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": { | |
650 "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.", | |
651 "httpMethod": "PATCH", | |
652 "id": "cloudkms.projects.loc
ations.keyRings.cryptoKeys.cryptoKeyVersions.patch", | |
653 "parameterOrder": [ | |
654 "name" | |
655 ], | |
656 "parameters": { | |
657 "updateMask": { | |
658 "description": "Requ
ired list of fields to be updated in this request.", | |
659 "format": "google-fi
eldmask", | |
660 "location": "query", | |
661 "type": "string" | |
662 }, | |
663 "name": { | |
664 "description": "Outp
ut only. The resource name for this CryptoKeyVersion in the format\n`projects/*/
locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.", | |
665 "location": "path", | |
666 "pattern": "^project
s/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$
", | |
667 "required": true, | |
668 "type": "string" | |
669 } | |
670 }, | |
671 "path": "v1/{+name}", | |
672 "request": { | |
673 "$ref": "CryptoKeyVersio
n" | |
674 }, | |
675 "response": { | |
676 "$ref": "CryptoKeyVersio
n" | |
677 }, | |
678 "scopes": [ | |
679 "https://www.googleapis.
com/auth/cloud-platform" | |
680 ] | |
681 }, | |
682 "get": { | |
683 "description": "Returns meta
data for a given CryptoKeyVersion.", | |
684 "httpMethod": "GET", | |
685 "id": "cloudkms.projects.loc
ations.keyRings.cryptoKeys.cryptoKeyVersions.get", | |
686 "parameterOrder": [ | |
687 "name" | |
688 ], | |
689 "parameters": { | |
690 "name": { | |
691 "description": "The
name of the CryptoKeyVersion to get.", | |
692 "location": "path", | |
693 "pattern": "^project
s/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$
", | |
694 "required": true, | |
695 "type": "string" | |
696 } | |
697 }, | |
698 "path": "v1/{+name}", | |
699 "response": { | |
700 "$ref": "CryptoKeyVersio
n" | |
701 }, | |
702 "scopes": [ | |
703 "https://www.googleapis.
com/auth/cloud-platform" | |
704 ] | |
705 }, | |
706 "list": { | 649 "list": { |
707 "description": "Lists Crypto
KeyVersions.", | 650 "description": "Lists Crypto
KeyVersions.", |
708 "httpMethod": "GET", | 651 "httpMethod": "GET", |
709 "id": "cloudkms.projects.loc
ations.keyRings.cryptoKeys.cryptoKeyVersions.list", | 652 "id": "cloudkms.projects.loc
ations.keyRings.cryptoKeys.cryptoKeyVersions.list", |
710 "parameterOrder": [ | 653 "parameterOrder": [ |
711 "parent" | 654 "parent" |
712 ], | 655 ], |
713 "parameters": { | 656 "parameters": { |
714 "pageSize": { | 657 "pageSize": { |
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.", | 658 "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.", |
(...skipping 95 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
811 "path": "v1/{+name}:restore"
, | 754 "path": "v1/{+name}:restore"
, |
812 "request": { | 755 "request": { |
813 "$ref": "RestoreCryptoKe
yVersionRequest" | 756 "$ref": "RestoreCryptoKe
yVersionRequest" |
814 }, | 757 }, |
815 "response": { | 758 "response": { |
816 "$ref": "CryptoKeyVersio
n" | 759 "$ref": "CryptoKeyVersio
n" |
817 }, | 760 }, |
818 "scopes": [ | 761 "scopes": [ |
819 "https://www.googleapis.
com/auth/cloud-platform" | 762 "https://www.googleapis.
com/auth/cloud-platform" |
820 ] | 763 ] |
| 764 }, |
| 765 "patch": { |
| 766 "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.", |
| 767 "httpMethod": "PATCH", |
| 768 "id": "cloudkms.projects.loc
ations.keyRings.cryptoKeys.cryptoKeyVersions.patch", |
| 769 "parameterOrder": [ |
| 770 "name" |
| 771 ], |
| 772 "parameters": { |
| 773 "updateMask": { |
| 774 "description": "Requ
ired list of fields to be updated in this request.", |
| 775 "format": "google-fi
eldmask", |
| 776 "location": "query", |
| 777 "type": "string" |
| 778 }, |
| 779 "name": { |
| 780 "description": "Outp
ut only. The resource name for this CryptoKeyVersion in the format\n`projects/*/
locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.", |
| 781 "location": "path", |
| 782 "pattern": "^project
s/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$
", |
| 783 "required": true, |
| 784 "type": "string" |
| 785 } |
| 786 }, |
| 787 "path": "v1/{+name}", |
| 788 "request": { |
| 789 "$ref": "CryptoKeyVersio
n" |
| 790 }, |
| 791 "response": { |
| 792 "$ref": "CryptoKeyVersio
n" |
| 793 }, |
| 794 "scopes": [ |
| 795 "https://www.googleapis.
com/auth/cloud-platform" |
| 796 ] |
| 797 }, |
| 798 "get": { |
| 799 "description": "Returns meta
data for a given CryptoKeyVersion.", |
| 800 "httpMethod": "GET", |
| 801 "id": "cloudkms.projects.loc
ations.keyRings.cryptoKeys.cryptoKeyVersions.get", |
| 802 "parameterOrder": [ |
| 803 "name" |
| 804 ], |
| 805 "parameters": { |
| 806 "name": { |
| 807 "description": "The
name of the CryptoKeyVersion to get.", |
| 808 "location": "path", |
| 809 "pattern": "^project
s/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$
", |
| 810 "required": true, |
| 811 "type": "string" |
| 812 } |
| 813 }, |
| 814 "path": "v1/{+name}", |
| 815 "response": { |
| 816 "$ref": "CryptoKeyVersio
n" |
| 817 }, |
| 818 "scopes": [ |
| 819 "https://www.googleapis.
com/auth/cloud-platform" |
| 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": "20170725", | 833 "revision": "20170815", |
834 "rootUrl": "https://cloudkms.googleapis.com/", | 834 "rootUrl": "https://cloudkms.googleapis.com/", |
835 "schemas": { | 835 "schemas": { |
836 "EncryptResponse": { | 836 "TestIamPermissionsRequest": { |
837 "description": "Response message for KeyManagementService.Encrypt.", | 837 "description": "Request message for `TestIamPermissions` method.", |
838 "id": "EncryptResponse", | 838 "id": "TestIamPermissionsRequest", |
839 "properties": { | 839 "properties": { |
840 "name": { | 840 "permissions": { |
841 "description": "The resource name of the CryptoKeyVersion us
ed in encryption.", | 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).", |
842 "type": "string" | 842 "items": { |
| 843 "type": "string" |
| 844 }, |
| 845 "type": "array" |
| 846 } |
| 847 }, |
| 848 "type": "object" |
| 849 }, |
| 850 "ListLocationsResponse": { |
| 851 "description": "The response message for Locations.ListLocations.", |
| 852 "id": "ListLocationsResponse", |
| 853 "properties": { |
| 854 "locations": { |
| 855 "description": "A list of locations that matches the specifi
ed filter in the request.", |
| 856 "items": { |
| 857 "$ref": "Location" |
| 858 }, |
| 859 "type": "array" |
843 }, | 860 }, |
844 "ciphertext": { | 861 "nextPageToken": { |
845 "description": "The encrypted data.", | 862 "description": "The standard List next-page token.", |
846 "format": "byte", | |
847 "type": "string" | 863 "type": "string" |
848 } | 864 } |
849 }, | 865 }, |
850 "type": "object" | 866 "type": "object" |
851 }, | 867 }, |
852 "Policy": { | 868 "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).", | 869 "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", | 870 "id": "Policy", |
855 "properties": { | 871 "properties": { |
| 872 "auditConfigs": { |
| 873 "description": "Specifies cloud audit logging configuration
for this policy.", |
| 874 "items": { |
| 875 "$ref": "AuditConfig" |
| 876 }, |
| 877 "type": "array" |
| 878 }, |
| 879 "bindings": { |
| 880 "description": "Associates a list of `members` to a `role`.\
n`bindings` with no members will result in an error.", |
| 881 "items": { |
| 882 "$ref": "Binding" |
| 883 }, |
| 884 "type": "array" |
| 885 }, |
856 "etag": { | 886 "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.", | 887 "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", | 888 "format": "byte", |
859 "type": "string" | 889 "type": "string" |
860 }, | 890 }, |
861 "iamOwned": { | 891 "iamOwned": { |
862 "type": "boolean" | 892 "type": "boolean" |
863 }, | 893 }, |
864 "rules": { | 894 "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.", | 895 "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.", |
866 "items": { | 896 "items": { |
867 "$ref": "Rule" | 897 "$ref": "Rule" |
868 }, | 898 }, |
869 "type": "array" | 899 "type": "array" |
870 }, | 900 }, |
871 "version": { | 901 "version": { |
872 "description": "Version of the `Policy`. The default version
is 0.", | 902 "description": "Version of the `Policy`. The default version
is 0.", |
873 "format": "int32", | 903 "format": "int32", |
874 "type": "integer" | 904 "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" | |
887 }, | |
888 "type": "array" | |
889 } | 905 } |
890 }, | 906 }, |
891 "type": "object" | 907 "type": "object" |
892 }, | 908 }, |
893 "KeyRing": { | 909 "KeyRing": { |
894 "description": "A KeyRing is a toplevel logical grouping of CryptoKe
ys.", | 910 "description": "A KeyRing is a toplevel logical grouping of CryptoKe
ys.", |
895 "id": "KeyRing", | 911 "id": "KeyRing", |
896 "properties": { | 912 "properties": { |
897 "createTime": { | 913 "createTime": { |
898 "description": "Output only. The time at which this KeyRing
was created.", | 914 "description": "Output only. The time at which this KeyRing
was created.", |
899 "format": "google-datetime", | 915 "format": "google-datetime", |
900 "type": "string" | 916 "type": "string" |
901 }, | 917 }, |
902 "name": { | 918 "name": { |
903 "description": "Output only. The resource name for the KeyRi
ng in the format\n`projects/*/locations/*/keyRings/*`.", | 919 "description": "Output only. The resource name for the KeyRi
ng in the format\n`projects/*/locations/*/keyRings/*`.", |
904 "type": "string" | 920 "type": "string" |
905 } | 921 } |
906 }, | 922 }, |
907 "type": "object" | 923 "type": "object" |
908 }, | 924 }, |
909 "ListLocationsResponse": { | 925 "EncryptResponse": { |
910 "description": "The response message for Locations.ListLocations.", | 926 "description": "Response message for KeyManagementService.Encrypt.", |
911 "id": "ListLocationsResponse", | 927 "id": "EncryptResponse", |
912 "properties": { | 928 "properties": { |
913 "locations": { | 929 "ciphertext": { |
914 "description": "A list of locations that matches the specifi
ed filter in the request.", | 930 "description": "The encrypted data.", |
915 "items": { | 931 "format": "byte", |
916 "$ref": "Location" | 932 "type": "string" |
917 }, | |
918 "type": "array" | |
919 }, | 933 }, |
920 "nextPageToken": { | 934 "name": { |
921 "description": "The standard List next-page token.", | 935 "description": "The resource name of the CryptoKeyVersion us
ed in encryption.", |
922 "type": "string" | 936 "type": "string" |
923 } | 937 } |
924 }, | 938 }, |
| 939 "type": "object" |
| 940 }, |
| 941 "UpdateCryptoKeyPrimaryVersionRequest": { |
| 942 "description": "Request message for KeyManagementService.UpdateCrypt
oKeyPrimaryVersion.", |
| 943 "id": "UpdateCryptoKeyPrimaryVersionRequest", |
| 944 "properties": { |
| 945 "cryptoKeyVersionId": { |
| 946 "description": "The id of the child CryptoKeyVersion to use
as primary.", |
| 947 "type": "string" |
| 948 } |
| 949 }, |
925 "type": "object" | 950 "type": "object" |
926 }, | 951 }, |
927 "RestoreCryptoKeyVersionRequest": { | 952 "RestoreCryptoKeyVersionRequest": { |
928 "description": "Request message for KeyManagementService.RestoreCryp
toKeyVersion.", | 953 "description": "Request message for KeyManagementService.RestoreCryp
toKeyVersion.", |
929 "id": "RestoreCryptoKeyVersionRequest", | 954 "id": "RestoreCryptoKeyVersionRequest", |
930 "properties": {}, | 955 "properties": {}, |
931 "type": "object" | 956 "type": "object" |
932 }, | 957 }, |
933 "UpdateCryptoKeyPrimaryVersionRequest": { | 958 "DataAccessOptions": { |
934 "description": "Request message for KeyManagementService.UpdateCrypt
oKeyPrimaryVersion.", | 959 "description": "Write a Data Access (Gin) log", |
935 "id": "UpdateCryptoKeyPrimaryVersionRequest", | 960 "id": "DataAccessOptions", |
936 "properties": { | 961 "properties": { |
937 "cryptoKeyVersionId": { | 962 "logMode": { |
938 "description": "The id of the child CryptoKeyVersion to use
as primary.", | 963 "description": "Whether Gin logging should happen in a fail-
closed manner at the caller.\nThis is relevant only in the LocalIAM implementati
on, for now.", |
| 964 "enum": [ |
| 965 "LOG_MODE_UNSPECIFIED", |
| 966 "LOG_FAIL_CLOSED" |
| 967 ], |
| 968 "enumDescriptions": [ |
| 969 "Client is not required to write a partial Gin log immed
iately after\nthe authorization check. If client chooses to write one and it fai
ls,\nclient may either fail open (allow the operation to continue) or\nfail clos
ed (handle as a DENY outcome).", |
| 970 "The application's operation in the context of which thi
s authorization\ncheck is being made may only be performed if it is successfully
logged\nto Gin. For instance, the authorization library may satisfy this\noblig
ation by emitting a partial log entry at authorization check time\nand only retu
rning ALLOW to the application if it succeeds.\n\nIf a matching Rule has this di
rective, but the client has not indicated\nthat it will honor such requirements,
then the IAM check will result in\nauthorization failure by setting CheckPolicy
Response.success=false." |
| 971 ], |
939 "type": "string" | 972 "type": "string" |
940 } | 973 } |
941 }, | 974 }, |
942 "type": "object" | 975 "type": "object" |
943 }, | 976 }, |
944 "ListKeyRingsResponse": { | 977 "ListKeyRingsResponse": { |
945 "description": "Response message for KeyManagementService.ListKeyRin
gs.", | 978 "description": "Response message for KeyManagementService.ListKeyRin
gs.", |
946 "id": "ListKeyRingsResponse", | 979 "id": "ListKeyRingsResponse", |
947 "properties": { | 980 "properties": { |
| 981 "keyRings": { |
| 982 "description": "The list of KeyRings.", |
| 983 "items": { |
| 984 "$ref": "KeyRing" |
| 985 }, |
| 986 "type": "array" |
| 987 }, |
948 "nextPageToken": { | 988 "nextPageToken": { |
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.", | 989 "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.", |
950 "type": "string" | 990 "type": "string" |
951 }, | 991 }, |
952 "totalSize": { | 992 "totalSize": { |
953 "description": "The total number of KeyRings that matched th
e query.", | 993 "description": "The total number of KeyRings that matched th
e query.", |
954 "format": "int32", | 994 "format": "int32", |
955 "type": "integer" | 995 "type": "integer" |
956 }, | |
957 "keyRings": { | |
958 "description": "The list of KeyRings.", | |
959 "items": { | |
960 "$ref": "KeyRing" | |
961 }, | |
962 "type": "array" | |
963 } | 996 } |
964 }, | 997 }, |
965 "type": "object" | 998 "type": "object" |
966 }, | 999 }, |
967 "DataAccessOptions": { | |
968 "description": "Write a Data Access (Gin) log", | |
969 "id": "DataAccessOptions", | |
970 "properties": {}, | |
971 "type": "object" | |
972 }, | |
973 "AuditConfig": { | 1000 "AuditConfig": { |
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.", | 1001 "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.", |
975 "id": "AuditConfig", | 1002 "id": "AuditConfig", |
976 "properties": { | 1003 "properties": { |
977 "service": { | |
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.", | |
979 "type": "string" | |
980 }, | |
981 "auditLogConfigs": { | 1004 "auditLogConfigs": { |
982 "description": "The configuration for logging of each type o
f permission.\nNext ID: 4", | 1005 "description": "The configuration for logging of each type o
f permission.\nNext ID: 4", |
983 "items": { | 1006 "items": { |
984 "$ref": "AuditLogConfig" | 1007 "$ref": "AuditLogConfig" |
985 }, | 1008 }, |
986 "type": "array" | 1009 "type": "array" |
987 }, | 1010 }, |
988 "exemptedMembers": { | 1011 "exemptedMembers": { |
989 "items": { | 1012 "items": { |
990 "type": "string" | 1013 "type": "string" |
991 }, | 1014 }, |
992 "type": "array" | 1015 "type": "array" |
| 1016 }, |
| 1017 "service": { |
| 1018 "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.", |
| 1019 "type": "string" |
993 } | 1020 } |
994 }, | 1021 }, |
995 "type": "object" | 1022 "type": "object" |
996 }, | 1023 }, |
997 "CryptoKeyVersion": { | 1024 "CryptoKeyVersion": { |
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.", | 1025 "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.", |
999 "id": "CryptoKeyVersion", | 1026 "id": "CryptoKeyVersion", |
1000 "properties": { | 1027 "properties": { |
| 1028 "createTime": { |
| 1029 "description": "Output only. The time at which this CryptoKe
yVersion was created.", |
| 1030 "format": "google-datetime", |
| 1031 "type": "string" |
| 1032 }, |
1001 "state": { | 1033 "state": { |
1002 "description": "The current state of the CryptoKeyVersion.", | 1034 "description": "The current state of the CryptoKeyVersion.", |
1003 "enum": [ | 1035 "enum": [ |
1004 "CRYPTO_KEY_VERSION_STATE_UNSPECIFIED", | 1036 "CRYPTO_KEY_VERSION_STATE_UNSPECIFIED", |
1005 "ENABLED", | 1037 "ENABLED", |
1006 "DISABLED", | 1038 "DISABLED", |
1007 "DESTROYED", | 1039 "DESTROYED", |
1008 "DESTROY_SCHEDULED" | 1040 "DESTROY_SCHEDULED" |
1009 ], | 1041 ], |
1010 "enumDescriptions": [ | 1042 "enumDescriptions": [ |
(...skipping 11 matching lines...) Expand all Loading... |
1022 }, | 1054 }, |
1023 "destroyEventTime": { | 1055 "destroyEventTime": { |
1024 "description": "Output only. The time this CryptoKeyVersion'
s key material was\ndestroyed. Only present if state is\nDESTROYED.", | 1056 "description": "Output only. The time this CryptoKeyVersion'
s key material was\ndestroyed. Only present if state is\nDESTROYED.", |
1025 "format": "google-datetime", | 1057 "format": "google-datetime", |
1026 "type": "string" | 1058 "type": "string" |
1027 }, | 1059 }, |
1028 "destroyTime": { | 1060 "destroyTime": { |
1029 "description": "Output only. The time this CryptoKeyVersion'
s key material is scheduled\nfor destruction. Only present if state is\nDESTROY_
SCHEDULED.", | 1061 "description": "Output only. The time this CryptoKeyVersion'
s key material is scheduled\nfor destruction. Only present if state is\nDESTROY_
SCHEDULED.", |
1030 "format": "google-datetime", | 1062 "format": "google-datetime", |
1031 "type": "string" | 1063 "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" | |
1037 } | 1064 } |
1038 }, | 1065 }, |
1039 "type": "object" | 1066 "type": "object" |
1040 }, | 1067 }, |
1041 "CloudAuditOptions": { | 1068 "CloudAuditOptions": { |
1042 "description": "Write a Cloud Audit log", | 1069 "description": "Write a Cloud Audit log", |
1043 "id": "CloudAuditOptions", | 1070 "id": "CloudAuditOptions", |
1044 "properties": { | 1071 "properties": { |
1045 "logName": { | 1072 "logName": { |
1046 "description": "The log_name to populate in the Cloud Audit
Record.", | 1073 "description": "The log_name to populate in the Cloud Audit
Record.", |
(...skipping 31 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1078 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", | 1105 "description": "Role that is assigned to `members`.\nFor exa
mple, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", |
1079 "type": "string" | 1106 "type": "string" |
1080 } | 1107 } |
1081 }, | 1108 }, |
1082 "type": "object" | 1109 "type": "object" |
1083 }, | 1110 }, |
1084 "Expr": { | 1111 "Expr": { |
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\"", | 1112 "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\"", |
1086 "id": "Expr", | 1113 "id": "Expr", |
1087 "properties": { | 1114 "properties": { |
1088 "description": { | |
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.", | |
1090 "type": "string" | |
1091 }, | |
1092 "expression": { | |
1093 "description": "Textual representation of an expression in\n
Common Expression Language syntax.\n\nThe application context of the containing
message determines which\nwell-known feature set of CEL is supported.", | |
1094 "type": "string" | |
1095 }, | |
1096 "location": { | 1115 "location": { |
1097 "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.", | 1116 "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.", |
1098 "type": "string" | 1117 "type": "string" |
1099 }, | 1118 }, |
1100 "title": { | 1119 "title": { |
1101 "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.", | 1120 "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.", |
1102 "type": "string" | 1121 "type": "string" |
| 1122 }, |
| 1123 "description": { |
| 1124 "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.", |
| 1125 "type": "string" |
| 1126 }, |
| 1127 "expression": { |
| 1128 "description": "Textual representation of an expression in\n
Common Expression Language syntax.\n\nThe application context of the containing
message determines which\nwell-known feature set of CEL is supported.", |
| 1129 "type": "string" |
1103 } | 1130 } |
1104 }, | 1131 }, |
1105 "type": "object" | 1132 "type": "object" |
1106 }, | 1133 }, |
1107 "EncryptRequest": { | 1134 "EncryptRequest": { |
1108 "description": "Request message for KeyManagementService.Encrypt.", | 1135 "description": "Request message for KeyManagementService.Encrypt.", |
1109 "id": "EncryptRequest", | 1136 "id": "EncryptRequest", |
1110 "properties": { | 1137 "properties": { |
1111 "additionalAuthenticatedData": { | 1138 "additionalAuthenticatedData": { |
1112 "description": "Optional data that, if specified, must also
be provided during decryption\nthrough DecryptRequest.additional_authenticated_d
ata. Must be no\nlarger than 64KiB.", | 1139 "description": "Optional data that, if specified, must also
be provided during decryption\nthrough DecryptRequest.additional_authenticated_d
ata. Must be no\nlarger than 64KiB.", |
(...skipping 44 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1157 } | 1184 } |
1158 }, | 1185 }, |
1159 "type": "object" | 1186 "type": "object" |
1160 }, | 1187 }, |
1161 "DestroyCryptoKeyVersionRequest": { | 1188 "DestroyCryptoKeyVersionRequest": { |
1162 "description": "Request message for KeyManagementService.DestroyCryp
toKeyVersion.", | 1189 "description": "Request message for KeyManagementService.DestroyCryp
toKeyVersion.", |
1163 "id": "DestroyCryptoKeyVersionRequest", | 1190 "id": "DestroyCryptoKeyVersionRequest", |
1164 "properties": {}, | 1191 "properties": {}, |
1165 "type": "object" | 1192 "type": "object" |
1166 }, | 1193 }, |
| 1194 "CryptoKey": { |
| 1195 "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.", |
| 1196 "id": "CryptoKey", |
| 1197 "properties": { |
| 1198 "purpose": { |
| 1199 "description": "The immutable purpose of this CryptoKey. Cur
rently, the only acceptable\npurpose is ENCRYPT_DECRYPT.", |
| 1200 "enum": [ |
| 1201 "CRYPTO_KEY_PURPOSE_UNSPECIFIED", |
| 1202 "ENCRYPT_DECRYPT" |
| 1203 ], |
| 1204 "enumDescriptions": [ |
| 1205 "Not specified.", |
| 1206 "CryptoKeys with this purpose may be used with\nEncrypt
and\nDecrypt." |
| 1207 ], |
| 1208 "type": "string" |
| 1209 }, |
| 1210 "nextRotationTime": { |
| 1211 "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.", |
| 1212 "format": "google-datetime", |
| 1213 "type": "string" |
| 1214 }, |
| 1215 "createTime": { |
| 1216 "description": "Output only. The time at which this CryptoKe
y was created.", |
| 1217 "format": "google-datetime", |
| 1218 "type": "string" |
| 1219 }, |
| 1220 "rotationPeriod": { |
| 1221 "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.", |
| 1222 "format": "google-duration", |
| 1223 "type": "string" |
| 1224 }, |
| 1225 "primary": { |
| 1226 "$ref": "CryptoKeyVersion", |
| 1227 "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." |
| 1228 }, |
| 1229 "name": { |
| 1230 "description": "Output only. The resource name for this Cryp
toKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.", |
| 1231 "type": "string" |
| 1232 } |
| 1233 }, |
| 1234 "type": "object" |
| 1235 }, |
1167 "Rule": { | 1236 "Rule": { |
1168 "description": "A rule to be applied in a Policy.", | 1237 "description": "A rule to be applied in a Policy.", |
1169 "id": "Rule", | 1238 "id": "Rule", |
1170 "properties": { | 1239 "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 }, | |
1198 "notIn": { | 1240 "notIn": { |
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).", | 1241 "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).", |
1200 "items": { | 1242 "items": { |
1201 "type": "string" | 1243 "type": "string" |
1202 }, | 1244 }, |
1203 "type": "array" | 1245 "type": "array" |
1204 }, | 1246 }, |
1205 "description": { | 1247 "description": { |
1206 "description": "Human-readable description of the rule.", | 1248 "description": "Human-readable description of the rule.", |
1207 "type": "string" | 1249 "type": "string" |
(...skipping 11 matching lines...) Expand all Loading... |
1219 "$ref": "LogConfig" | 1261 "$ref": "LogConfig" |
1220 }, | 1262 }, |
1221 "type": "array" | 1263 "type": "array" |
1222 }, | 1264 }, |
1223 "in": { | 1265 "in": { |
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.", | 1266 "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.", |
1225 "items": { | 1267 "items": { |
1226 "type": "string" | 1268 "type": "string" |
1227 }, | 1269 }, |
1228 "type": "array" | 1270 "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." | |
1240 }, | 1271 }, |
1241 "name": { | 1272 "permissions": { |
1242 "description": "Output only. The resource name for this Cryp
toKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.", | 1273 "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.", |
1243 "type": "string" | 1274 "items": { |
| 1275 "type": "string" |
| 1276 }, |
| 1277 "type": "array" |
1244 }, | 1278 }, |
1245 "purpose": { | 1279 "action": { |
1246 "description": "The immutable purpose of this CryptoKey. Cur
rently, the only acceptable\npurpose is ENCRYPT_DECRYPT.", | 1280 "description": "Required", |
1247 "enum": [ | 1281 "enum": [ |
1248 "CRYPTO_KEY_PURPOSE_UNSPECIFIED", | 1282 "NO_ACTION", |
1249 "ENCRYPT_DECRYPT" | 1283 "ALLOW", |
| 1284 "ALLOW_WITH_LOG", |
| 1285 "DENY", |
| 1286 "DENY_WITH_LOG", |
| 1287 "LOG" |
1250 ], | 1288 ], |
1251 "enumDescriptions": [ | 1289 "enumDescriptions": [ |
1252 "Not specified.", | 1290 "Default no action.", |
1253 "CryptoKeys with this purpose may be used with\nEncrypt
and\nDecrypt." | 1291 "Matching 'Entries' grant access.", |
| 1292 "Matching 'Entries' grant access and the caller promises
to log\nthe request per the returned log_configs.", |
| 1293 "Matching 'Entries' deny access.", |
| 1294 "Matching 'Entries' deny access and the caller promises
to log\nthe request per the returned log_configs.", |
| 1295 "Matching 'Entries' tell IAM.Check callers to generate l
ogs." |
1254 ], | 1296 ], |
1255 "type": "string" | 1297 "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" | |
1271 } | 1298 } |
1272 }, | 1299 }, |
1273 "type": "object" | 1300 "type": "object" |
1274 }, | 1301 }, |
1275 "LogConfig": { | 1302 "LogConfig": { |
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", | 1303 "description": "Specifies what kind of log the caller must write", |
1277 "id": "LogConfig", | 1304 "id": "LogConfig", |
1278 "properties": { | 1305 "properties": { |
1279 "cloudAudit": { | |
1280 "$ref": "CloudAuditOptions", | |
1281 "description": "Cloud audit options." | |
1282 }, | |
1283 "counter": { | 1306 "counter": { |
1284 "$ref": "CounterOptions", | 1307 "$ref": "CounterOptions", |
1285 "description": "Counter options." | 1308 "description": "Counter options." |
1286 }, | 1309 }, |
1287 "dataAccess": { | 1310 "dataAccess": { |
1288 "$ref": "DataAccessOptions", | 1311 "$ref": "DataAccessOptions", |
1289 "description": "Data access options." | 1312 "description": "Data access options." |
| 1313 }, |
| 1314 "cloudAudit": { |
| 1315 "$ref": "CloudAuditOptions", |
| 1316 "description": "Cloud audit options." |
1290 } | 1317 } |
1291 }, | 1318 }, |
1292 "type": "object" | 1319 "type": "object" |
1293 }, | 1320 }, |
1294 "SetIamPolicyRequest": { | 1321 "SetIamPolicyRequest": { |
1295 "description": "Request message for `SetIamPolicy` method.", | 1322 "description": "Request message for `SetIamPolicy` method.", |
1296 "id": "SetIamPolicyRequest", | 1323 "id": "SetIamPolicyRequest", |
1297 "properties": { | 1324 "properties": { |
1298 "policy": { | 1325 "policy": { |
1299 "$ref": "Policy", | 1326 "$ref": "Policy", |
(...skipping 21 matching lines...) Expand all Loading... |
1321 "format": "byte", | 1348 "format": "byte", |
1322 "type": "string" | 1349 "type": "string" |
1323 } | 1350 } |
1324 }, | 1351 }, |
1325 "type": "object" | 1352 "type": "object" |
1326 }, | 1353 }, |
1327 "Location": { | 1354 "Location": { |
1328 "description": "A resource that represents Google Cloud Platform loc
ation.", | 1355 "description": "A resource that represents Google Cloud Platform loc
ation.", |
1329 "id": "Location", | 1356 "id": "Location", |
1330 "properties": { | 1357 "properties": { |
| 1358 "labels": { |
| 1359 "additionalProperties": { |
| 1360 "type": "string" |
| 1361 }, |
| 1362 "description": "Cross-service attributes for the location. F
or example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}", |
| 1363 "type": "object" |
| 1364 }, |
1331 "name": { | 1365 "name": { |
1332 "description": "Resource name for the location, which may va
ry between implementations.\nFor example: `\"projects/example-project/locations/
us-east1\"`", | 1366 "description": "Resource name for the location, which may va
ry between implementations.\nFor example: `\"projects/example-project/locations/
us-east1\"`", |
1333 "type": "string" | 1367 "type": "string" |
1334 }, | 1368 }, |
1335 "locationId": { | 1369 "locationId": { |
1336 "description": "The canonical id for this location. For exam
ple: `\"us-east1\"`.", | 1370 "description": "The canonical id for this location. For exam
ple: `\"us-east1\"`.", |
1337 "type": "string" | 1371 "type": "string" |
1338 }, | 1372 }, |
1339 "metadata": { | 1373 "metadata": { |
1340 "additionalProperties": { | 1374 "additionalProperties": { |
1341 "description": "Properties of the object. Contains field
@type with type URL.", | 1375 "description": "Properties of the object. Contains field
@type with type URL.", |
1342 "type": "any" | 1376 "type": "any" |
1343 }, | 1377 }, |
1344 "description": "Service-specific metadata. For example the a
vailable capacity at the given\nlocation.", | 1378 "description": "Service-specific metadata. For example the a
vailable capacity at the given\nlocation.", |
1345 "type": "object" | 1379 "type": "object" |
1346 }, | |
1347 "labels": { | |
1348 "additionalProperties": { | |
1349 "type": "string" | |
1350 }, | |
1351 "description": "Cross-service attributes for the location. F
or example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}", | |
1352 "type": "object" | |
1353 } | 1380 } |
1354 }, | 1381 }, |
1355 "type": "object" | 1382 "type": "object" |
1356 }, | 1383 }, |
1357 "ListCryptoKeysResponse": { | 1384 "ListCryptoKeysResponse": { |
1358 "description": "Response message for KeyManagementService.ListCrypto
Keys.", | 1385 "description": "Response message for KeyManagementService.ListCrypto
Keys.", |
1359 "id": "ListCryptoKeysResponse", | 1386 "id": "ListCryptoKeysResponse", |
1360 "properties": { | 1387 "properties": { |
1361 "nextPageToken": { | 1388 "nextPageToken": { |
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.", | 1389 "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... |
1374 }, | 1401 }, |
1375 "type": "array" | 1402 "type": "array" |
1376 } | 1403 } |
1377 }, | 1404 }, |
1378 "type": "object" | 1405 "type": "object" |
1379 }, | 1406 }, |
1380 "Condition": { | 1407 "Condition": { |
1381 "description": "A condition to be met.", | 1408 "description": "A condition to be met.", |
1382 "id": "Condition", | 1409 "id": "Condition", |
1383 "properties": { | 1410 "properties": { |
| 1411 "values": { |
| 1412 "description": "The objects of the condition. This is mutual
ly exclusive with 'value'.", |
| 1413 "items": { |
| 1414 "type": "string" |
| 1415 }, |
| 1416 "type": "array" |
| 1417 }, |
1384 "iam": { | 1418 "iam": { |
1385 "description": "Trusted attributes supplied by the IAM syste
m.", | 1419 "description": "Trusted attributes supplied by the IAM syste
m.", |
1386 "enum": [ | 1420 "enum": [ |
1387 "NO_ATTR", | 1421 "NO_ATTR", |
1388 "AUTHORITY", | 1422 "AUTHORITY", |
1389 "ATTRIBUTION", | 1423 "ATTRIBUTION", |
1390 "APPROVER", | 1424 "APPROVER", |
1391 "JUSTIFICATION_TYPE" | 1425 "JUSTIFICATION_TYPE" |
1392 ], | 1426 ], |
1393 "enumDescriptions": [ | 1427 "enumDescriptions": [ |
1394 "Default non-attribute.", | 1428 "Default non-attribute.", |
1395 "Either principal or (if present) authority selector.", | 1429 "Either principal or (if present) authority selector.", |
1396 "The principal (even if an authority selector is present
), which\nmust only be used for attribution, not authorization.", | 1430 "The principal (even if an authority selector is present
), which\nmust only be used for attribution, not authorization.", |
1397 "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).", | 1431 "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).", |
1398 "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.
" | 1432 "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.
" |
1399 ], | 1433 ], |
1400 "type": "string" | 1434 "type": "string" |
1401 }, | 1435 }, |
1402 "values": { | |
1403 "description": "The objects of the condition. This is mutual
ly exclusive with 'value'.", | |
1404 "items": { | |
1405 "type": "string" | |
1406 }, | |
1407 "type": "array" | |
1408 }, | |
1409 "op": { | 1436 "op": { |
1410 "description": "An operator to apply the subject with.", | 1437 "description": "An operator to apply the subject with.", |
1411 "enum": [ | 1438 "enum": [ |
1412 "NO_OP", | 1439 "NO_OP", |
1413 "EQUALS", | 1440 "EQUALS", |
1414 "NOT_EQUALS", | 1441 "NOT_EQUALS", |
1415 "IN", | 1442 "IN", |
1416 "NOT_IN", | 1443 "NOT_IN", |
1417 "DISCHARGED" | 1444 "DISCHARGED" |
1418 ], | 1445 ], |
1419 "enumDescriptions": [ | 1446 "enumDescriptions": [ |
1420 "Default no-op.", | 1447 "Default no-op.", |
1421 "DEPRECATED. Use IN instead.", | 1448 "DEPRECATED. Use IN instead.", |
1422 "DEPRECATED. Use NOT_IN instead.", | 1449 "DEPRECATED. Use NOT_IN instead.", |
1423 "The condition is true if the subject (or any element of
it if it is\na set) matches any of the supplied values.", | 1450 "The condition is true if the subject (or any element of
it if it is\na set) matches any 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.", | 1451 "The condition is true if the subject (or every element
of it if it is\na set) matches none of the supplied values.", |
1425 "Subject is discharged" | 1452 "Subject is discharged" |
1426 ], | 1453 ], |
1427 "type": "string" | 1454 "type": "string" |
1428 }, | 1455 }, |
1429 "svc": { | 1456 "svc": { |
1430 "description": "Trusted attributes discharged by the service
.", | 1457 "description": "Trusted attributes discharged by the service
.", |
1431 "type": "string" | 1458 "type": "string" |
1432 }, | 1459 }, |
1433 "value": { | |
1434 "description": "DEPRECATED. Use 'values' instead.", | |
1435 "type": "string" | |
1436 }, | |
1437 "sys": { | 1460 "sys": { |
1438 "description": "Trusted attributes supplied by any service t
hat owns resources and uses\nthe IAM system for access control.", | 1461 "description": "Trusted attributes supplied by any service t
hat owns resources and uses\nthe IAM system for access control.", |
1439 "enum": [ | 1462 "enum": [ |
1440 "NO_ATTR", | 1463 "NO_ATTR", |
1441 "REGION", | 1464 "REGION", |
1442 "SERVICE", | 1465 "SERVICE", |
1443 "NAME", | 1466 "NAME", |
1444 "IP" | 1467 "IP" |
1445 ], | 1468 ], |
1446 "enumDescriptions": [ | 1469 "enumDescriptions": [ |
1447 "Default non-attribute type", | 1470 "Default non-attribute type", |
1448 "Region of the resource", | 1471 "Region of the resource", |
1449 "Service name", | 1472 "Service name", |
1450 "Resource name", | 1473 "Resource name", |
1451 "IP address of the caller" | 1474 "IP address of the caller" |
1452 ], | 1475 ], |
1453 "type": "string" | 1476 "type": "string" |
| 1477 }, |
| 1478 "value": { |
| 1479 "description": "DEPRECATED. Use 'values' instead.", |
| 1480 "type": "string" |
1454 } | 1481 } |
1455 }, | 1482 }, |
1456 "type": "object" | 1483 "type": "object" |
1457 }, | 1484 }, |
1458 "CounterOptions": { | 1485 "CounterOptions": { |
1459 "description": "Options for counters", | 1486 "description": "Increment a streamz counter with the specified metri
c and field names.\n\nMetric names should start with a '/', generally be lowerca
se-only,\nand end in \"_count\". Field names should not contain an initial slash
.\nThe actual exported metric names will have \"/iam/policy\" prepended.\n\nFiel
d names correspond to IAM request parameters and field values are\ntheir respect
ive values.\n\nAt present the only supported field names are\n - \"iam_princip
al\", corresponding to IAMContext.principal;\n - \"\" (empty string), resultin
g in one aggretated counter with no field.\n\nExamples:\n counter { metric: \"/
debug_access_count\" field: \"iam_principal\" }\n ==> increment counter /iam/p
olicy/backend_debug_access_count\n {iam_principal=[value
of IAMContext.principal]}\n\nAt this time we do not support:\n* multiple field n
ames (though this may be supported in the future)\n* decrementing the counter\n*
incrementing it by anything other than 1", |
1460 "id": "CounterOptions", | 1487 "id": "CounterOptions", |
1461 "properties": { | 1488 "properties": { |
1462 "field": { | 1489 "field": { |
1463 "description": "The field value to attribute.", | 1490 "description": "The field value to attribute.", |
1464 "type": "string" | 1491 "type": "string" |
1465 }, | 1492 }, |
1466 "metric": { | 1493 "metric": { |
1467 "description": "The metric to update.", | 1494 "description": "The metric to update.", |
1468 "type": "string" | 1495 "type": "string" |
1469 } | 1496 } |
(...skipping 34 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1504 "description": "Response message for KeyManagementService.Decrypt.", | 1531 "description": "Response message for KeyManagementService.Decrypt.", |
1505 "id": "DecryptResponse", | 1532 "id": "DecryptResponse", |
1506 "properties": { | 1533 "properties": { |
1507 "plaintext": { | 1534 "plaintext": { |
1508 "description": "The decrypted data originally supplied in En
cryptRequest.plaintext.", | 1535 "description": "The decrypted data originally supplied in En
cryptRequest.plaintext.", |
1509 "format": "byte", | 1536 "format": "byte", |
1510 "type": "string" | 1537 "type": "string" |
1511 } | 1538 } |
1512 }, | 1539 }, |
1513 "type": "object" | 1540 "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 } | 1541 } |
1529 }, | 1542 }, |
1530 "servicePath": "", | 1543 "servicePath": "", |
1531 "title": "Google Cloud Key Management Service (KMS) API", | 1544 "title": "Google Cloud Key Management Service (KMS) API", |
1532 "version": "v1" | 1545 "version": "v1" |
1533 } | 1546 } |
OLD | NEW |