Team Drives-related fields in the Vault API are being replaced. Learn more.

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.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

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

create

Adds an account to a hold.

delete

Removes an account from a hold.

list

Lists the accounts covered by a hold.