REST Resource: permissions

Ressource : Permission

Autorisation pour un fichier. Une autorisation accorde à un utilisateur, un groupe, un domaine ou à tous les utilisateurs l'accès à un fichier ou à une hiérarchie de dossiers. Pour en savoir plus, consultez Partager des fichiers, des dossiers et des Drive.

Par défaut, les demandes d'autorisation ne renvoient qu'un sous-ensemble de champs. Les autorisations kind, ID, type et role sont toujours renvoyées. Pour récupérer des champs spécifiques, consultez Renvoyer des champs spécifiques.

Certaines méthodes de ressources (comme permissions.update) nécessitent un permissionId. Utilisez la méthode permissions.list pour récupérer l'ID d'un fichier, d'un dossier ou d'un Drive partagé.

Représentation JSON 
{
  "permissionDetails": [
    {
      "permissionType": string,
      "inheritedFrom": string,
      "role": string,
      "inherited": boolean
    }
  ],
  "teamDrivePermissionDetails": [
    {
      "teamDrivePermissionType": string,
      "inheritedFrom": string,
      "role": string,
      "inherited": boolean
    }
  ],
  "id": string,
  "displayName": string,
  "type": string,
  "kind": string,
  "photoLink": string,
  "emailAddress": string,
  "role": string,
  "allowFileDiscovery": boolean,
  "domain": string,
  "expirationTime": string,
  "deleted": boolean,
  "view": string,
  "pendingOwner": boolean,
  "inheritedPermissionsDisabled": boolean
}
Champs
permissionDetails[]

object

Uniquement en sortie. Indique si les autorisations de cet élément sont héritées ou directement appliquées à cet élément.
permissionDetails[].permissionType

string

Uniquement en sortie. Type d'autorisation de cet utilisateur. Les valeurs autorisées incluent les suivantes :

  • file
  • member
permissionDetails[].inheritedFrom

string

Uniquement en sortie. ID de l'élément à partir duquel cette autorisation est héritée. Cette valeur n'est renseignée que pour les éléments des Drive partagés.
permissionDetails[].role

string

Uniquement en sortie. Rôle principal de cet utilisateur. Les valeurs autorisées incluent les suivantes :

  • owner
  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader

Pour en savoir plus, consultez Rôles et autorisations.
permissionDetails[].inherited

boolean

Uniquement en sortie. Indique si cette autorisation est héritée. Ce champ est toujours renseigné. Il s'agit d'un champ en sortie seulement.
teamDrivePermissionDetails[]
(deprecated)

object

Uniquement en sortie. Obsolète : sortie uniquement. Utilisez permissionDetails à la place.
teamDrivePermissionDetails[]
(deprecated).teamDrivePermissionType
(deprecated)

string

Obsolète : sortie uniquement. Utilisez permissionDetails/permissionType à la place.
teamDrivePermissionDetails[]
(deprecated).inheritedFrom
(deprecated)

string

Obsolète : sortie uniquement. Utilisez permissionDetails/inheritedFrom à la place.
teamDrivePermissionDetails[]
(deprecated).role
(deprecated)

string

Obsolète : sortie uniquement. Utilisez permissionDetails/role à la place.
teamDrivePermissionDetails[]
(deprecated).inherited
(deprecated)

boolean

Obsolète : sortie uniquement. Utilisez permissionDetails/inherited à la place.
id

string

Uniquement en sortie. ID de cette autorisation. Il s'agit de l'identifiant unique du bénéficiaire, qui est publié dans la ressource User sous la forme permissionId. Les ID doivent être traités comme des valeurs opaques.
displayName

string

Uniquement en sortie. Nom convivial de la valeur de l'autorisation. Voici une liste d'exemples pour chaque type d'autorisation :

  • user : nom complet de l'utilisateur, tel que défini pour son compte Google (par exemple, "Dana A.")
  • group : nom du groupe Google, par exemple "Administrateurs de l'entreprise".
  • domain : nom de domaine sous forme de chaîne (par exemple, "cymbalgroup.com")
  • anyone : aucun displayName n'est présent.
type

string

Type du bénéficiaire. Les valeurs autorisées incluent les suivantes :

  • user
  • group
  • domain
  • anyone

Lorsque vous créez une autorisation, si type est défini sur user ou group, vous devez fournir un emailAddress pour l'utilisateur ou le groupe. Si type est défini sur domain, vous devez fournir un domain. Si type est défini sur anyone, aucune information supplémentaire n'est requise.
kind

string

Uniquement en sortie. Identifie le type de ressource. Valeur : chaîne fixe "drive#permission".
emailAddress

string

Adresse e-mail de l'utilisateur ou du groupe auquel cette autorisation fait référence.
role

string

Rôle accordé par cette autorisation. Les valeurs autorisées incluent les suivantes :

  • owner
  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader

Pour en savoir plus, consultez Rôles et autorisations.
allowFileDiscovery

boolean

Indique si l'autorisation permet de trouver le fichier via la recherche. Cela ne s'applique qu'aux autorisations de type domain ou anyone.
domain

string

Domaine auquel cette autorisation fait référence.
expirationTime

string

Heure d'expiration de cette autorisation (date et heure RFC 3339). Les délais d'expiration sont soumis aux restrictions suivantes :

  • Ils ne peuvent être définis que pour les autorisations des utilisateurs et des groupes.
  • L'heure doit être située dans le futur.
  • La date ne peut pas être postérieure de plus d'un an à la date du jour.
deleted

boolean

Uniquement en sortie. Indique si le compte associé à cette autorisation a été supprimé. Ce champ ne concerne que les autorisations de type user ou group.
view

string

Indique la vue pour cette autorisation. Renseigné uniquement pour les autorisations appartenant à une vue.

Les seules valeurs acceptées sont published et metadata :

  • published : le rôle de l'autorisation est publishedReader.
  • metadata : l'élément n'est visible que dans la vue metadata, car il est en accès limité et le champ d'application dispose au moins d'un accès en lecture au parent. La vue metadata n'est disponible que pour les dossiers.

Pour en savoir plus, consultez Vues.
pendingOwner

boolean

Indique si le compte associé à cette autorisation est un propriétaire en attente. N'est renseigné que pour les autorisations de type user pour les fichiers qui ne se trouvent pas dans un Drive partagé.
inheritedPermissionsDisabled

boolean

Lorsque l'option true est sélectionnée, seuls les organisateurs, les propriétaires et les utilisateurs disposant d'autorisations ajoutées directement à l'élément peuvent y accéder.

Méthodes

create

 Crée une autorisation pour un fichier ou un Drive partagé.

delete

 Supprime une autorisation.

get

 Obtient une autorisation par ID.

list

 Liste les autorisations d'un fichier ou d'un Drive partagé.

update

 Met à jour une autorisation avec la sémantique "patch".