docs/dyn/vault_v1.matters.holds.accounts.html

<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<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>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
  <code><a href="#create">create(matterId, holdId, body=None, x__xgafv=None)</a></code></p>
<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>
<p class="toc_element">
  <code><a href="#delete">delete(matterId, holdId, accountId, x__xgafv=None)</a></code></p>
<p class="firstline">Removes an account from a hold.</p>
<p class="toc_element">
  <code><a href="#list">list(matterId, holdId, x__xgafv=None)</a></code></p>
<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>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

<div class="method">
    <code class="details" id="create">create(matterId, holdId, body=None, x__xgafv=None)</code>
  <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.

Args:
  matterId: string, The matter ID. (required)
  holdId: string, The hold ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # 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.
  &quot;accountId&quot;: &quot;A String&quot;, # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
  &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes precedence over **accountId**.
  &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
  &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
  &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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.
  &quot;accountId&quot;: &quot;A String&quot;, # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
  &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes precedence over **accountId**.
  &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
  &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
  &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
}</pre>
</div>

<div class="method">
    <code class="details" id="delete">delete(matterId, holdId, accountId, x__xgafv=None)</code>
  <pre>Removes an account from a hold.

Args:
  matterId: string, The matter ID. (required)
  holdId: string, The hold ID. (required)
  accountId: string, The ID of the account to remove from the hold. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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 `{}`.
}</pre>
</div>

<div class="method">
    <code class="details" id="list">list(matterId, holdId, x__xgafv=None)</code>
  <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.

Args:
  matterId: string, The matter ID. (required)
  holdId: string, The hold ID. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Returns a list of the accounts covered by a hold.
  &quot;accounts&quot;: [ # The held accounts on a hold.
    { # 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.
      &quot;accountId&quot;: &quot;A String&quot;, # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
      &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes precedence over **accountId**.
      &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
      &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
      &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
    },
  ],
}</pre>
</div>

</body></html>