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

REST Resource: matters.holds.accounts

Resource: HeldAccount

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.

JSON representation
{
  "accountId": string,
  "holdTime": string,
  "email": string,
  "firstName": string,
  "lastName": string
}
Fields
accountId

string

The account's 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, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

email

string

The primary email address of the account. If used as an input, this takes precedence over account ID.

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 a HeldAccount to a hold.

delete

Removes a HeldAccount from a hold.

list

Lists HeldAccounts for a hold.