1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
<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, 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, 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. (required)
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.
"lastName": "A String", # Output only. The last name of the account holder.
"holdTime": "A String", # Output only. When the account was put on hold.
"email": "A String", # The primary email address of the account. If used as an input, this takes
# precedence over account ID.
"firstName": "A String", # Output only. The first 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>.
}
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.
"lastName": "A String", # Output only. The last name of the account holder.
"holdTime": "A String", # Output only. When the account was put on hold.
"email": "A String", # The primary email address of the account. If used as an input, this takes
# precedence over account ID.
"firstName": "A String", # Output only. The first 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>.
}</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.
"lastName": "A String", # Output only. The last name of the account holder.
"holdTime": "A String", # Output only. When the account was put on hold.
"email": "A String", # The primary email address of the account. If used as an input, this takes
# precedence over account ID.
"firstName": "A String", # Output only. The first 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>.
},
],
}</pre>
</div>
</body></html>
|
