Skip to content

Google: Creates a permission for a file or shared drive For more information, see Share files, folders, and drives (https: developers google com workspace drive api guides manage-sharing) **Warning:** Concurrent permission modifications (such as update or delete) on the same file, folder, or shared drive aren't supported across any users or clients; only the last update is applied — request body — body

Creates a permission for a file or shared drive. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). **Warning:** Concurrent permission modifications (such as update or delete) on the same file, folder, or shared drive aren't supported across any users or clients; only the last update is applied.: request body, field body. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Creates a permission for a file or shared drive For more information, see Share files, folders, and drives (https: developers google com workspace drive api guides manage-sharing) **Warning:** Concurrent permission modifications (such as update or delete) on the same file, folder, or shared drive aren't supported across any users or clients; only the last update is applied — request body — body

FieldTypePresenceDescription and constraints
$objectRootA permission for a file. A permission grants a user, group, domain, or the world access to a file or a folder hierarchy. For more information, see [Share files, folders, and drives](https://developers.google.com/workspace/drive/api/guides/manage-sharing). By default, permission requests only return a subset of fields. Permission `kind`, `ID`, `type`, and `role` are always returned. To retrieve specific fields, see [Return specific fields](https://developers.google.com/workspace/drive/api/guides/fields-parameter). Some resource methods (such as `permissions.update`) require a `permissionId`. Use the `permissions.list` method to retrieve the ID for a file, folder, or shared drive.
allowFileDiscoverybooleanOptionalWhether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`.
deletedbooleanOptionalOutput only. Whether the account associated with this permission has been deleted. This field only pertains to permissions of type `user` or `group`.
displayNamestringOptionalOutput 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 “Dana A.” * `group` - Name of the Google Group, such as “The Company Administrators.” * `domain` - String domain name, such as “cymbalgroup.com.” * `anyone` - No `displayName` is present.
domainstringOptionalOutput only. The domain to which this permission refers.
Read only: true
emailAddressstringOptionalOutput only. The email address of the user or group to which this permission refers.
Read only: true
expirationTimestringOptionalThe 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
Format: date-time
idstringOptionalOutput only. The ID of this permission. This is a unique identifier for the grantee, and is published in the [User resource](https://developers.google.com/workspace/drive/api/reference/rest/v3/User) as `permissionId`. IDs should be treated as opaque values.
inheritedPermissionsDisabledbooleanOptionalWhen `true`, only organizers, owners, and users with permissions added directly on the item can access it.
kindstringOptionalOutput only. Identifies what kind of resource this is. Value: the fixed string `“drive#permission”`.
Default: drive#permission
pendingOwnerbooleanOptionalWhether the account associated with this permission is a pending owner. Only populated for permissions of type `user` for files that aren’t in a shared drive.
permissionDetailsarrayOptionalOutput only. Details of whether the permissions on this item are inherited or are directly on this item.
Read only: true
permissionDetails[]ModelEach itemExpand Gets a permission by ID For more information, see Share files, folders, and drives (https: developers google com workspace drive api guides manage-sharing) — response body — permission Details item
photoLinkstringOptionalOutput only. A link to the user’s profile photo, if available.
rolestringRequired within parentThe role granted by this permission. Supported values include: * `owner` * `organizer` * `fileOrganizer` * `writer` * `commenter` * `reader` For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).
teamDrivePermissionDetailsarrayOptionalOutput only. Deprecated: Output only. Use `permissionDetails` instead.
Read only: true
teamDrivePermissionDetails[]ModelEach itemExpand Gets a permission by ID For more information, see Share files, folders, and drives (https: developers google com workspace drive api guides manage-sharing) — response body — team Drive Permission Details item
typestringRequired within parentThe type of the grantee. Supported values include: * `user` * `group` * `domain` * `anyone` When creating a permission, if `type` is `user` or `group`, you must provide an `emailAddress` for the user or group. If `type` is `domain`, you must provide a `domain`. If `type` is `anyone`, no extra information is required.
viewstringOptionalIndicates the view for this permission. Only populated for permissions that belong to a view. The only supported values are `published` and `metadata`: * `published`: The permission’s role is `publishedReader`. * `metadata`: The item is only visible to the `metadata` view because the item has limited access and the scope has at least read access to the parent. The `metadata` view is only supported on folders. For more information, see [Views](https://developers.google.com/workspace/drive/api/guides/ref-roles#views).

Referenced models: Gets a permission by ID For more information, see Share files, folders, and drives (https: developers google com workspace drive api guides manage-sharing) — response body — permission Details item, Gets a permission by ID For more information, see Share files, folders, and drives (https: developers google com workspace drive api guides manage-sharing) — response body — team Drive Permission Details item

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.