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