# G Suite Vault API . matters . holds . accounts

## Instance Methods

Adds a HeldAccount to a hold. Accounts can only be added to a hold that

Removes a HeldAccount from a hold. If this request leaves the hold with

Lists HeldAccounts for a hold. This will only list individually specified

### Method Details

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

    Adds a HeldAccount to a hold. Accounts can only be added to a hold that
    has no held_org_unit set. Attempting to add an account to an OU-based
    hold will result in an error.

    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 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.
      "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.
      "email": "A String", # The primary email address of the account. If used as an input, this takes
          # precedence over account ID.
      "accountId": "A String", # The account's ID as provided by the
          # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
    }

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

    Returns:
      An object of the form:

        { # 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.
        "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.
        "email": "A String", # The primary email address of the account. If used as an input, this takes
            # precedence over account ID.
        "accountId": "A String", # The account's ID as provided by the
            # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
      }

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

    Removes a HeldAccount from a hold. If this request leaves the hold with
    no held accounts, the hold will not apply to any accounts.

    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);
          #     }
          #
          # The JSON representation for `Empty` is empty JSON object `{}`.
      }

`list(matterId, holdId, x__xgafv=None)`

    Lists HeldAccounts for a hold. This will only list individually specified
    held accounts. If the hold is on an OU, then use
    <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>
    to enumerate its members.

    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 held accounts for a hold.
        "accounts": [ # The held accounts on a hold.
          { # 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.
            "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.
            "email": "A String", # The primary email address of the account. If used as an input, this takes
                # precedence over account ID.
            "accountId": "A String", # The account's ID as provided by the
                # <a href="https://developers.google.com/admin-sdk/">Admin SDK</a>.
          },
        ],
      }