Google Vault API

Retenção e e-discovery para o Google Workspace.

Para usar os recursos do Vault, a conta precisa ter os privilégios necessários e acesso ao caso. Para acessar um caso, a conta precisa ter criado ou compartilhado o caso ou ter o privilégio Ver todos os casos. Por exemplo, para fazer o download de uma exportação, uma conta precisa do privilégio Gerenciar exportações e do caso compartilhado com ela.

Serviço: vault.googleapis.com

Para chamar esse serviço, recomendamos que você use as bibliotecas de cliente fornecidas pelo Google. Caso seu aplicativo precise usar suas próprias bibliotecas para chamar esse serviço, use as informações a seguir quando fizer as solicitações de API.

Documento de descoberta

Um Documento de descoberta é uma especificação legível por máquina para descrever e consumir APIs REST. Ele é usado para criar bibliotecas de cliente, plug-ins IDE e outras ferramentas que interagem com as APIs do Google. Um serviço pode fornecer vários documentos de descoberta. O serviço fornece o seguinte documento de detecção:

Endpoint de serviço

Um endpoint de serviço é um URL base que especifica o endereço de rede de um serviço de API. Um serviço pode ter vários endpoints de serviço. Este serviço tem o endpoint a seguir e todos os URIs abaixo são relativos a ele:

  • https://vault.googleapis.com

Recurso REST: v1.matters

Métodos
addPermissions POST /v1/matters/{matterId}:addPermissions
Adiciona uma conta como colaborador do caso.
close POST /v1/matters/{matterId}:close
Fecha o caso especificado.
count POST /v1/matters/{matterId}:count
Conta as contas processadas pela consulta especificada.
create POST /v1/matters
Cria um caso com o nome e a descrição fornecidos.
delete DELETE /v1/matters/{matterId}
Exclui o caso especificado.
get GET /v1/matters/{matterId}
Recebe o caso especificado.
list GET /v1/matters
Lista os casos a que o solicitante tem acesso.
removePermissions POST /v1/matters/{matterId}:removePermissions
Remove uma conta como colaborador do caso.
reopen POST /v1/matters/{matterId}:reopen
Reabre o caso especificado.
undelete POST /v1/matters/{matterId}:undelete
Cancela a exclusão do caso especificado.
update PUT /v1/matters/{matterId}
Atualiza o caso especificado.

Recurso REST: v1.matters.exports

Métodos
create POST /v1/matters/{matterId}/exports
Cria uma exportação.
delete DELETE /v1/matters/{matterId}/exports/{exportId}
Exclui uma exportação.
get GET /v1/matters/{matterId}/exports/{exportId}
Recebe uma exportação.
list GET /v1/matters/{matterId}/exports
Lista detalhes sobre as exportações no caso especificado.

Recurso REST: v1.matters.holds

Métodos
addHeldAccounts POST /v1/matters/{matterId}/holds/{holdId}:addHeldAccounts
Adiciona contas a uma guarda de documentos.
create POST /v1/matters/{matterId}/holds
Cria uma guarda de documentos no caso especificado.
delete DELETE /v1/matters/{matterId}/holds/{holdId}
Remove a guarda de documentos especificada e libera as contas ou a unidade organizacional cobertas.
get GET /v1/matters/{matterId}/holds/{holdId}
Recupera a retenção especificada.
list GET /v1/matters/{matterId}/holds
Lista as guardas de documentos em um caso.
removeHeldAccounts POST /v1/matters/{matterId}/holds/{holdId}:removeHeldAccounts
Remove as contas especificadas da guarda de documentos.
update PUT /v1/matters/{matterId}/holds/{holdId}
Atualiza o escopo (unidade organizacional ou contas) e parâmetros de consulta de uma guarda de documentos.

Recurso REST: v1.matters.holds.accounts

Métodos
create POST /v1/matters/{matterId}/holds/{holdId}/accounts
Adiciona uma conta a uma guarda de documentos.
delete DELETE /v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}
Remove uma conta da guarda de documentos.
list GET /v1/matters/{matterId}/holds/{holdId}/accounts
Lista as contas cobertas por uma guarda de documentos.

Recurso REST: v1.matters.savedQueries

Métodos
create POST /v1/matters/{matterId}/savedQueries
Cria uma consulta salva.
delete DELETE /v1/matters/{matterId}/savedQueries/{savedQueryId}
Exclui a consulta salva especificada.
get GET /v1/matters/{matterId}/savedQueries/{savedQueryId}
Recupera a consulta salva especificada.
list GET /v1/matters/{matterId}/savedQueries
Lista as consultas salvas em um caso.

Recurso da REST: v1.operations

Métodos
cancel POST /v1/{name=operations/**}:cancel
Inicia o cancelamento assíncrono de uma operação de longa duração.
delete DELETE /v1/{name=operations/**}
Exclui uma operação de longa duração.
get GET /v1/{name=operations/**}
Recebe o estado mais recente de uma operação de longa duração.
list GET /v1/{name}
Lista as operações que correspondem ao filtro especificado na solicitação.