1<html><body> 2<style> 3 4body, h1, h2, h3, div, span, p, pre, a { 5 margin: 0; 6 padding: 0; 7 border: 0; 8 font-weight: inherit; 9 font-style: inherit; 10 font-size: 100%; 11 font-family: inherit; 12 vertical-align: baseline; 13} 14 15body { 16 font-size: 13px; 17 padding: 1em; 18} 19 20h1 { 21 font-size: 26px; 22 margin-bottom: 1em; 23} 24 25h2 { 26 font-size: 24px; 27 margin-bottom: 1em; 28} 29 30h3 { 31 font-size: 20px; 32 margin-bottom: 1em; 33 margin-top: 1em; 34} 35 36pre, code { 37 line-height: 1.5; 38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; 39} 40 41pre { 42 margin-top: 0.5em; 43} 44 45h1, h2, h3, p { 46 font-family: Arial, sans serif; 47} 48 49h1, h2, h3 { 50 border-bottom: solid #CCC 1px; 51} 52 53.toc_element { 54 margin-top: 0.5em; 55} 56 57.firstline { 58 margin-left: 2 em; 59} 60 61.method { 62 margin-top: 1em; 63 border: solid 1px #CCC; 64 padding: 1em; 65 background: #EEE; 66} 67 68.details { 69 font-weight: bold; 70 font-size: 14px; 71} 72 73</style> 74 75<h1><a href="vault_v1.html">Google Vault API</a> . <a href="vault_v1.matters.html">matters</a> . <a href="vault_v1.matters.holds.html">holds</a> . <a href="vault_v1.matters.holds.accounts.html">accounts</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(matterId, holdId, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Adds an account to a hold. Accounts can be added only to a hold that does not have an organizational unit set. If you try to add an account to an organizational unit-based hold, an error is returned.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(matterId, holdId, accountId, x__xgafv=None)</a></code></p> 85<p class="firstline">Removes an account from a hold.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(matterId, holdId, x__xgafv=None)</a></code></p> 88<p class="firstline">Lists the accounts covered by a hold. This can list only individually-specified accounts covered by the hold. If the hold covers an organizational unit, use the [Admin SDK](https://developers.google.com/admin-sdk/). to list the members of the organizational unit on hold.</p> 89<h3>Method Details</h3> 90<div class="method"> 91 <code class="details" id="close">close()</code> 92 <pre>Close httplib2 connections.</pre> 93</div> 94 95<div class="method"> 96 <code class="details" id="create">create(matterId, holdId, body=None, x__xgafv=None)</code> 97 <pre>Adds an account to a hold. Accounts can be added only to a hold that does not have an organizational unit set. If you try to add an account to an organizational unit-based hold, an error is returned. 98 99Args: 100 matterId: string, The matter ID. (required) 101 holdId: string, The hold ID. (required) 102 body: object, The request body. 103 The object takes the form of: 104 105{ # An account covered by a hold. This structure is immutable. It can be an individual account or a Google Group, depending on the service. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. 106 "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 107 "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over **accountId**. 108 "firstName": "A String", # Output only. The first name of the account holder. 109 "holdTime": "A String", # Output only. When the account was put on hold. 110 "lastName": "A String", # Output only. The last name of the account holder. 111} 112 113 x__xgafv: string, V1 error format. 114 Allowed values 115 1 - v1 error format 116 2 - v2 error format 117 118Returns: 119 An object of the form: 120 121 { # An account covered by a hold. This structure is immutable. It can be an individual account or a Google Group, depending on the service. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. 122 "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 123 "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over **accountId**. 124 "firstName": "A String", # Output only. The first name of the account holder. 125 "holdTime": "A String", # Output only. When the account was put on hold. 126 "lastName": "A String", # Output only. The last name of the account holder. 127}</pre> 128</div> 129 130<div class="method"> 131 <code class="details" id="delete">delete(matterId, holdId, accountId, x__xgafv=None)</code> 132 <pre>Removes an account from a hold. 133 134Args: 135 matterId: string, The matter ID. (required) 136 holdId: string, The hold ID. (required) 137 accountId: string, The ID of the account to remove from the hold. (required) 138 x__xgafv: string, V1 error format. 139 Allowed values 140 1 - v1 error format 141 2 - v2 error format 142 143Returns: 144 An object of the form: 145 146 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 147}</pre> 148</div> 149 150<div class="method"> 151 <code class="details" id="list">list(matterId, holdId, x__xgafv=None)</code> 152 <pre>Lists the accounts covered by a hold. This can list only individually-specified accounts covered by the hold. If the hold covers an organizational unit, use the [Admin SDK](https://developers.google.com/admin-sdk/). to list the members of the organizational unit on hold. 153 154Args: 155 matterId: string, The matter ID. (required) 156 holdId: string, The hold ID. (required) 157 x__xgafv: string, V1 error format. 158 Allowed values 159 1 - v1 error format 160 2 - v2 error format 161 162Returns: 163 An object of the form: 164 165 { # Returns a list of the accounts covered by a hold. 166 "accounts": [ # The held accounts on a hold. 167 { # An account covered by a hold. This structure is immutable. It can be an individual account or a Google Group, depending on the service. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege. 168 "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). 169 "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over **accountId**. 170 "firstName": "A String", # Output only. The first name of the account holder. 171 "holdTime": "A String", # Output only. When the account was put on hold. 172 "lastName": "A String", # Output only. The last name of the account holder. 173 }, 174 ], 175}</pre> 176</div> 177 178</body></html>