Create permission with the Google Drive API

Shares a file or folder and returns the new permission with its id. Google emails the users and groups it is shared with, unless sendNotificationEmail is false. emailAddress is required for type user or group, and domain for type domain.

Identifier
google_drive_create_permission

The request

POST https://connect.reportei.com/api/tools/google_drive_create_permission/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "fileId": "<fileId>",
    "role": "reader",
    "type": "user"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
fileIdstringYesFile or folder id from List files.
rolestringYesAccess to grant. fileOrganizer and organizer only exist in shared drives.Values: reader, commenter, writer, fileOrganizer, organizer
typestringYesWho receives it: a user or group by e-mail, everyone in a domain, or anyone with the link.Values: user, group, domain, anyone
emailAddressstringNoE-mail of the user or group, for type user or group.
domainstringNoDomain, such as example.com, for type domain.
allowFileDiscoverybooleanNoFor type domain or anyone, whether the file shows up in search. Without it the file is reached only by its link.
expirationTimestringNoWhen the access ends, RFC 3339, in the future and at most a year away. Only for type user or group.
sendNotificationEmailbooleanNoEmails users and groups about the share. The default is true; false shares silently.
emailMessagestringNoPlain text message added to the notification e-mail.
supportsAllDrivesbooleanNoSet to true when the file can be in a shared drive.
viewstringNoSet it to published to grant access to the published view of a Google Form, which decides who can answer it: with type anyone, anyone with the link; with type user, the given email. Omit it for a normal permission on the file.Values: published

Supported connections

Your customer connects their Google Drive account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/google_drive, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/google_drive_create_permission. It becomes your agent's tool definition with no conversion.

Other Google Drive tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.