REST Resource: permissions

Ressource: Autorisation

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.

Par défaut, les requêtes d'autorisation ne renvoient qu'un sous-ensemble de champs. Le type d'autorisation, l'ID, le type et le rôle sont toujours renvoyés. Pour récupérer des champs spécifiques, consultez la page https://developers.google.com/drive/api/guides/fields-parameter.

Certaines méthodes de ressources (telles que 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 
{
  "id": string,
  "displayName": string,
  "type": string,
  "kind": string,
  "permissionDetails": [
    {
      "permissionType": string,
      "inheritedFrom": string,
      "role": string,
      "inherited": boolean
    }
  ],
  "photoLink": string,
  "emailAddress": string,
  "role": string,
  "allowFileDiscovery": boolean,
  "domain": string,
  "expirationTime": string,
  "teamDrivePermissionDetails": [
    {
      "teamDrivePermissionType": string,
      "inheritedFrom": string,
      "role": string,
      "inherited": boolean
    }
  ],
  "deleted": boolean,
  "view": string,
  "pendingOwner": boolean
}
Champs
id

string

Uniquement en sortie. ID de cette autorisation. Il s'agit de l'identifiant unique du bénéficiaire, publié dans les ressources utilisateur 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, "Joe Smith")
  • group : nom du groupe Google, par exemple "Administrateurs de l'entreprise".
  • domain : nom de domaine sous forme de chaîne (par exemple, "thecompany.com")
  • anyone : aucun displayName n'est présent.
type

string

Type du bénéficiaire. Les valeurs valides sont les suivantes :

  • user
  • group
  • domain
  • anyone

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

string

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

object

Uniquement en sortie. Indique si les autorisations de cet élément de Drive partagé sont héritées ou directement appliquées à cet élément. Il s'agit d'un champ de sortie uniquement, qui n'est présent que pour les éléments Drive partagés.
permissionDetails[].permissionType

string

Uniquement en sortie. Type d'autorisation de cet utilisateur. De nouvelles valeurs pourront être ajoutées à l'avenir, mais voici les valeurs actuellement disponibles:

  • file
  • member
permissionDetails[].inheritedFrom

string

Uniquement en sortie. ID de l'élément à partir duquel cette autorisation est héritée. Ce champ est en sortie seulement.
permissionDetails[].role

string

Uniquement en sortie. Rôle principal de cet utilisateur. De nouvelles valeurs pourront être ajoutées à l'avenir, mais voici les valeurs actuellement disponibles:

  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader
permissionDetails[].inherited

boolean

Uniquement en sortie. Indique si cette autorisation est héritée. Ce champ est toujours renseigné. Ce champ est en sortie seulement.
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. Bien que de nouvelles valeurs puissent être acceptées à l'avenir, les valeurs suivantes sont actuellement autorisées:

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

boolean

Indique si l'autorisation permet de découvrir 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 à laquelle cette autorisation expirera (date-heure au format RFC 3339). Les délais d'expiration sont soumis aux restrictions suivantes:

  • Elles ne peuvent être définies que sur les autorisations des utilisateurs et des groupes.
  • L'heure doit être située dans le futur.
  • L'heure ne doit pas être postérieure de plus d'un an à la date du jour.
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.
deleted

boolean

Uniquement en sortie. Indique si le compte associé à cette autorisation a été supprimé. Ce champ ne concerne que les autorisations des utilisateurs et des groupes.
view

string

Indique la vue pour cette autorisation. Renseigné uniquement pour les autorisations appartenant à une vue. "published" est la seule valeur acceptée.
pendingOwner

boolean

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

Méthodes

create

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

delete

 Supprime une autorisation.

get

 Récupère une autorisation par ID.

list

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

update

 Met à jour une autorisation avec une sémantique de correctif.