docs/dyn/vault_v1.matters.holds.accounts.html - external/github.com/google/google-api-python-client - Git at Google

 <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">G Suite 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="#create">create(matterId, holdId, body=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Adds a HeldAccount to a hold. Accounts can only be added to a hold that</p>
 <p class="toc_element">
   <code><a href="#delete">delete(matterId, holdId, accountId, x__xgafv=None)</a></code></p>
 <p class="firstline">Removes a HeldAccount from a hold. If this request leaves the hold with</p>
 <p class="toc_element">
   <code><a href="#list">list(matterId, holdId, x__xgafv=None)</a></code></p>
 <p class="firstline">Lists HeldAccounts for a hold. This will only list individually specified</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="create">create(matterId, holdId, body=None, x__xgafv=None)</code>
   <pre>Adds a HeldAccount to a hold. Accounts can only be added to a hold that
 has no held_org_unit set. Attempting to add an account to an OU-based
 hold will result in an error.

 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 being held in a particular hold. This structure is immutable.
     # This can be either a single user or a google group, depending on the corpus.
   &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
   &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
   &quot;accountId&quot;: &quot;A String&quot;, # The account&#x27;s ID as provided by the
       # &lt;a href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
   &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes
       # precedence over account ID.
   &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
 }

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

 Returns:
   An object of the form:

     { # An account being held in a particular hold. This structure is immutable.
       # This can be either a single user or a google group, depending on the corpus.
     &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
     &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
     &quot;accountId&quot;: &quot;A String&quot;, # The account&#x27;s ID as provided by the
         # &lt;a href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
     &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes
         # precedence over account ID.
     &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="delete">delete(matterId, holdId, accountId, x__xgafv=None)</code>
   <pre>Removes a HeldAccount from a hold. If this request leaves the hold with
 no held accounts, the hold will not apply to any accounts.

 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 HeldAccounts for a hold. This will only list individually specified
 held accounts. If the hold is on an OU, then use
 &lt;a href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;
 to enumerate its members.

 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 held accounts for a hold.
     &quot;accounts&quot;: [ # The held accounts on a hold.
       { # An account being held in a particular hold. This structure is immutable.
           # This can be either a single user or a google group, depending on the corpus.
         &quot;firstName&quot;: &quot;A String&quot;, # Output only. The first name of the account holder.
         &quot;lastName&quot;: &quot;A String&quot;, # Output only. The last name of the account holder.
         &quot;accountId&quot;: &quot;A String&quot;, # The account&#x27;s ID as provided by the
             # &lt;a href=&quot;https://developers.google.com/admin-sdk/&quot;&gt;Admin SDK&lt;/a&gt;.
         &quot;email&quot;: &quot;A String&quot;, # The primary email address of the account. If used as an input, this takes
             # precedence over account ID.
         &quot;holdTime&quot;: &quot;A String&quot;, # Output only. When the account was put on hold.
       },
     ],
   }</pre>
 </div>

 </body></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">G Suite 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="#create">create(matterId, holdId, body=None, x__xgafv=None)</a></code></p>
	<p class="firstline">Adds a HeldAccount to a hold. Accounts can only be added to a hold that</p>
	<p class="toc_element">
	<code><a href="#delete">delete(matterId, holdId, accountId, x__xgafv=None)</a></code></p>
	<p class="firstline">Removes a HeldAccount from a hold. If this request leaves the hold with</p>
	<p class="toc_element">
	<code><a href="#list">list(matterId, holdId, x__xgafv=None)</a></code></p>
	<p class="firstline">Lists HeldAccounts for a hold. This will only list individually specified</p>
	<h3>Method Details</h3>
	<div class="method">
	<code class="details" id="create">create(matterId, holdId, body=None, x__xgafv=None)</code>
	<pre>Adds a HeldAccount to a hold. Accounts can only be added to a hold that
	has no held_org_unit set. Attempting to add an account to an OU-based
	hold will result in an error.

	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 being held in a particular hold. This structure is immutable.
	# This can be either a single user or a google group, depending on the corpus.
	"firstName": "A String", # Output only. The first name of the account holder.
	"lastName": "A String", # Output only. The last name of the account holder.
	"accountId": "A String", # The account's ID as provided by the
	# <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
	"email": "A String", # The primary email address of the account. If used as an input, this takes
	# precedence over account ID.
	"holdTime": "A String", # Output only. When the account was put on hold.
	}

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

	Returns:
	An object of the form:

	{ # An account being held in a particular hold. This structure is immutable.
	# This can be either a single user or a google group, depending on the corpus.
	"firstName": "A String", # Output only. The first name of the account holder.
	"lastName": "A String", # Output only. The last name of the account holder.
	"accountId": "A String", # The account's ID as provided by the
	# <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
	"email": "A String", # The primary email address of the account. If used as an input, this takes
	# precedence over account ID.
	"holdTime": "A String", # Output only. When the account was put on hold.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="delete">delete(matterId, holdId, accountId, x__xgafv=None)</code>
	<pre>Removes a HeldAccount from a hold. If this request leaves the hold with
	no held accounts, the hold will not apply to any accounts.

	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 HeldAccounts for a hold. This will only list individually specified
	held accounts. If the hold is on an OU, then use
	<a href="https://developers.google.com/admin-sdk/">Admin SDK</a>
	to enumerate its members.

	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 held accounts for a hold.
	"accounts": [ # The held accounts on a hold.
	{ # An account being held in a particular hold. This structure is immutable.
	# This can be either a single user or a google group, depending on the corpus.
	"firstName": "A String", # Output only. The first name of the account holder.
	"lastName": "A String", # Output only. The last name of the account holder.
	"accountId": "A String", # The account's ID as provided by the
	# <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
	"email": "A String", # The primary email address of the account. If used as an input, this takes
	# precedence over account ID.
	"holdTime": "A String", # Output only. When the account was put on hold.
	},
	],
	}</pre>
	</div>

	</body></html>