Google Vault API . matters . holds . accounts

close()

Close httplib2 connections.

create(matterId, holdId, body=None, x__xgafv=None)

Adds an account to a hold. Accounts can be added only to a hold that does not have an organizational unit set. If you try to add an account to an organizational unit-based hold, an error is returned.

Args:
  matterId: string, The matter ID. (required)
  holdId: string, The hold ID. (required)
  body: object, The request body.
    The object takes the form of:

{ # 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] (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.
  "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
  "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over **accountId**.
  "firstName": "A String", # Output only. The first name of the account holder.
  "holdTime": "A String", # Output only. When the account was put on hold.
  "lastName": "A String", # Output only. The last name of the account holder.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # 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] (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.
  "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
  "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over **accountId**.
  "firstName": "A String", # Output only. The first name of the account holder.
  "holdTime": "A String", # Output only. When the account was put on hold.
  "lastName": "A String", # Output only. The last name of the account holder.
}

delete(matterId, holdId, accountId, x__xgafv=None)

Removes an account from a hold.

Args:
  matterId: string, The matter ID. (required)
  holdId: string, The hold ID. (required)
  accountId: string, The ID of the account to remove from the hold. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

list(matterId, holdId, x__xgafv=None)

Lists the accounts covered by a hold. This can list only individually-specified accounts covered by the hold. If the hold covers an organizational unit, use the [Admin SDK](https://developers.google.com/admin-sdk/). to list the members of the organizational unit on hold.

Args:
  matterId: string, The matter ID. (required)
  holdId: string, The hold ID. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Returns a list of the accounts covered by a hold.
  "accounts": [ # The held accounts on a hold.
    { # 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] (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.
      "accountId": "A String", # The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
      "email": "A String", # The primary email address of the account. If used as an input, this takes precedence over **accountId**.
      "firstName": "A String", # Output only. The first name of the account holder.
      "holdTime": "A String", # Output only. When the account was put on hold.
      "lastName": "A String", # Output only. The last name of the account holder.
    },
  ],
}