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 |
The account ID, as provided by the Admin SDK. |
holdTime |
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: |
email |
The primary email address of the account. If used as an input, this takes precedence over accountId. |
firstName |
Output only. The first name of the account holder. |
lastName |
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. |