provider permissions POST /files/{fileId}/permissions
@utdk/google/drive /files/{fileId}/permissions
permissions.create
Creates a permission for a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.
$.xgafv query
V1 error format.
enum: 1, 2
access_token query
OAuth access token.
string
alt query
Data format for response.
enum: json, media, proto
callback query
JSONP
string
fields query
Selector specifying which fields to include in a partial response.
string
key query
API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
string
oauth_token query
OAuth 2.0 token for the current user.
string
prettyPrint query
Returns response with indentations and line breaks.
boolean
quotaUser query
Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
string
upload_protocol query
Upload protocol for media (e.g. "raw", "multipart").
string
uploadType query
Legacy upload protocol for media (e.g. "media", "multipart").
string
fileId path required
The ID of the file or shared drive.
string
emailMessage query
A plain text custom message to include in the notification email.
string
enforceSingleParent query
Deprecated: See `moveToNewOwnersRoot` for details.
boolean
moveToNewOwnersRoot query
This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to `true`, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to `false`, parents are not changed.
boolean
sendNotificationEmail query
Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.
boolean
supportsAllDrives query
Whether the requesting application supports both My Drives and shared drives.
boolean
supportsTeamDrives query
Deprecated: Use `supportsAllDrives` instead.
boolean
transferOwnership query
Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.
boolean
useDomainAdminAccess query
Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.
boolean

Try it

Authentication
Configure credentials for Google Drive API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

permissionsCreate
POST/files/{fileId}/permissions
Creates a permission for a file or shared drive. **Warning:** Concurrent permissions operations on the same file are not supported; only the last update is applied.

Parameters

required

The ID of the file or shared drive.

V1 error format.

OAuth access token.

Data format for response.

JSONP

Selector specifying which fields to include in a partial response.

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

OAuth 2.0 token for the current user.

Returns response with indentations and line breaks.

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.

Upload protocol for media (e.g. "raw", "multipart").

Legacy upload protocol for media (e.g. "media", "multipart").

A plain text custom message to include in the notification email.

Deprecated: See `moveToNewOwnersRoot` for details.

This parameter will only take effect if the item is not in a shared drive and the request is attempting to transfer the ownership of the item. If set to `true`, the item will be moved to the new owner's My Drive root folder and all prior parents removed. If set to `false`, parents are not changed.

Whether to send a notification email when sharing to users or groups. This defaults to true for users and groups, and is not allowed for other requests. It must not be disabled for ownership transfers.

Whether the requesting application supports both My Drives and shared drives.

Deprecated: Use `supportsAllDrives` instead.

Whether to transfer ownership to the specified user and downgrade the current owner to a writer. This parameter is required as an acknowledgement of the side effect.

Issue the request as a domain administrator; if set to true, then the requester will be granted access if the file ID parameter refers to a shared drive and the requester is an administrator of the domain to which the shared drive belongs.

Input

Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`.

Output only. Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.

Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * `user` - User's full name, as defined for their Google account, such as "Joe Smith." * `group` - Name of the Google Group, such as "The Company Administrators." * `domain` - String domain name, such as "thecompany.com." * `anyone` - No `displayName` is present.

The domain to which this permission refers.

The email address of the user or group to which this permission refers.

The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions: - They can only be set on user and group permissions - The time must be in the future - The time cannot be more than a year in the future

Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as `permissionId`. IDs should be treated as opaque values.

Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`.

Whether the account associated with this permission is a pending owner. Only populated for `user` type permissions for files that are not in a shared drive.

Output only. Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

Output only. A link to the user's profile photo, if available.

The role granted by this permission. While new values may be supported in the future, the following are currently allowed: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader`

Output only. Deprecated: Output only. Use `permissionDetails` instead.

The type of the grantee. Valid values are: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. When `type` is `domain`, you must provide a `domain`. There isn't extra information required for an `anyone` type.

Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import google_drive from '@utdk/google/drive';

await google_drive.permissionsCreate({
  "kind": "drive#permission"
})