REST Resource: matters.holds.accounts
Stay organized with collections
Save and categorize content based on your preferences.
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-03-17 UTC.
[null,null,["Last updated 2025-03-17 UTC."],[],[],null,["# REST Resource: matters.holds.accounts\n\n- [Resource: HeldAccount](#HeldAccount)\n - [JSON representation](#HeldAccount.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: HeldAccount\n---------------------\n\nAn account covered by a hold. This structure is immutable. It can be an individual account or a Google Group, depending on the service.\n\nTo 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.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------|\n| ``` { \"accountId\": string, \"holdTime\": string, \"email\": string, \"firstName\": string, \"lastName\": string } ``` |\n\n| Fields ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `accountId` | `string` The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/). |\n| `holdTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#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\"`. |\n| `email` | `string` The primary email address of the account. If used as an input, this takes precedence over **accountId**. |\n| `firstName` | `string` Output only. The first name of the account holder. |\n| `lastName` | `string` Output only. The last name of the account holder. |\n\n| Methods ------- ||\n|--------------------------------------------------------------------------------|---------------------------------------|\n| ### [create](/workspace/vault/reference/rest/v1/matters.holds.accounts/create) | Adds an account to a hold. |\n| ### [delete](/workspace/vault/reference/rest/v1/matters.holds.accounts/delete) | Removes an account from a hold. |\n| ### [list](/workspace/vault/reference/rest/v1/matters.holds.accounts/list) | Lists the accounts covered by a hold. |"]]