Method: matters.addPermissions
Adds an account as a matter collaborator.
HTTP request
POST https://vault.googleapis.com/v1/matters/{matterId}:addPermissions
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
matterId |
string
The matter ID.
|
Request body
The request body contains data with the following structure:
| JSON representation |
{
"matterPermission": {
object (MatterPermission)
},
"sendEmails": boolean,
"ccMe": boolean
} |
| Fields |
matterPermission |
object (MatterPermission)
The account and its role to add.
|
sendEmails |
boolean
To send a notification email to the added account, set to true. To not send a notification email, set to false.
|
ccMe |
boolean
Only relevant if sendEmails is true. To CC the requestor in the email message, set to true. To not CC requestor, set to false.
|
Response body
If successful, the response body contains an instance of MatterPermission.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/ediscovery
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-27 UTC.
[null,null,["Last updated 2025-02-27 UTC."],[[["Adds an account as a collaborator to a specified matter using the provided matter ID."],["Requires a request body specifying the account's permissions, along with optional notification email settings."],["Uses the `POST https://vault.googleapis.com/v1/matters/{matterId}:addPermissions` endpoint for the operation."],["Utilizes OAuth scope `https://www.googleapis.com/auth/ediscovery` for authorization."],["Returns a MatterPermission object in the response body upon successful completion."]]],["This outlines the process to add an account as a matter collaborator using a POST request to `https://vault.googleapis.com/v1/matters/{matterId}:addPermissions`. The request requires a `matterId` path parameter and a JSON request body containing `matterPermission`, `sendEmails`, and `ccMe` fields. Upon success, it returns a `MatterPermission` object. Authorization requires the `https://www.googleapis.com/auth/ediscovery` OAuth scope. The process allows an option to send an email to the new collaborator, with an option for the requestor to be copied.\n"]]
