Google: Drive permissions schemas
5 Google schemas with complete fields and constraints.
← Drive permissions operations · All schemas
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A 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. |
allowFileDiscovery | boolean | Optional | Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`. |
deleted | boolean | Optional | Output only. Whether the account associated with this permission has been deleted. This field only pertains to permissions of type `user` or `group`. |
displayName | string | Optional | 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 "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. |
domain | string | Optional | Output only. The domain to which this permission refers. Read only: true |
emailAddress | string | Optional | Output only. The email address of the user or group to which this permission refers. Read only: true |
expirationTime | string | Optional | 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 Format: date-time |
id | string | Optional | Output 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. |
inheritedPermissionsDisabled | boolean | Optional | When `true`, only organizers, owners, and users with permissions added directly on the item can access it. |
kind | string | Optional | Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. Default: drive#permission |
pendingOwner | boolean | Optional | Whether 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. |
permissionDetails | array | Optional | Output only. Details of whether the permissions on this item are inherited or are directly on this item. Read only: true |
permissionDetails[] | Model | Each item | Expand 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 |
photoLink | string | Optional | Output only. A link to the user's profile photo, if available. |
role | string | Required within parent | The 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). |
teamDrivePermissionDetails | array | Optional | Output only. Deprecated: Output only. Use `permissionDetails` instead. Read only: true |
teamDrivePermissionDetails[] | Model | Each item | Expand 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 |
type | string | Required within parent | The 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. |
view | string | Optional | Indicates 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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A 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. |
allowFileDiscovery | boolean | Optional | Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type `domain` or `anyone`. |
deleted | boolean | Optional | Output only. Whether the account associated with this permission has been deleted. This field only pertains to permissions of type `user` or `group`. |
displayName | string | Optional | 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 "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. |
domain | string | Optional | Output only. The domain to which this permission refers. Read only: true |
emailAddress | string | Optional | Output only. The email address of the user or group to which this permission refers. Read only: true |
expirationTime | string | Optional | 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 Format: date-time |
id | string | Optional | Output 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. |
inheritedPermissionsDisabled | boolean | Optional | When `true`, only organizers, owners, and users with permissions added directly on the item can access it. |
kind | string | Optional | Output only. Identifies what kind of resource this is. Value: the fixed string `"drive#permission"`. Default: drive#permission |
pendingOwner | boolean | Optional | Whether 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. |
permissionDetails | array | Optional | Output only. Details of whether the permissions on this item are inherited or are directly on this item. Read only: true |
permissionDetails[] | Model | Each item | Expand 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 |
photoLink | string | Optional | Output only. A link to the user's profile photo, if available. |
role | string | Optional | The 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). |
teamDrivePermissionDetails | array | Optional | Output only. Deprecated: Output only. Use `permissionDetails` instead. Read only: true |
teamDrivePermissionDetails[] | Model | Each item | Expand 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 |
type | string | Optional | The 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. |
view | string | Optional | Indicates 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
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
inherited | boolean | Optional | Output only. Whether this permission is inherited. This field is always populated. This is an output-only field. |
inheritedFrom | string | Optional | Output only. The ID of the item from which this permission is inherited. This is only populated for items in shared drives. Read only: true |
permissionType | string | Optional | Output only. The permission type for this user. Supported values include: * `file` * `member` |
role | string | Optional | Output only. The primary role for this user. 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). |
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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
inherited | boolean | Optional | Deprecated: Output only. Use `permissionDetails/inherited` instead. |
inheritedFrom | string | Optional | Deprecated: Output only. Use `permissionDetails/inheritedFrom` instead. |
role | string | Optional | Deprecated: Output only. Use `permissionDetails/role` instead. |
teamDrivePermissionType | string | Optional | Deprecated: Output only. Use `permissionDetails/permissionType` instead. |
Lists a file's or shared drive's permissions For more information, see Share files, folders, and drives (https: developers google com workspace drive api guides manage-sharing) — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of permissions for a file. |
kind | string | Optional | Identifies what kind of resource this is. Value: the fixed string `"drive#permissionList"`. Default: drive#permissionList |
nextPageToken | string | Optional | The page token for the next page of permissions. This field will be absent if the end of the permissions list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ. |
permissions | array | Optional | The list of permissions. If `nextPageToken` is populated, then this list may be incomplete and an additional page of results should be fetched. |
permissions[] | Model | Each item | Expand 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 |
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