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

REST Resource: matters

Resource: Matter

Represents a matter.

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
{
  "matterId": string,
  "name": string,
  "description": string,
  "state": enum (State),
  "matterPermissions": [
    {
      object (MatterPermission)
    }
  ]
}
Fields
matterId

string

The matter ID, which is generated by the server. Leave blank when creating a matter.

name

string

The name of the matter.

description

string

An optional description for the matter.

state

enum (State)

The state of the matter.

matterPermissions[]

object (MatterPermission)

Lists the users and their permission for the matter. Currently there is no programmer defined limit on the number of permissions a matter can have.

State

The state of a matter.

Enums
STATE_UNSPECIFIED The matter has no specified state.
OPEN The matter is open.
CLOSED The matter is closed.
DELETED The matter is deleted.

MatterPermission

Users can be matter owners or collaborators. Each matter has only one owner. All others users who can access the matter are collaborators. When an account is purged, its corresponding MatterPermission resources cease to exist.

JSON representation
{
  "role": enum (AclRole),
  "accountId": string
}
Fields
role

enum (AclRole)

The user's role for the matter.

accountId

string

The account ID, as provided by the Admin SDK.

AclRole

The possible user permissions for a matter, in order of increasing permissions.

Enums
ROLE_UNSPECIFIED No role assigned.
COLLABORATOR A collaborator on the matter.
OWNER The owner of the matter.

Methods

addPermissions

Adds an account as a matter collaborator.

close

Closes the specified matter.

count

Counts the accounts processed by the specified query.

create

Creates a matter with the given name and description.

delete

Deletes the specified matter.

get

Gets the specified matter.

list

Lists matters the requestor has access to.

removePermissions

Removes an account as a matter collaborator.

reopen

Reopens the specified matter.

undelete

Undeletes the specified matter.

update

Updates the specified matter.