OLD | NEW |
1 { | 1 { |
2 "basePath": "", | 2 "basePath": "", |
3 "baseUrl": "https://vault.googleapis.com/", | 3 "baseUrl": "https://vault.googleapis.com/", |
4 "batchPath": "batch", | 4 "batchPath": "batch", |
5 "canonicalName": "Vault", | 5 "canonicalName": "Vault", |
6 "description": "", | 6 "description": "", |
7 "discoveryVersion": "v1", | 7 "discoveryVersion": "v1", |
8 "documentationLink": "https://apps.google.com/products/vault/", | 8 "documentationLink": "https://apps.google.com/products/vault/", |
9 "icons": { | 9 "icons": { |
10 "x16": "http://www.google.com/images/icons/product/search-16.gif", | 10 "x16": "http://www.google.com/images/icons/product/search-16.gif", |
11 "x32": "http://www.google.com/images/icons/product/search-32.gif" | 11 "x32": "http://www.google.com/images/icons/product/search-32.gif" |
12 }, | 12 }, |
13 "id": "vault:v1", | 13 "id": "vault:v1", |
14 "kind": "discovery#restDescription", | 14 "kind": "discovery#restDescription", |
15 "name": "vault", | 15 "name": "vault", |
16 "ownerDomain": "google.com", | 16 "ownerDomain": "google.com", |
17 "ownerName": "Google", | 17 "ownerName": "Google", |
18 "parameters": { | 18 "parameters": { |
19 "quotaUser": { | 19 "callback": { |
20 "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.", | 20 "description": "JSONP", |
21 "location": "query", | 21 "location": "query", |
22 "type": "string" | 22 "type": "string" |
23 }, | 23 }, |
24 "pp": { | |
25 "default": "true", | |
26 "description": "Pretty-print response.", | |
27 "location": "query", | |
28 "type": "boolean" | |
29 }, | |
30 "bearer_token": { | |
31 "description": "OAuth bearer token.", | |
32 "location": "query", | |
33 "type": "string" | |
34 }, | |
35 "oauth_token": { | |
36 "description": "OAuth 2.0 token for the current user.", | |
37 "location": "query", | |
38 "type": "string" | |
39 }, | |
40 "upload_protocol": { | |
41 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", | |
42 "location": "query", | |
43 "type": "string" | |
44 }, | |
45 "prettyPrint": { | |
46 "default": "true", | |
47 "description": "Returns response with indentations and line breaks."
, | |
48 "location": "query", | |
49 "type": "boolean" | |
50 }, | |
51 "fields": { | |
52 "description": "Selector specifying which fields to include in a par
tial response.", | |
53 "location": "query", | |
54 "type": "string" | |
55 }, | |
56 "uploadType": { | |
57 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", | |
58 "location": "query", | |
59 "type": "string" | |
60 }, | |
61 "$.xgafv": { | 24 "$.xgafv": { |
62 "description": "V1 error format.", | 25 "description": "V1 error format.", |
63 "enum": [ | 26 "enum": [ |
64 "1", | 27 "1", |
65 "2" | 28 "2" |
66 ], | 29 ], |
67 "enumDescriptions": [ | 30 "enumDescriptions": [ |
68 "v1 error format", | 31 "v1 error format", |
69 "v2 error format" | 32 "v2 error format" |
70 ], | 33 ], |
71 "location": "query", | 34 "location": "query", |
72 "type": "string" | 35 "type": "string" |
73 }, | 36 }, |
74 "callback": { | |
75 "description": "JSONP", | |
76 "location": "query", | |
77 "type": "string" | |
78 }, | |
79 "alt": { | 37 "alt": { |
80 "default": "json", | 38 "default": "json", |
81 "description": "Data format for response.", | 39 "description": "Data format for response.", |
82 "enum": [ | 40 "enum": [ |
83 "json", | 41 "json", |
84 "media", | 42 "media", |
85 "proto" | 43 "proto" |
86 ], | 44 ], |
87 "enumDescriptions": [ | 45 "enumDescriptions": [ |
88 "Responses with Content-Type of application/json", | 46 "Responses with Content-Type of application/json", |
89 "Media download with context-dependent Content-Type", | 47 "Media download with context-dependent Content-Type", |
90 "Responses with Content-Type of application/x-protobuf" | 48 "Responses with Content-Type of application/x-protobuf" |
91 ], | 49 ], |
92 "location": "query", | 50 "location": "query", |
93 "type": "string" | 51 "type": "string" |
94 }, | 52 }, |
95 "access_token": { | 53 "access_token": { |
96 "description": "OAuth access token.", | 54 "description": "OAuth access token.", |
97 "location": "query", | 55 "location": "query", |
98 "type": "string" | 56 "type": "string" |
99 }, | 57 }, |
100 "key": { | 58 "key": { |
101 "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.", | 59 "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.", |
102 "location": "query", | 60 "location": "query", |
103 "type": "string" | 61 "type": "string" |
| 62 }, |
| 63 "quotaUser": { |
| 64 "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.", |
| 65 "location": "query", |
| 66 "type": "string" |
| 67 }, |
| 68 "pp": { |
| 69 "default": "true", |
| 70 "description": "Pretty-print response.", |
| 71 "location": "query", |
| 72 "type": "boolean" |
| 73 }, |
| 74 "bearer_token": { |
| 75 "description": "OAuth bearer token.", |
| 76 "location": "query", |
| 77 "type": "string" |
| 78 }, |
| 79 "oauth_token": { |
| 80 "description": "OAuth 2.0 token for the current user.", |
| 81 "location": "query", |
| 82 "type": "string" |
| 83 }, |
| 84 "upload_protocol": { |
| 85 "description": "Upload protocol for media (e.g. \"raw\", \"multipart
\").", |
| 86 "location": "query", |
| 87 "type": "string" |
| 88 }, |
| 89 "prettyPrint": { |
| 90 "default": "true", |
| 91 "description": "Returns response with indentations and line breaks."
, |
| 92 "location": "query", |
| 93 "type": "boolean" |
| 94 }, |
| 95 "fields": { |
| 96 "description": "Selector specifying which fields to include in a par
tial response.", |
| 97 "location": "query", |
| 98 "type": "string" |
| 99 }, |
| 100 "uploadType": { |
| 101 "description": "Legacy upload protocol for media (e.g. \"media\", \"
multipart\").", |
| 102 "location": "query", |
| 103 "type": "string" |
104 } | 104 } |
105 }, | 105 }, |
106 "protocol": "rest", | 106 "protocol": "rest", |
107 "resources": { | 107 "resources": { |
108 "matters": { | 108 "matters": { |
109 "methods": { | 109 "methods": { |
110 "undelete": { | 110 "close": { |
111 "description": "Undeletes the specified matter. Returns matt
er with updated state.", | 111 "description": "Closes the specified matter. Returns matter
with updated state.", |
112 "httpMethod": "POST", | 112 "httpMethod": "POST", |
113 "id": "vault.matters.undelete", | 113 "id": "vault.matters.close", |
114 "parameterOrder": [ | 114 "parameterOrder": [ |
115 "matterId" | 115 "matterId" |
116 ], | 116 ], |
117 "parameters": { | 117 "parameters": { |
118 "matterId": { | 118 "matterId": { |
119 "description": "The matter ID.", | 119 "description": "The matter ID.", |
120 "location": "path", | 120 "location": "path", |
121 "required": true, | 121 "required": true, |
122 "type": "string" | 122 "type": "string" |
123 } | 123 } |
124 }, | 124 }, |
125 "path": "v1/matters/{matterId}:undelete", | 125 "path": "v1/matters/{matterId}:close", |
126 "request": { | 126 "request": { |
127 "$ref": "UndeleteMatterRequest" | 127 "$ref": "CloseMatterRequest" |
128 }, | 128 }, |
129 "response": { | 129 "response": { |
130 "$ref": "Matter" | 130 "$ref": "CloseMatterResponse" |
131 } | 131 } |
132 }, | 132 }, |
133 "get": { | 133 "get": { |
134 "description": "Gets the specified matter.", | 134 "description": "Gets the specified matter.", |
135 "httpMethod": "GET", | 135 "httpMethod": "GET", |
136 "id": "vault.matters.get", | 136 "id": "vault.matters.get", |
137 "parameterOrder": [ | 137 "parameterOrder": [ |
138 "matterId" | 138 "matterId" |
139 ], | 139 ], |
140 "parameters": { | 140 "parameters": { |
141 "matterId": { | |
142 "description": "The matter ID.", | |
143 "location": "path", | |
144 "required": true, | |
145 "type": "string" | |
146 }, | |
147 "view": { | 141 "view": { |
148 "description": "Specifies which parts of the Matter
to return in the response.", | 142 "description": "Specifies which parts of the Matter
to return in the response.", |
149 "enum": [ | 143 "enum": [ |
150 "VIEW_UNSPECIFIED", | 144 "VIEW_UNSPECIFIED", |
151 "BASIC", | 145 "BASIC", |
152 "FULL" | 146 "FULL" |
153 ], | 147 ], |
154 "location": "query", | 148 "location": "query", |
155 "type": "string" | 149 "type": "string" |
| 150 }, |
| 151 "matterId": { |
| 152 "description": "The matter ID.", |
| 153 "location": "path", |
| 154 "required": true, |
| 155 "type": "string" |
156 } | 156 } |
157 }, | 157 }, |
158 "path": "v1/matters/{matterId}", | 158 "path": "v1/matters/{matterId}", |
159 "response": { | 159 "response": { |
160 "$ref": "Matter" | 160 "$ref": "Matter" |
161 } | 161 } |
162 }, | 162 }, |
163 "close": { | 163 "undelete": { |
164 "description": "Closes the specified matter. Returns matter
with updated state.", | 164 "description": "Undeletes the specified matter. Returns matt
er with updated state.", |
165 "httpMethod": "POST", | 165 "httpMethod": "POST", |
166 "id": "vault.matters.close", | 166 "id": "vault.matters.undelete", |
167 "parameterOrder": [ | 167 "parameterOrder": [ |
168 "matterId" | 168 "matterId" |
169 ], | 169 ], |
170 "parameters": { | 170 "parameters": { |
171 "matterId": { | 171 "matterId": { |
172 "description": "The matter ID.", | 172 "description": "The matter ID.", |
173 "location": "path", | 173 "location": "path", |
174 "required": true, | 174 "required": true, |
175 "type": "string" | 175 "type": "string" |
176 } | 176 } |
177 }, | 177 }, |
178 "path": "v1/matters/{matterId}:close", | 178 "path": "v1/matters/{matterId}:undelete", |
179 "request": { | 179 "request": { |
180 "$ref": "CloseMatterRequest" | 180 "$ref": "UndeleteMatterRequest" |
181 }, | 181 }, |
182 "response": { | 182 "response": { |
183 "$ref": "CloseMatterResponse" | 183 "$ref": "Matter" |
184 } | 184 } |
185 }, | 185 }, |
186 "update": { | 186 "update": { |
187 "description": "Updates the specified matter.\nThis updates
only the name and description of the matter, identified by\nmatter id. Changes t
o any other fields are ignored.\nReturns the default view of the matter.", | 187 "description": "Updates the specified matter.\nThis updates
only the name and description of the matter, identified by\nmatter id. Changes t
o any other fields are ignored.\nReturns the default view of the matter.", |
188 "httpMethod": "PUT", | 188 "httpMethod": "PUT", |
189 "id": "vault.matters.update", | 189 "id": "vault.matters.update", |
190 "parameterOrder": [ | 190 "parameterOrder": [ |
191 "matterId" | 191 "matterId" |
192 ], | 192 ], |
193 "parameters": { | 193 "parameters": { |
(...skipping 25 matching lines...) Expand all Loading... |
219 "location": "path", | 219 "location": "path", |
220 "required": true, | 220 "required": true, |
221 "type": "string" | 221 "type": "string" |
222 } | 222 } |
223 }, | 223 }, |
224 "path": "v1/matters/{matterId}", | 224 "path": "v1/matters/{matterId}", |
225 "response": { | 225 "response": { |
226 "$ref": "Matter" | 226 "$ref": "Matter" |
227 } | 227 } |
228 }, | 228 }, |
| 229 "addPermissions": { |
| 230 "description": "Adds an account as a matter collaborator.", |
| 231 "httpMethod": "POST", |
| 232 "id": "vault.matters.addPermissions", |
| 233 "parameterOrder": [ |
| 234 "matterId" |
| 235 ], |
| 236 "parameters": { |
| 237 "matterId": { |
| 238 "description": "The matter ID.", |
| 239 "location": "path", |
| 240 "required": true, |
| 241 "type": "string" |
| 242 } |
| 243 }, |
| 244 "path": "v1/matters/{matterId}:addPermissions", |
| 245 "request": { |
| 246 "$ref": "AddMatterPermissionsRequest" |
| 247 }, |
| 248 "response": { |
| 249 "$ref": "MatterPermission" |
| 250 } |
| 251 }, |
229 "list": { | 252 "list": { |
230 "description": "Lists matters the user has access to.", | 253 "description": "Lists matters the user has access to.", |
231 "httpMethod": "GET", | 254 "httpMethod": "GET", |
232 "id": "vault.matters.list", | 255 "id": "vault.matters.list", |
233 "parameterOrder": [], | 256 "parameterOrder": [], |
234 "parameters": { | 257 "parameters": { |
235 "pageToken": { | 258 "pageToken": { |
236 "description": "The pagination token as returned in
the response.", | 259 "description": "The pagination token as returned in
the response.", |
237 "location": "query", | 260 "location": "query", |
238 "type": "string" | 261 "type": "string" |
(...skipping 13 matching lines...) Expand all Loading... |
252 ], | 275 ], |
253 "location": "query", | 276 "location": "query", |
254 "type": "string" | 277 "type": "string" |
255 } | 278 } |
256 }, | 279 }, |
257 "path": "v1/matters", | 280 "path": "v1/matters", |
258 "response": { | 281 "response": { |
259 "$ref": "ListMattersResponse" | 282 "$ref": "ListMattersResponse" |
260 } | 283 } |
261 }, | 284 }, |
262 "addPermissions": { | |
263 "description": "Adds an account as a matter collaborator.", | |
264 "httpMethod": "POST", | |
265 "id": "vault.matters.addPermissions", | |
266 "parameterOrder": [ | |
267 "matterId" | |
268 ], | |
269 "parameters": { | |
270 "matterId": { | |
271 "description": "The matter ID.", | |
272 "location": "path", | |
273 "required": true, | |
274 "type": "string" | |
275 } | |
276 }, | |
277 "path": "v1/matters/{matterId}:addPermissions", | |
278 "request": { | |
279 "$ref": "AddMatterPermissionsRequest" | |
280 }, | |
281 "response": { | |
282 "$ref": "MatterPermission" | |
283 } | |
284 }, | |
285 "create": { | 285 "create": { |
286 "description": "Creates a new matter. Returns created matter
with default view.", | 286 "description": "Creates a new matter. Returns created matter
with default view.", |
287 "httpMethod": "POST", | 287 "httpMethod": "POST", |
288 "id": "vault.matters.create", | 288 "id": "vault.matters.create", |
289 "parameterOrder": [], | 289 "parameterOrder": [], |
290 "parameters": {}, | 290 "parameters": {}, |
291 "path": "v1/matters", | 291 "path": "v1/matters", |
292 "request": { | 292 "request": { |
293 "$ref": "Matter" | 293 "$ref": "Matter" |
294 }, | 294 }, |
(...skipping 79 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
374 } | 374 } |
375 }, | 375 }, |
376 "list": { | 376 "list": { |
377 "description": "Lists holds within a matter. An empt
y page token in ListHoldsResponse\ndenotes no more holds to list.", | 377 "description": "Lists holds within a matter. An empt
y page token in ListHoldsResponse\ndenotes no more holds to list.", |
378 "httpMethod": "GET", | 378 "httpMethod": "GET", |
379 "id": "vault.matters.holds.list", | 379 "id": "vault.matters.holds.list", |
380 "parameterOrder": [ | 380 "parameterOrder": [ |
381 "matterId" | 381 "matterId" |
382 ], | 382 ], |
383 "parameters": { | 383 "parameters": { |
| 384 "matterId": { |
| 385 "description": "The matter ID.", |
| 386 "location": "path", |
| 387 "required": true, |
| 388 "type": "string" |
| 389 }, |
384 "pageToken": { | 390 "pageToken": { |
385 "description": "The pagination token as retu
rned in the response.\nAn empty token means start from the beginning.", | 391 "description": "The pagination token as retu
rned in the response.\nAn empty token means start from the beginning.", |
386 "location": "query", | 392 "location": "query", |
387 "type": "string" | 393 "type": "string" |
388 }, | 394 }, |
389 "pageSize": { | 395 "pageSize": { |
390 "description": "The number of holds to retur
n in the response, between 0 and 100 inclusive.\nLeaving this empty, or as 0, is
the same as page_size = 100.", | 396 "description": "The number of holds to retur
n in the response, between 0 and 100 inclusive.\nLeaving this empty, or as 0, is
the same as page_size = 100.", |
391 "format": "int32", | 397 "format": "int32", |
392 "location": "query", | 398 "location": "query", |
393 "type": "integer" | 399 "type": "integer" |
394 }, | |
395 "matterId": { | |
396 "description": "The matter ID.", | |
397 "location": "path", | |
398 "required": true, | |
399 "type": "string" | |
400 } | 400 } |
401 }, | 401 }, |
402 "path": "v1/matters/{matterId}/holds", | 402 "path": "v1/matters/{matterId}/holds", |
403 "response": { | 403 "response": { |
404 "$ref": "ListHoldsResponse" | 404 "$ref": "ListHoldsResponse" |
405 } | 405 } |
406 }, | 406 }, |
407 "get": { | 407 "get": { |
408 "description": "Gets a hold by ID.", | 408 "description": "Gets a hold by ID.", |
409 "httpMethod": "GET", | 409 "httpMethod": "GET", |
(...skipping 23 matching lines...) Expand all Loading... |
433 }, | 433 }, |
434 "update": { | 434 "update": { |
435 "description": "Updates the OU and/or query paramete
rs of a hold. You cannot add accounts\nto a hold that covers an OU, nor can you
add OUs to a hold that covers\nindividual accounts. Accounts listed in the hold
will be ignored.", | 435 "description": "Updates the OU and/or query paramete
rs of a hold. You cannot add accounts\nto a hold that covers an OU, nor can you
add OUs to a hold that covers\nindividual accounts. Accounts listed in the hold
will be ignored.", |
436 "httpMethod": "PUT", | 436 "httpMethod": "PUT", |
437 "id": "vault.matters.holds.update", | 437 "id": "vault.matters.holds.update", |
438 "parameterOrder": [ | 438 "parameterOrder": [ |
439 "matterId", | 439 "matterId", |
440 "holdId" | 440 "holdId" |
441 ], | 441 ], |
442 "parameters": { | 442 "parameters": { |
| 443 "holdId": { |
| 444 "description": "The ID of the hold.", |
| 445 "location": "path", |
| 446 "required": true, |
| 447 "type": "string" |
| 448 }, |
443 "matterId": { | 449 "matterId": { |
444 "description": "The matter ID.", | 450 "description": "The matter ID.", |
445 "location": "path", | 451 "location": "path", |
446 "required": true, | 452 "required": true, |
447 "type": "string" | 453 "type": "string" |
448 }, | |
449 "holdId": { | |
450 "description": "The ID of the hold.", | |
451 "location": "path", | |
452 "required": true, | |
453 "type": "string" | |
454 } | 454 } |
455 }, | 455 }, |
456 "path": "v1/matters/{matterId}/holds/{holdId}", | 456 "path": "v1/matters/{matterId}/holds/{holdId}", |
457 "request": { | 457 "request": { |
458 "$ref": "Hold" | 458 "$ref": "Hold" |
459 }, | 459 }, |
460 "response": { | 460 "response": { |
461 "$ref": "Hold" | 461 "$ref": "Hold" |
462 } | 462 } |
463 }, | 463 }, |
(...skipping 17 matching lines...) Expand all Loading... |
481 "$ref": "Hold" | 481 "$ref": "Hold" |
482 }, | 482 }, |
483 "response": { | 483 "response": { |
484 "$ref": "Hold" | 484 "$ref": "Hold" |
485 } | 485 } |
486 } | 486 } |
487 }, | 487 }, |
488 "resources": { | 488 "resources": { |
489 "accounts": { | 489 "accounts": { |
490 "methods": { | 490 "methods": { |
491 "create": { | |
492 "description": "Adds a HeldAccount to a hold
. Accounts can only be added to a hold that\nhas no held_org_unit set. Attemptin
g to add an account to an OU-based\nhold will result in an error.", | |
493 "httpMethod": "POST", | |
494 "id": "vault.matters.holds.accounts.create", | |
495 "parameterOrder": [ | |
496 "matterId", | |
497 "holdId" | |
498 ], | |
499 "parameters": { | |
500 "holdId": { | |
501 "description": "The hold ID.", | |
502 "location": "path", | |
503 "required": true, | |
504 "type": "string" | |
505 }, | |
506 "matterId": { | |
507 "description": "The matter ID.", | |
508 "location": "path", | |
509 "required": true, | |
510 "type": "string" | |
511 } | |
512 }, | |
513 "path": "v1/matters/{matterId}/holds/{holdId
}/accounts", | |
514 "request": { | |
515 "$ref": "HeldAccount" | |
516 }, | |
517 "response": { | |
518 "$ref": "HeldAccount" | |
519 } | |
520 }, | |
521 "delete": { | 491 "delete": { |
522 "description": "Removes a HeldAccount from a
hold. If this request leaves the hold with\nno held accounts, the hold will not
apply to any accounts.", | 492 "description": "Removes a HeldAccount from a
hold. If this request leaves the hold with\nno held accounts, the hold will not
apply to any accounts.", |
523 "httpMethod": "DELETE", | 493 "httpMethod": "DELETE", |
524 "id": "vault.matters.holds.accounts.delete", | 494 "id": "vault.matters.holds.accounts.delete", |
525 "parameterOrder": [ | 495 "parameterOrder": [ |
526 "matterId", | 496 "matterId", |
527 "holdId", | 497 "holdId", |
528 "accountId" | 498 "accountId" |
529 ], | 499 ], |
530 "parameters": { | 500 "parameters": { |
(...skipping 15 matching lines...) Expand all Loading... |
546 "required": true, | 516 "required": true, |
547 "type": "string" | 517 "type": "string" |
548 } | 518 } |
549 }, | 519 }, |
550 "path": "v1/matters/{matterId}/holds/{holdId
}/accounts/{accountId}", | 520 "path": "v1/matters/{matterId}/holds/{holdId
}/accounts/{accountId}", |
551 "response": { | 521 "response": { |
552 "$ref": "Empty" | 522 "$ref": "Empty" |
553 } | 523 } |
554 }, | 524 }, |
555 "list": { | 525 "list": { |
556 "description": "Lists HeldAccounts for a hol
d. This will only list individually specified\nheld accounts. If the hold is on
an OU, then use the <ahref=\"https://developers.google.com/admin-sdk/\">Admin SD
K</a>\nto enumerate its members.", | 526 "description": "Lists HeldAccounts for a hol
d. This will only list individually specified\nheld accounts. If the hold is on
an OU, then use\n<a href=\"https://developers.google.com/admin-sdk/\">Admin SDK<
/a>\nto enumerate its members.", |
557 "httpMethod": "GET", | 527 "httpMethod": "GET", |
558 "id": "vault.matters.holds.accounts.list", | 528 "id": "vault.matters.holds.accounts.list", |
559 "parameterOrder": [ | 529 "parameterOrder": [ |
560 "matterId", | 530 "matterId", |
561 "holdId" | 531 "holdId" |
562 ], | 532 ], |
563 "parameters": { | 533 "parameters": { |
564 "matterId": { | 534 "holdId": { |
565 "description": "The matter ID.", | 535 "description": "The hold ID.", |
566 "location": "path", | 536 "location": "path", |
567 "required": true, | 537 "required": true, |
568 "type": "string" | 538 "type": "string" |
569 }, | 539 }, |
570 "holdId": { | 540 "matterId": { |
571 "description": "The hold ID.", | 541 "description": "The matter ID.", |
572 "location": "path", | 542 "location": "path", |
573 "required": true, | 543 "required": true, |
574 "type": "string" | 544 "type": "string" |
575 } | 545 } |
576 }, | 546 }, |
577 "path": "v1/matters/{matterId}/holds/{holdId
}/accounts", | 547 "path": "v1/matters/{matterId}/holds/{holdId
}/accounts", |
578 "response": { | 548 "response": { |
579 "$ref": "ListHeldAccountsResponse" | 549 "$ref": "ListHeldAccountsResponse" |
580 } | 550 } |
| 551 }, |
| 552 "create": { |
| 553 "description": "Adds a HeldAccount to a hold
. Accounts can only be added to a hold that\nhas no held_org_unit set. Attemptin
g to add an account to an OU-based\nhold will result in an error.", |
| 554 "httpMethod": "POST", |
| 555 "id": "vault.matters.holds.accounts.create", |
| 556 "parameterOrder": [ |
| 557 "matterId", |
| 558 "holdId" |
| 559 ], |
| 560 "parameters": { |
| 561 "holdId": { |
| 562 "description": "The hold ID.", |
| 563 "location": "path", |
| 564 "required": true, |
| 565 "type": "string" |
| 566 }, |
| 567 "matterId": { |
| 568 "description": "The matter ID.", |
| 569 "location": "path", |
| 570 "required": true, |
| 571 "type": "string" |
| 572 } |
| 573 }, |
| 574 "path": "v1/matters/{matterId}/holds/{holdId
}/accounts", |
| 575 "request": { |
| 576 "$ref": "HeldAccount" |
| 577 }, |
| 578 "response": { |
| 579 "$ref": "HeldAccount" |
| 580 } |
581 } | 581 } |
582 } | 582 } |
583 } | 583 } |
584 } | 584 } |
585 } | 585 } |
586 } | 586 } |
587 } | 587 } |
588 }, | 588 }, |
589 "revision": "20170720", | 589 "revision": "20170719", |
590 "rootUrl": "https://vault.googleapis.com/", | 590 "rootUrl": "https://vault.googleapis.com/", |
591 "schemas": { | 591 "schemas": { |
| 592 "RemoveMatterPermissionsRequest": { |
| 593 "description": "Remove an account as a matter collaborator.", |
| 594 "id": "RemoveMatterPermissionsRequest", |
| 595 "properties": { |
| 596 "accountId": { |
| 597 "description": "The account ID.", |
| 598 "type": "string" |
| 599 } |
| 600 }, |
| 601 "type": "object" |
| 602 }, |
| 603 "MatterPermission": { |
| 604 "description": "Currently each matter only has one owner, and all ot
hers are collaborators.\nWhen an account is purged, its corresponding MatterPerm
ission resources\ncease to exist.", |
| 605 "id": "MatterPermission", |
| 606 "properties": { |
| 607 "accountId": { |
| 608 "description": "The account id, as provided by <a href=\"htt
ps://developers.google.com/admin-sdk/\">Admin SDK</a>.", |
| 609 "type": "string" |
| 610 }, |
| 611 "role": { |
| 612 "description": "The user's role in this matter.", |
| 613 "enum": [ |
| 614 "ROLE_UNSPECIFIED", |
| 615 "COLLABORATOR", |
| 616 "OWNER" |
| 617 ], |
| 618 "enumDescriptions": [ |
| 619 "No role assigned.", |
| 620 "A collaborator to the matter.", |
| 621 "The owner of the matter." |
| 622 ], |
| 623 "type": "string" |
| 624 } |
| 625 }, |
| 626 "type": "object" |
| 627 }, |
| 628 "ListMattersResponse": { |
| 629 "description": "Provides the list of matters.", |
| 630 "id": "ListMattersResponse", |
| 631 "properties": { |
| 632 "nextPageToken": { |
| 633 "description": "Page token to retrieve the next page of resu
lts in the list.", |
| 634 "type": "string" |
| 635 }, |
| 636 "matters": { |
| 637 "description": "List of matters.", |
| 638 "items": { |
| 639 "$ref": "Matter" |
| 640 }, |
| 641 "type": "array" |
| 642 } |
| 643 }, |
| 644 "type": "object" |
| 645 }, |
| 646 "HeldMailQuery": { |
| 647 "description": "Query options for mail holds.", |
| 648 "id": "HeldMailQuery", |
| 649 "properties": { |
| 650 "endTime": { |
| 651 "description": "The end date range for the search query. The
se timestamps are in GMT and\nrounded down to the start of the given date.", |
| 652 "format": "google-datetime", |
| 653 "type": "string" |
| 654 }, |
| 655 "startTime": { |
| 656 "description": "The start date range for the search query. T
hese timestamps are in GMT and\nrounded down to the start of the given date.", |
| 657 "format": "google-datetime", |
| 658 "type": "string" |
| 659 }, |
| 660 "terms": { |
| 661 "description": "The search terms for the hold.", |
| 662 "type": "string" |
| 663 } |
| 664 }, |
| 665 "type": "object" |
| 666 }, |
592 "CloseMatterResponse": { | 667 "CloseMatterResponse": { |
593 "description": "Response to a CloseMatterRequest.", | 668 "description": "Response to a CloseMatterRequest.", |
594 "id": "CloseMatterResponse", | 669 "id": "CloseMatterResponse", |
595 "properties": { | 670 "properties": { |
596 "matter": { | 671 "matter": { |
597 "$ref": "Matter", | 672 "$ref": "Matter", |
598 "description": "The updated matter, with state CLOSED." | 673 "description": "The updated matter, with state CLOSED." |
599 } | 674 } |
600 }, | 675 }, |
601 "type": "object" | 676 "type": "object" |
(...skipping 43 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
645 "format": "google-datetime", | 720 "format": "google-datetime", |
646 "type": "string" | 721 "type": "string" |
647 } | 722 } |
648 }, | 723 }, |
649 "type": "object" | 724 "type": "object" |
650 }, | 725 }, |
651 "AddMatterPermissionsRequest": { | 726 "AddMatterPermissionsRequest": { |
652 "description": "Add an account with the permission specified. The ro
le cannot be owner.\nIf an account already has a role in the matter, it will be\
noverwritten.", | 727 "description": "Add an account with the permission specified. The ro
le cannot be owner.\nIf an account already has a role in the matter, it will be\
noverwritten.", |
653 "id": "AddMatterPermissionsRequest", | 728 "id": "AddMatterPermissionsRequest", |
654 "properties": { | 729 "properties": { |
| 730 "ccMe": { |
| 731 "description": "Only relevant if send_emails is true.\nTrue
to CC requestor in the email message.\nFalse to not CC requestor.", |
| 732 "type": "boolean" |
| 733 }, |
655 "sendEmails": { | 734 "sendEmails": { |
656 "description": "True to send notification email to the added
account.\nFalse to not send notification email.", | 735 "description": "True to send notification email to the added
account.\nFalse to not send notification email.", |
657 "type": "boolean" | 736 "type": "boolean" |
658 }, | 737 }, |
659 "matterPermission": { | 738 "matterPermission": { |
660 "$ref": "MatterPermission", | 739 "$ref": "MatterPermission", |
661 "description": "The MatterPermission to add." | 740 "description": "The MatterPermission to add." |
662 }, | |
663 "ccMe": { | |
664 "description": "Only relevant if send_emails is true.\nTrue
to CC requestor in the email message.\nFalse to not CC requestor.", | |
665 "type": "boolean" | |
666 } | 741 } |
667 }, | 742 }, |
668 "type": "object" | 743 "type": "object" |
669 }, | 744 }, |
670 "Matter": { | 745 "Matter": { |
671 "description": "Represents a matter.", | 746 "description": "Represents a matter.", |
672 "id": "Matter", | 747 "id": "Matter", |
673 "properties": { | 748 "properties": { |
| 749 "matterPermissions": { |
| 750 "description": "List of users and access to the matter. Curr
ently there is no programmer\ndefined limit on the number of permissions a matte
r can have.", |
| 751 "items": { |
| 752 "$ref": "MatterPermission" |
| 753 }, |
| 754 "type": "array" |
| 755 }, |
| 756 "name": { |
| 757 "description": "The name of the matter.", |
| 758 "type": "string" |
| 759 }, |
| 760 "description": { |
| 761 "description": "The description of the matter.", |
| 762 "type": "string" |
| 763 }, |
674 "matterId": { | 764 "matterId": { |
675 "description": "The matter ID which is generated by the serv
er.\nShould be blank when creating a new matter.", | 765 "description": "The matter ID which is generated by the serv
er.\nShould be blank when creating a new matter.", |
676 "type": "string" | 766 "type": "string" |
677 }, | 767 }, |
678 "state": { | 768 "state": { |
679 "description": "The state of the matter.", | 769 "description": "The state of the matter.", |
680 "enum": [ | 770 "enum": [ |
681 "STATE_UNSPECIFIED", | 771 "STATE_UNSPECIFIED", |
682 "OPEN", | 772 "OPEN", |
683 "CLOSED", | 773 "CLOSED", |
684 "DELETED" | 774 "DELETED" |
685 ], | 775 ], |
686 "enumDescriptions": [ | 776 "enumDescriptions": [ |
687 "The matter has no specified state.", | 777 "The matter has no specified state.", |
688 "This matter is open.", | 778 "This matter is open.", |
689 "This matter is closed.", | 779 "This matter is closed.", |
690 "This matter is deleted." | 780 "This matter is deleted." |
691 ], | 781 ], |
692 "type": "string" | 782 "type": "string" |
693 }, | |
694 "matterPermissions": { | |
695 "description": "List of users and access to the matter. Curr
ently there is no programmer\ndefined limit on the number of permissions a matte
r can have.", | |
696 "items": { | |
697 "$ref": "MatterPermission" | |
698 }, | |
699 "type": "array" | |
700 }, | |
701 "name": { | |
702 "description": "The name of the matter.", | |
703 "type": "string" | |
704 }, | |
705 "description": { | |
706 "description": "The description of the matter.", | |
707 "type": "string" | |
708 } | 783 } |
709 }, | 784 }, |
710 "type": "object" | 785 "type": "object" |
711 }, | 786 }, |
712 "HeldAccount": { | 787 "HeldAccount": { |
713 "description": "An account being held in a particular hold. This str
ucture is immutable.\nThis can be either a single user or a google group, depend
ing on the corpus.", | 788 "description": "An account being held in a particular hold. This str
ucture is immutable.\nThis can be either a single user or a google group, depend
ing on the corpus.", |
714 "id": "HeldAccount", | 789 "id": "HeldAccount", |
715 "properties": { | 790 "properties": { |
716 "holdTime": { | 791 "holdTime": { |
717 "description": "When the account was put on hold.", | 792 "description": "When the account was put on hold.", |
718 "format": "google-datetime", | 793 "format": "google-datetime", |
719 "type": "string" | 794 "type": "string" |
720 }, | 795 }, |
721 "accountId": { | 796 "accountId": { |
722 "description": "The account's ID as provided by the <a\nhref
=\"https://developers.google.com/admin-sdk/\">Admin SDK</a>.", | 797 "description": "The account's ID as provided by the\n<a href
=\"https://developers.google.com/admin-sdk/\">Admin SDK</a>.", |
723 "type": "string" | 798 "type": "string" |
724 } | 799 } |
725 }, | 800 }, |
726 "type": "object" | 801 "type": "object" |
727 }, | 802 }, |
728 "ReopenMatterResponse": { | 803 "ReopenMatterResponse": { |
729 "description": "Response to a ReopenMatterRequest.", | 804 "description": "Response to a ReopenMatterRequest.", |
730 "id": "ReopenMatterResponse", | 805 "id": "ReopenMatterResponse", |
731 "properties": { | 806 "properties": { |
732 "matter": { | 807 "matter": { |
733 "$ref": "Matter", | 808 "$ref": "Matter", |
734 "description": "The updated matter, with state OPEN." | 809 "description": "The updated matter, with state OPEN." |
735 } | 810 } |
736 }, | 811 }, |
737 "type": "object" | 812 "type": "object" |
738 }, | 813 }, |
739 "CorpusQuery": { | 814 "CorpusQuery": { |
740 "description": "Corpus specific queries.", | 815 "description": "Corpus specific queries.", |
741 "id": "CorpusQuery", | 816 "id": "CorpusQuery", |
742 "properties": { | 817 "properties": { |
| 818 "driveQuery": { |
| 819 "$ref": "HeldDriveQuery", |
| 820 "description": "Details pertaining to Drive holds. If set, c
orpus must be Drive." |
| 821 }, |
743 "groupsQuery": { | 822 "groupsQuery": { |
744 "$ref": "HeldGroupsQuery", | 823 "$ref": "HeldGroupsQuery", |
745 "description": "Details pertaining to Groups holds. If set,
corpus must be Groups." | 824 "description": "Details pertaining to Groups holds. If set,
corpus must be Groups." |
746 }, | 825 }, |
747 "mailQuery": { | 826 "mailQuery": { |
748 "$ref": "HeldMailQuery", | 827 "$ref": "HeldMailQuery", |
749 "description": "Details pertaining to mail holds. If set, co
rpus must be mail." | 828 "description": "Details pertaining to mail holds. If set, co
rpus must be mail." |
750 }, | |
751 "driveQuery": { | |
752 "$ref": "HeldDriveQuery", | |
753 "description": "Details pertaining to Drive holds. If set, c
orpus must be Drive." | |
754 } | 829 } |
755 }, | 830 }, |
756 "type": "object" | 831 "type": "object" |
757 }, | 832 }, |
758 "Hold": { | 833 "Hold": { |
759 "description": "Represents a hold within Vault. A hold restricts pur
ging of\nartifacts based on the combination of the query and accounts restrictio
ns.\nA hold can be configured to either apply to an explicitly configured set\no
f accounts, or can be applied to all members of an organizational unit.", | 834 "description": "Represents a hold within Vault. A hold restricts pur
ging of\nartifacts based on the combination of the query and accounts restrictio
ns.\nA hold can be configured to either apply to an explicitly configured set\no
f accounts, or can be applied to all members of an organizational unit.", |
760 "id": "Hold", | 835 "id": "Hold", |
761 "properties": { | 836 "properties": { |
762 "accounts": { | 837 "accounts": { |
763 "description": "If set, the hold applies to the enumerated a
ccounts and org_unit must be\nempty.", | 838 "description": "If set, the hold applies to the enumerated a
ccounts and org_unit must be\nempty.", |
764 "items": { | 839 "items": { |
765 "$ref": "HeldAccount" | 840 "$ref": "HeldAccount" |
766 }, | 841 }, |
767 "type": "array" | 842 "type": "array" |
768 }, | 843 }, |
| 844 "query": { |
| 845 "$ref": "CorpusQuery", |
| 846 "description": "The corpus-specific query. If set, the corpu
sQuery must match corpus\ntype." |
| 847 }, |
769 "orgUnit": { | 848 "orgUnit": { |
770 "$ref": "HeldOrgUnit", | 849 "$ref": "HeldOrgUnit", |
771 "description": "If set, the hold applies to all members of t
he organizational unit and\naccounts must be empty. This property is mutable. Fo
r groups holds,\nset the accounts field." | 850 "description": "If set, the hold applies to all members of t
he organizational unit and\naccounts must be empty. This property is mutable. Fo
r groups holds,\nset the accounts field." |
772 }, | 851 }, |
773 "query": { | |
774 "$ref": "CorpusQuery", | |
775 "description": "The corpus-specific query. If set, the corpu
sQuery must match corpus\ntype." | |
776 }, | |
777 "corpus": { | 852 "corpus": { |
778 "description": "The corpus to be searched.", | 853 "description": "The corpus to be searched.", |
779 "enum": [ | 854 "enum": [ |
780 "CORPUS_TYPE_UNSPECIFIED", | 855 "CORPUS_TYPE_UNSPECIFIED", |
781 "DRIVE", | 856 "DRIVE", |
782 "MAIL", | 857 "MAIL", |
783 "GROUPS" | 858 "GROUPS" |
784 ], | 859 ], |
785 "enumDescriptions": [ | 860 "enumDescriptions": [ |
786 "No corpus specified.", | 861 "No corpus specified.", |
787 "Drive.", | 862 "Drive.", |
788 "Mail.", | 863 "Mail.", |
789 "Groups." | 864 "Groups." |
790 ], | 865 ], |
791 "type": "string" | 866 "type": "string" |
792 }, | 867 }, |
793 "updateTime": { | 868 "updateTime": { |
794 "description": "The last time this hold was modified.", | 869 "description": "The last time this hold was modified.", |
795 "format": "google-datetime", | 870 "format": "google-datetime", |
796 "type": "string" | 871 "type": "string" |
797 }, | 872 }, |
| 873 "holdId": { |
| 874 "description": "The unique immutable ID of the hold. Assigne
d during creation.", |
| 875 "type": "string" |
| 876 }, |
798 "name": { | 877 "name": { |
799 "description": "The name of the hold.", | 878 "description": "The name of the hold.", |
800 "type": "string" | 879 "type": "string" |
801 }, | |
802 "holdId": { | |
803 "description": "The unique immutable ID of the hold. Assigne
d during creation.", | |
804 "type": "string" | |
805 } | 880 } |
806 }, | 881 }, |
807 "type": "object" | 882 "type": "object" |
808 }, | 883 }, |
809 "ListHoldsResponse": { | 884 "ListHoldsResponse": { |
810 "description": "The holds for a matter.", | 885 "description": "The holds for a matter.", |
811 "id": "ListHoldsResponse", | 886 "id": "ListHoldsResponse", |
812 "properties": { | 887 "properties": { |
813 "nextPageToken": { | 888 "nextPageToken": { |
814 "description": "Page token to retrieve the next page of resu
lts in the list.\nIf this is empty, then there are no more holds to list.", | 889 "description": "Page token to retrieve the next page of resu
lts in the list.\nIf this is empty, then there are no more holds to list.", |
815 "type": "string" | 890 "type": "string" |
816 }, | 891 }, |
817 "holds": { | 892 "holds": { |
818 "description": "The list of holds.", | 893 "description": "The list of holds.", |
819 "items": { | 894 "items": { |
820 "$ref": "Hold" | 895 "$ref": "Hold" |
821 }, | 896 }, |
822 "type": "array" | 897 "type": "array" |
823 } | 898 } |
824 }, | 899 }, |
825 "type": "object" | 900 "type": "object" |
826 }, | 901 }, |
| 902 "UndeleteMatterRequest": { |
| 903 "description": "Undelete a matter by ID.", |
| 904 "id": "UndeleteMatterRequest", |
| 905 "properties": {}, |
| 906 "type": "object" |
| 907 }, |
827 "ListHeldAccountsResponse": { | 908 "ListHeldAccountsResponse": { |
828 "description": "Returns a list of held accounts for a hold.", | 909 "description": "Returns a list of held accounts for a hold.", |
829 "id": "ListHeldAccountsResponse", | 910 "id": "ListHeldAccountsResponse", |
830 "properties": { | 911 "properties": { |
831 "accounts": { | 912 "accounts": { |
832 "description": "The held accounts on a hold.", | 913 "description": "The held accounts on a hold.", |
833 "items": { | 914 "items": { |
834 "$ref": "HeldAccount" | 915 "$ref": "HeldAccount" |
835 }, | 916 }, |
836 "type": "array" | 917 "type": "array" |
837 } | 918 } |
838 }, | 919 }, |
839 "type": "object" | 920 "type": "object" |
840 }, | 921 }, |
841 "UndeleteMatterRequest": { | |
842 "description": "Undelete a matter by ID.", | |
843 "id": "UndeleteMatterRequest", | |
844 "properties": {}, | |
845 "type": "object" | |
846 }, | |
847 "Empty": { | 922 "Empty": { |
848 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", | 923 "description": "A generic empty message that you can re-use to avoid
defining duplicated\nempty messages in your APIs. A typical example is to use i
t as the request\nor the response type of an API method. For instance:\n\n se
rvice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty
);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.", |
849 "id": "Empty", | 924 "id": "Empty", |
850 "properties": {}, | 925 "properties": {}, |
851 "type": "object" | 926 "type": "object" |
852 }, | 927 }, |
853 "ReopenMatterRequest": { | |
854 "description": "Reopen a matter by ID.", | |
855 "id": "ReopenMatterRequest", | |
856 "properties": {}, | |
857 "type": "object" | |
858 }, | |
859 "CloseMatterRequest": { | 928 "CloseMatterRequest": { |
860 "description": "Close a matter by ID.", | 929 "description": "Close a matter by ID.", |
861 "id": "CloseMatterRequest", | 930 "id": "CloseMatterRequest", |
862 "properties": {}, | 931 "properties": {}, |
863 "type": "object" | 932 "type": "object" |
864 }, | 933 }, |
865 "RemoveMatterPermissionsRequest": { | 934 "ReopenMatterRequest": { |
866 "description": "Remove an account as a matter collaborator.", | 935 "description": "Reopen a matter by ID.", |
867 "id": "RemoveMatterPermissionsRequest", | 936 "id": "ReopenMatterRequest", |
868 "properties": { | 937 "properties": {}, |
869 "accountId": { | |
870 "description": "The account ID.", | |
871 "type": "string" | |
872 } | |
873 }, | |
874 "type": "object" | |
875 }, | |
876 "MatterPermission": { | |
877 "description": "Currently each matter only has one owner, and all ot
hers are collaborators.\nWhen an account is purged, its corresponding MatterPerm
ission resources\ncease to exist.", | |
878 "id": "MatterPermission", | |
879 "properties": { | |
880 "accountId": { | |
881 "description": "The account id, as provided by <a href=\"htt
ps://developers.google.com/admin-sdk/\">Admin SDK</a>.", | |
882 "type": "string" | |
883 }, | |
884 "role": { | |
885 "description": "The user's role in this matter.", | |
886 "enum": [ | |
887 "ROLE_UNSPECIFIED", | |
888 "COLLABORATOR", | |
889 "OWNER" | |
890 ], | |
891 "enumDescriptions": [ | |
892 "No role assigned.", | |
893 "A collaborator to the matter.", | |
894 "The owner of the matter." | |
895 ], | |
896 "type": "string" | |
897 } | |
898 }, | |
899 "type": "object" | |
900 }, | |
901 "ListMattersResponse": { | |
902 "description": "Provides the list of matters.", | |
903 "id": "ListMattersResponse", | |
904 "properties": { | |
905 "nextPageToken": { | |
906 "description": "Page token to retrieve the next page of resu
lts in the list.", | |
907 "type": "string" | |
908 }, | |
909 "matters": { | |
910 "description": "List of matters.", | |
911 "items": { | |
912 "$ref": "Matter" | |
913 }, | |
914 "type": "array" | |
915 } | |
916 }, | |
917 "type": "object" | |
918 }, | |
919 "HeldMailQuery": { | |
920 "description": "Query options for mail holds.", | |
921 "id": "HeldMailQuery", | |
922 "properties": { | |
923 "endTime": { | |
924 "description": "The end date range for the search query. The
se timestamps are in GMT and\nrounded down to the start of the given date.", | |
925 "format": "google-datetime", | |
926 "type": "string" | |
927 }, | |
928 "startTime": { | |
929 "description": "The start date range for the search query. T
hese timestamps are in GMT and\nrounded down to the start of the given date.", | |
930 "format": "google-datetime", | |
931 "type": "string" | |
932 }, | |
933 "terms": { | |
934 "description": "The search terms for the hold.", | |
935 "type": "string" | |
936 } | |
937 }, | |
938 "type": "object" | 938 "type": "object" |
939 } | 939 } |
940 }, | 940 }, |
941 "servicePath": "", | 941 "servicePath": "", |
942 "title": "Google Vault API", | 942 "title": "Google Vault API", |
943 "version": "v1" | 943 "version": "v1" |
944 } | 944 } |
OLD | NEW |