Chaque fichier, dossier et Drive partagé Google Drive est associé à des ressources
permissions. Chaque ressource
identifie l'autorisation pour un
type (user,
group, domain, anyone) et un
role (owner,
organizer, fileOrganizer, writer, commenter, reader). Par exemple, un
fichier peut disposer d'une autorisation accordant à un utilisateur spécifique (type=user) un accès en lecture seule (role=reader), tandis qu'une autre autorisation permet aux membres d'un groupe spécifique (type=group) d'ajouter des commentaires à un fichier (role=commenter).
Pour obtenir la liste complète des rôles et des opérations autorisées par chacun d'eux, consultez Rôles et autorisations.
Fonctionnement des autorisations
Les listes d'autorisations d'un dossier se propagent vers le bas. Tous les fichiers et dossiers enfants héritent des autorisations du parent. Chaque fois que les autorisations ou la hiérarchie sont modifiées, la propagation se produit de manière récursive dans tous les dossiers imbriqués. Par exemple, si un fichier existe dans un dossier et que ce dossier est ensuite déplacé dans un autre dossier, les autorisations du nouveau dossier sont propagées au fichier. Si le nouveau dossier accorde à l'utilisateur du fichier un nouveau rôle, tel que "writer", il remplace son ancien rôle.
À l'inverse, si un fichier hérite de role=writer d'un dossier et qu'il est déplacé vers un autre dossier qui fournit un rôle "reader", le fichier hérite désormais de role=reader.
Les autorisations héritées ne peuvent pas être supprimées ni réduites sur un élément. Au lieu de cela, ces autorisations doivent être ajustées sur le parent d'où elles proviennent, ou un dossier de la hiérarchie doit activer le paramètre d'accès limité.
Les autorisations héritées peuvent être augmentées sur un élément. Si une autorisation est augmentée sur un enfant, la modification de l'autorisation d'un parent n'affecte pas l'autorisation de l'enfant, sauf si la nouvelle autorisation parentale est supérieure à celle de l'enfant.
Les opérations d'autorisation simultanées sur le même fichier ne sont pas prises en charge. Seule la dernière mise à jour est appliquée.
Comprendre les fonctionnalités des fichiers
La ressource permissions ne détermine pas en définitive
la capacité de l'utilisateur actuel à effectuer des actions sur un fichier ou un dossier.
Au lieu de cela, la files ressource contient une collection
de champs booléens capabilities
utilisés pour indiquer si une action peut être effectuée sur un fichier ou un dossier.
L'API Google Drive définit ces champs en fonction de la ressource permissions de l'utilisateur actuel associée au fichier ou au dossier.
Par exemple, lorsqu'Alex se connecte à votre application et tente de partager un fichier, son rôle est vérifié pour les autorisations sur le fichier. Si le rôle lui permet de partager un fichier, les capabilities associées au fichier, telles que canShare, sont définies par rapport au rôle. Si Alex souhaite partager le fichier, votre application vérifie les capabilities pour s'assurer que canShare est défini sur true.
Obtenir les fonctionnalités des fichiers
Lorsque votre application ouvre un fichier, elle doit vérifier ses fonctionnalités et afficher l'interface utilisateur pour refléter les autorisations de l'utilisateur actuel. Par exemple, si l'utilisateur ne dispose pas de la fonctionnalité canComment sur le fichier, la possibilité de commenter doit être désactivée dans l'interface utilisateur.
Pour vérifier les fonctionnalités, appelez la get
méthode sur la ressource files avec le paramètre de chemin d'accès fileId
et le paramètre fields défini sur le champ capabilities. Pour
en savoir plus sur le renvoi de champs à l'aide du paramètre fields, consultez la section
Renvoyer des champs spécifiques.
L'exemple de code suivant montre comment vérifier les autorisations de l'utilisateur. La réponse renvoie une liste des fonctionnalités dont l'utilisateur dispose sur le fichier. Chaque fonctionnalité correspond à une action précise qu'un utilisateur peut effectuer. Certains champs ne sont renseignés que pour les éléments des Drive partagés.
Demande
GET https://www.googleapis.com/drive/v3/files/FILE_ID?fields=capabilitiesRéponse
{ "capabilities": { "canAcceptOwnership": false, "canAddChildren": false, "canAddMyDriveParent": false, "canChangeCopyRequiresWriterPermission": true, "canChangeItemDownloadRestriction": true, "canChangeSecurityUpdateEnabled": false, "canChangeViewersCanCopyContent": true, "canComment": true, "canCopy": true, "canDelete": true, "canDisableInheritedPermissions": false, "canDownload": true, "canEdit": true, "canEnableInheritedPermissions": true, "canListChildren": false, "canModifyContent": true, "canModifyContentRestriction": true, "canModifyEditorContentRestriction": true, "canModifyOwnerContentRestriction": true, "canModifyLabels": true, "canMoveChildrenWithinDrive": false, "canMoveItemIntoTeamDrive": true, "canMoveItemOutOfDrive": true, "canMoveItemWithinDrive": true, "canReadLabels": true, "canReadRevisions": true, "canRemoveChildren": false, "canRemoveContentRestriction": false, "canRemoveMyDriveParent": true, "canRename": true, "canShare": true, "canTrash": true, "canUntrash": true } }
Scénarios de partage des ressources Drive
Il existe cinq types de scénarios de partage différents :
Pour partager un fichier dans Mon Drive, l'utilisateur doit disposer de
role=writerourole=owner.Si la
writersCanSharevaleur booléenne est définie surfalsepour le fichier, l'utilisateur doit disposer derole=owner.Si l'utilisateur disposant de
role=writerbénéficie d'un accès temporaire régi par une date et une heure d'expiration, il ne peut pas partager le fichier. Pour en savoir plus, consultez Définir une date d'expiration pour limiter l'accès à un élément.
Pour partager un dossier dans Mon Drive, l'utilisateur doit disposer de
role=writerourole=owner.Si la valeur booléenne
writersCanShareest définie surfalsepour le fichier, l'utilisateur doit disposer derole=owner, qui est plus permissif.L'accès temporaire (réglementé par une date et une heure d'expiration) n'est autorisé que sur les dossiers avec
role=reader. Pour en savoir plus, consultez consultez Définir une date d'expiration pour limiter l'accès à un élément.
Pour partager un fichier dans un Drive partagé, l'utilisateur doit disposer de
role=writer,role=fileOrganizerourole=organizer.- Le paramètre
writersCanSharene s'applique pas aux éléments des Drive partagés. Il est traité comme s'il était toujours défini surtrue.
- Le paramètre
Pour partager un dossier dans un Drive partagé, l'utilisateur doit disposer de
role=organizer.- Si la
sharingFoldersRequiresOrganizerPermissionrestriction sur un Drive partagé est définie surfalse, les utilisateurs disposant derole=fileOrganizerpeuvent partager des dossiers dans ce Drive partagé.
- Si la
Pour gérer l'appartenance à un Drive partagé, l'utilisateur doit disposer de
role=organizer. Seuls les utilisateurs et les groupes peuvent être membres de Drive partagés.
Utiliser le paramètre fields
Si vous souhaitez spécifier les champs à renvoyer dans la réponse, vous pouvez définir le
fields paramètre
système
avec n'importe quelle méthode de la ressource permissions. Si vous omettez le paramètre fields, le serveur renvoie un ensemble de champs par défaut spécifique à la méthode.
Par exemple, la list méthode renvoie
uniquement les champs id, type, kind, et role pour chaque fichier. Pour renvoyer
d'autres champs, consultez la section Renvoyer des champs spécifiques.
Créer une autorisation
Les deux champs suivants sont nécessaires lors de la création d'une autorisation :
type: letypeidentifie le champ d'application de l'autorisation (user,group,domain, ouanyone). Une autorisation avectype=users'applique à un utilisateur spécifique, tandis qu'une autorisation avectype=domains'applique à tous les membres d'un domaine spécifique.role: le champroleidentifie les opérations que letypepeut effectuer. Par exemple, une autorisation avectype=useretrole=readeraccorde à un utilisateur spécifique un accès en lecture seule au fichier ou au dossier. Une autorisation avectype=domainetrole=commenterpermet à tous les membres du domaine d'ajouter des commentaires à un fichier. Pour obtenir la liste complète des rôles et des opérations autorisées par chacun d'eux, consultez Rôles et autorisations.
Lorsque vous créez une autorisation où type=user ou type=group, vous devez également
fournir un
emailAddress
pour associer l'utilisateur ou le groupe spécifique à l'autorisation.
Lorsque vous créez une autorisation où type=domain, vous devez également fournir un
domain pour associer un
domaine spécifique à l'autorisation.
Pour créer une autorisation :
- Utilisez la méthode
createsur la ressourcepermissionsavec le paramètre de chemin d'accèsfileIdpour le fichier ou le dossier associé. - Dans le corps de la requête, spécifiez le
typeet lerole. - Si
type=useroutype=group, fournissez uneemailAddress. Sitype=domain, fournissez undomain.
L'exemple de code suivant montre comment créer une autorisation. La réponse renvoie une instance d'une ressource permissions, y compris le permissionId attribué.
Demande
POST https://www.googleapis.com/drive/v3/files/FILE_ID/permissions{ "requests": [ { "type": "user", "role": "commenter", "emailAddress": "alex@altostrat.com" } ] }
Réponse
{
"kind": "drive#permission",
"id": "PERMISSION_ID",
"type": "user",
"role": "commenter"
}Utiliser des audiences cibles
Les audiences cibles sont des groupes de personnes (tels que des services ou des équipes) que vous pouvez recommander aux utilisateurs pour partager leurs éléments. Vous pouvez encourager les utilisateurs à partager des éléments avec une audience plus spécifique ou limitée plutôt qu'avec l'ensemble de votre organisation. Les audiences cibles peuvent vous aider à améliorer la sécurité et la confidentialité de vos données, et à faciliter le partage approprié par les utilisateurs. Pour en savoir plus, consultez À propos des audiences cibles.
Pour utiliser des audiences cibles :
Dans la console d'administration Google, accédez à Menu > Annuaire > Audiences cibles.
Pour effectuer cette tâche, vous devez être connecté à un compte disposant de droits de super-administrateur.
Dans la liste des audiences cibles, cliquez sur le nom de l'audience cible. Pour créer une audience cible, consultez Créer une audience cible
Copiez l'ID unique à partir de l'URL de l'audience cible :
https://admin.google.com/ac/targetaudiences/ID.Créez une autorisation avec
type=domain, puis définissez le champdomainsurID.audience.googledomains.com.
Pour voir comment les utilisateurs interagissent avec les audiences cibles, consultez Expérience utilisateur pour le partage de liens.
Obtenir une autorisation
Pour obtenir une autorisation, utilisez la get méthode
sur la ressource permissions avec les
fileId et permissionId paramètres de chemin d'accès. Si vous ne connaissez pas l'ID d'autorisation, vous pouvez lister toutes les autorisations à l'aide de la méthode list.
L'exemple de code suivant montre comment obtenir une autorisation par ID. La réponse renvoie une instance d'une ressource permissions.
Demande
GET https://www.googleapis.com/drive/v3/files/FILE_ID/permissionsPERMISSION_ID
Réponse
{
"kind": "drive#permissionList",
"permissions": [
{
"kind": "drive#permission",
"id": "PERMISSION_ID",
"type": "user",
"role": "commenter"
}
]
}Lister toutes les autorisations
Pour lister les autorisations d'un fichier, d'un dossier ou d'un Drive partagé, utilisez la list méthode sur la permissions ressource avec le fileId paramètre de chemin d'accès.
pageSize: nombre maximal d'autorisations à renvoyer par page. S'il n'est pas défini pour les fichiers d'un Drive partagé, 100 résultats au maximum sont renvoyés. S'il n'est pas défini pour les fichiers qui ne se trouvent pas dans un Drive partagé, la liste entière est renvoyée.pageToken: jeton de page reçu d'un appel de liste précédent. Fournissez ce jeton pour récupérer la page suivante.supportsAllDrives: indique si l'application demandant prend en charge à la fois Mon Drive et les Drive partagés.useDomainAdminAccess: définissez la valeur surtruepour émettre la requête en tant qu'administrateur de domaine. Si le paramètrefileIdfait référence à un Drive partagé et que le demandeur est un administrateur du domaine auquel appartient le Drive partagé. Pour en savoir plus, consultez Gérer les Drive partagés en tant qu'administrateur de domaine s.includePermissionsForView: autorisations de vue supplémentaires à inclure dans la réponse. Seule la valeurpublishedest acceptée.
L'exemple de code suivant montre comment obtenir toutes les autorisations. La réponse renvoie une liste des autorisations pour un fichier, un dossier ou un Drive partagé.
Demande
GET https://www.googleapis.com/drive/v3/files/FILE_ID/permissionsRéponse
{
"kind": "drive#permissionList",
"permissions": [
{
"id": "PERMISSION_ID",
"type": "user",
"kind": "drive#permission",
"role": "commenter"
}
]
}Modifier les autorisations
Pour modifier les autorisations sur un fichier ou un dossier, vous pouvez modifier le rôle attribué. Pour en savoir plus sur la recherche de la source du rôle, consultez Déterminer la source du rôle.
Appelez la méthode
updatesur la ressourcepermissionsavec le paramètre de chemin d'accèsfileIddéfini sur le fichier, le dossier ou le Drive partagé associé, et le paramètre de chemin d'accèspermissionIddéfini sur l'autorisation à modifier. Pour trouver lepermissionId, utilisez lalistméthode sur la ressourcepermissionsavec le paramètre de chemin d'accèsfileId.Dans la requête, identifiez le nouveau
role.
Vous pouvez accorder des autorisations sur des fichiers ou des dossiers individuels dans un Drive partagé, même si l'utilisateur ou le groupe est déjà membre. Par exemple, Alex dispose de role=commenter dans le cadre de son appartenance à un Drive partagé. Toutefois, votre application peut accorder à Alex role=writer pour un fichier dans un Drive partagé. Dans ce cas, comme le nouveau rôle est plus permissif que le rôle accordé par son appartenance, la nouvelle autorisation devient le rôle effectif pour le fichier ou le dossier.
Vous pouvez appliquer des mises à jour via la sémantique de patch, ce qui signifie que vous pouvez apporter des modifications partielles à une ressource. Vous devez définir explicitement les champs que vous souhaitez modifier dans votre requête. Tous les champs non inclus dans la requête conservent leurs valeurs existantes. Pour en savoir plus, consultez Utiliser des ressources partielles.
L'exemple de code suivant montre comment modifier les autorisations sur un fichier ou un dossier de commenter à writer. La réponse renvoie une instance d'une ressource permissions.
Demande
PATCH https://www.googleapis.com/drive/v3/files/FILE_ID/permissions/PERMISSION_ID
{
"role": "writer"
}Réponse
{
"kind": "drive#permission",
"id": "PERMISSION_ID",
"type": "user",
"role": "writer"
}Déterminer la source du rôle
Pour modifier le rôle sur un fichier ou un dossier, vous devez connaître la source du rôle. Pour les Drive partagés, la source d'un rôle peut être basée sur l'appartenance au Drive partagé, le rôle sur un dossier ou le rôle sur un fichier.
Pour déterminer la source du rôle d'un Drive partagé ou des éléments qu'il contient,
appelez la méthode get sur la ressource
permissions avec les paramètres de chemin d'accès fileId et
permissionId, et le paramètre fields défini sur le champ
permissionDetails.
Pour trouver le permissionId, utilisez la
list méthode sur la permissions
ressource avec le fileId paramètre de chemin d'accès. Pour récupérer le permissionDetails
champ dans la list requête, définissez le fields paramètre sur
permissions/permissionDetails.
Ce champ énumère toutes les autorisations de fichier héritées et directes pour l'utilisateur, le groupe ou le domaine.
L'exemple de code suivant montre comment déterminer la source du rôle. La réponse renvoie les permissionDetails d'une ressource permissions. Le champ inheritedFrom fournit l'ID de l'élément à partir duquel l'autorisation est héritée.
Demande
GET https://www.googleapis.com/drive/v3/files/FILE_ID/permissions/PERMISSION_ID?fields=permissionDetails&supportsAllDrives=true
Réponse
{
"permissionDetails": [
{
"permissionType": "member",
"role": "commenter",
"inheritedFrom": "INHERITED_FROM_ID",
"inherited": true
},
{
"permissionType": "file",
"role": "writer",
"inherited": false
}
]
}Modifier plusieurs autorisations avec des requêtes par lot
Nous vous recommandons vivement d'utiliser des requêtes par lot pour modifier plusieurs autorisations.
Voici un exemple d'exécution d'une modification d'autorisation par lot avec une bibliothèque cliente.
Java
Python
Node.js
PHP
.NET
Supprimer une autorisation
Pour révoquer l'accès à un fichier ou à un dossier, appelez la
delete méthode sur la
permissions ressource avec les fileId et
les permissionId paramètres de chemin d'accès définis pour supprimer l'autorisation.
Les autorisations héritées ne peuvent pas être révoquées. Modifiez ou supprimez plutôt l'autorisation sur le dossier parent. La suppression d'une autorisation sur un dossier révoque également tout accès équivalent sur les éléments enfants.
La réduction des autorisations par rapport à un parent nécessite l'utilisation du paramètre d'accès limité.
L'exemple de code suivant montre comment révoquer l'accès en supprimant un permissionId. Si la requête aboutit, le corps de la réponse est un objet JSON vide. Pour confirmer que l'autorisation est supprimée, utilisez la list méthode sur la ressource permissions avec le paramètre de chemin d'accès fileId.
Demande
DELETE https://www.googleapis.com/drive/v3/files/FILE_ID/permissions/PERMISSION_ID
Définir une date d'expiration pour limiter l'accès à un élément
Lorsque vous travaillez avec des personnes sur un projet sensible, vous pouvez limiter leur accès à certains éléments de Drive après un certain temps. Pour les fichiers et les dossiers, vous pouvez définir une date d'expiration afin de limiter ou de supprimer l'accès à cet élément.
Pour définir la date d'expiration :
Utilisez la méthode
createsur la ressourcepermissionset définissez le champexpirationTime(ainsi que les autres champs obligatoires). Pour en savoir plus, consultez Créer une autorisation.Utilisez la méthode
updatesur la ressourcepermissionset définissez le champexpirationTime(ainsi que les autres champs obligatoires). Pour en savoir plus, consultez Modifier les autorisations.
Le champ
expirationTime
indique la date d'expiration de l'autorisation au format RFC 3339
date-heure. Les délais d'expiration sont soumis aux restrictions suivantes :
- Ils ne peuvent être définis que sur les autorisations d'utilisateur et de groupe.
- L'heure doit être future.
- L'heure ne peut pas être supérieure à un an.
- Seul le rôle
readerpeut expirer l'accès à un dossier.
Pour en savoir plus sur la date d'expiration, consultez les articles suivants :
Articles associés
- Gérer les propositions d'accès en attente
- Gérer les dossiers avec un accès limité et étendu
- Transférer la propriété d'un fichier
- Protéger le contenu des fichiers
- Accéder aux fichiers Drive partagés par lien à l'aide de clés de ressource
- Rôles et autorisations