REST Resource: matters.holds.accounts
Resource: HeldAccount
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 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.
| JSON representation |
{
"accountId": string,
"holdTime": string,
"email": string,
"firstName": string,
"lastName": string
} |
| Fields |
accountId |
string
The account ID, as provided by the Admin SDK.
|
holdTime |
string (Timestamp format)
Output only. When the account was put on hold. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
|
email |
string
The primary email address of the account. If used as an input, this takes precedence over accountId.
|
firstName |
string
Output only. The first name of the account holder.
|
lastName |
string
Output only. The last name of the account holder.
|
Methods |
|
|
Adds an account to a hold. |
|
|
Removes an account from a hold. |
|
|
Lists the accounts covered by a hold. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-27 UTC.
[null,null,["Last updated 2025-02-27 UTC."],[[["A HeldAccount represents an account (individual or Google Group) placed on hold within a matter in Google Vault."],["To interact with HeldAccounts, users need specific Vault privileges and access to the relevant matter."],["HeldAccount details include account ID, hold time, email, first name, and last name, with some fields being immutable and output-only."],["You can manage HeldAccounts by adding them to, removing them from, or listing them within a hold using the available methods."]]],["The `HeldAccount` resource represents an account under a hold, which can be an individual account or a Google Group. Key information includes `accountId`, `holdTime` (when the hold was applied), `email`, `firstName`, and `lastName`. The resource is immutable. Important actions include: creating an account in a hold using the `/create` method, deleting an account from a hold using `/delete` method, and listing accounts within a hold using `/list` method. To perform these actions, users need specific Vault privileges and access to the relevant matter.\n"]]
