Creates a permission for a file or shared drive.
Deletes a permission.
Gets a permission by ID.
Lists a file's or shared drive's permissions.
list_next(previous_request, previous_response)
Retrieves the next page of results.
Updates a permission with patch semantics.
create(fileId, body, sendNotificationEmail=None, supportsTeamDrives=None, supportsAllDrives=None, transferOwnership=None, emailMessage=None, useDomainAdminAccess=None)
Creates a permission for a file or shared drive.
Args:
fileId: string, The ID of the file or shared drive. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
"role": "A String", # Deprecated - use permissionDetails/role instead.
"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
},
],
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"permissionDetails": [ # 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.
{
"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
},
],
"expirationTime": "A String", # 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
"role": "A String", # 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
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
}
sendNotificationEmail: boolean, 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.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
transferOwnership: boolean, 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.
emailMessage: string, A plain text custom message to include in the notification email.
useDomainAdminAccess: boolean, 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.
Returns:
An object of the form:
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
"role": "A String", # Deprecated - use permissionDetails/role instead.
"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
},
],
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"permissionDetails": [ # 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.
{
"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
},
],
"expirationTime": "A String", # 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
"role": "A String", # 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
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
}
delete(fileId, permissionId, supportsTeamDrives=None, supportsAllDrives=None, useDomainAdminAccess=None)
Deletes a permission. Args: fileId: string, The ID of the file or shared drive. (required) permissionId: string, The ID of the permission. (required) supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead. supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives. useDomainAdminAccess: boolean, 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.
get(fileId, permissionId, supportsTeamDrives=None, supportsAllDrives=None, useDomainAdminAccess=None)
Gets a permission by ID.
Args:
fileId: string, The ID of the file. (required)
permissionId: string, The ID of the permission. (required)
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
useDomainAdminAccess: boolean, 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.
Returns:
An object of the form:
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
"role": "A String", # Deprecated - use permissionDetails/role instead.
"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
},
],
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"permissionDetails": [ # 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.
{
"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
},
],
"expirationTime": "A String", # 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
"role": "A String", # 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
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
}
list(fileId, pageSize=None, pageToken=None, supportsTeamDrives=None, supportsAllDrives=None, useDomainAdminAccess=None)
Lists a file's or shared drive's permissions.
Args:
fileId: string, The ID of the file or shared drive. (required)
pageSize: integer, The maximum number of permissions to return per page. When not set for files in a shared drive, at most 100 results will be returned. When not set for files that are not in a shared drive, the entire list will be returned.
pageToken: string, The token for continuing a previous list request on the next page. This should be set to the value of 'nextPageToken' from the previous response.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
useDomainAdminAccess: boolean, 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.
Returns:
An object of the form:
{ # A list of permissions for a file.
"nextPageToken": "A String", # 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.
"kind": "drive#permissionList", # Identifies what kind of resource this is. Value: the fixed string "drive#permissionList".
"permissions": [ # The list of permissions. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
"role": "A String", # Deprecated - use permissionDetails/role instead.
"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
},
],
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"permissionDetails": [ # 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.
{
"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
},
],
"expirationTime": "A String", # 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
"role": "A String", # 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
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
},
],
}
list_next(previous_request, previous_response)
Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
update(fileId, permissionId, body, removeExpiration=None, supportsTeamDrives=None, supportsAllDrives=None, useDomainAdminAccess=None, transferOwnership=None)
Updates a permission with patch semantics.
Args:
fileId: string, The ID of the file or shared drive. (required)
permissionId: string, The ID of the permission. (required)
body: object, The request body. (required)
The object takes the form of:
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
"role": "A String", # Deprecated - use permissionDetails/role instead.
"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
},
],
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"permissionDetails": [ # 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.
{
"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
},
],
"expirationTime": "A String", # 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
"role": "A String", # 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
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
}
removeExpiration: boolean, Whether to remove the expiration date.
supportsTeamDrives: boolean, Deprecated use supportsAllDrives instead.
supportsAllDrives: boolean, Deprecated - Whether the requesting application supports both My Drives and shared drives. This parameter will only be effective until June 1, 2020. Afterwards all applications are assumed to support shared drives.
useDomainAdminAccess: boolean, 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.
transferOwnership: boolean, 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.
Returns:
An object of the form:
{ # A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.
"domain": "A String", # The domain to which this permission refers.
"displayName": "A String", # A displayable name for users, groups or domains.
"teamDrivePermissionDetails": [ # Deprecated - use permissionDetails instead.
{
"inheritedFrom": "A String", # Deprecated - use permissionDetails/inheritedFrom instead.
"role": "A String", # Deprecated - use permissionDetails/role instead.
"teamDrivePermissionType": "A String", # Deprecated - use permissionDetails/permissionType instead.
"inherited": True or False, # Deprecated - use permissionDetails/inherited instead.
},
],
"allowFileDiscovery": True or False, # Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone.
"deleted": True or False, # Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions.
"kind": "drive#permission", # Identifies what kind of resource this is. Value: the fixed string "drive#permission".
"emailAddress": "A String", # The email address of the user or group to which this permission refers.
"photoLink": "A String", # A link to the user's profile photo, if available.
"permissionDetails": [ # 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.
{
"role": "A String", # The primary role for this user. While new values may be added in the future, the following are currently possible:
# - organizer
# - fileOrganizer
# - writer
# - commenter
# - reader
"inheritedFrom": "A String", # The ID of the item from which this permission is inherited. This is an output-only field and is only populated for members of the shared drive.
"permissionType": "A String", # The permission type for this user. While new values may be added in future, the following are currently possible:
# - file
# - member
"inherited": True or False, # Whether this permission is inherited. This field is always populated. This is an output-only field.
},
],
"expirationTime": "A String", # 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
"role": "A String", # 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
"type": "A String", # The type of the grantee. Valid values are:
# - user
# - group
# - domain
# - anyone
"id": "A String", # The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId.
}