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.

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,
  "name": string,
  "type": string,
  "role": string,
  "additionalRoles": [
    string
  ],
  "authKey": string,
  "value": string,
  "kind": string,
  "withLink": boolean,
  "photoLink": string,
  "selfLink": string,
  "emailAddress": string,
  "domain": string,
  "etag": string,
  "permissionDetails": [
    {
      "permissionType": string,
      "role": string,
      "additionalRoles": [
        string
      ],
      "inheritedFrom": string,
      "inherited": boolean
    }
  ],
  "expirationDate": string,
  "teamDrivePermissionDetails": [
    {
      "teamDrivePermissionType": string,
      "role": string,
      "additionalRoles": [
        string
      ],
      "inheritedFrom": string,
      "inherited": boolean
    }
  ],
  "deleted": boolean,
  "view": string,
  "pendingOwner": boolean,
  "inheritedPermissionsDisabled": boolean
}
Champs
id

string

ID de l'utilisateur auquel cette autorisation fait référence, identique à permissionId dans les ressources "À propos" et "Fichiers". Lorsque vous effectuez une requête drive.permissions.insert, vous devez spécifier exactement un seul des champs id ou value, sauf si le type d'autorisation est anyone, auquel cas id et value sont ignorés.
name

string

Uniquement en sortie. Nom de cette autorisation.
type

string

Type de compte. Les valeurs autorisées sont les suivantes :

  • user
  • group
  • domain
  • anyone
role

string

Rôle principal de cet utilisateur. Bien que de nouvelles valeurs puissent être acceptées à l'avenir, les valeurs suivantes sont actuellement autorisées:

  • owner
  • organizer
  • fileOrganizer
  • writer
  • reader
additionalRoles[]

string

Rôles supplémentaires pour cet utilisateur. Seul commenter est actuellement autorisé, mais d'autres valeurs pourraient être acceptées à l'avenir.
authKey
(deprecated)

string

Uniquement en sortie. Obsolète.
value

string

Adresse e-mail ou nom de domaine de l'entité. Il est utilisé lors des insertions et n'est pas renseigné dans les réponses. Lorsque vous effectuez une requête drive.permissions.insert, vous devez spécifier exactement un seul des champs id ou value, sauf si le type d'autorisation est anyone, auquel cas id et value sont ignorés.
kind

string

Uniquement en sortie. Cette valeur est toujours drive#permission.
emailAddress

string

Uniquement en sortie. Adresse e-mail de l'utilisateur ou du groupe auquel cette autorisation fait référence. Il s'agit d'un champ de sortie uniquement, qui est présent lorsque le type d'autorisation est user ou group.
domain

string

Uniquement en sortie. Nom de domaine de l'entité à laquelle cette autorisation fait référence. Il s'agit d'un champ de sortie uniquement, qui est présent lorsque le type d'autorisation est user, group ou domain.
etag

string

Uniquement en sortie. ETag de l'autorisation.
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. De nouvelles valeurs pourront être ajoutées à l'avenir, mais les suivantes sont actuellement possibles:

  • file
  • member
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
  • reader
permissionDetails[].additionalRoles[]

string

Uniquement en sortie. Rôles supplémentaires pour cet utilisateur. Seul commenter est actuellement possible, mais d'autres formats pourraient être pris en charge à l'avenir.
permissionDetails[].inheritedFrom

string

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

boolean

Uniquement en sortie. Indique si cette autorisation est héritée. Ce champ est toujours renseigné.
expirationDate

string

Heure à laquelle cette autorisation expirera (date-heure au format RFC 3339). Les dates d'expiration sont soumises aux restrictions suivantes:

  • Elles ne peuvent être définies que sur les autorisations des utilisateurs et des groupes.
  • La date doit être située dans le futur
  • La date ne peut pas être postérieure à un an
teamDrivePermissionDetails[]
(deprecated)

object

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

string

Uniquement en sortie. Obsolète: utilisez permissionDetails/permissionType à la place.
teamDrivePermissionDetails[]
(deprecated).role
(deprecated)

string

Uniquement en sortie. Obsolète: utilisez permissionDetails/role à la place.
teamDrivePermissionDetails[]
(deprecated).additionalRoles[]
(deprecated)

string

Uniquement en sortie. Obsolète: utilisez permissionDetails/additionalRoles à la place.
teamDrivePermissionDetails[]
(deprecated).inheritedFrom
(deprecated)

string

Uniquement en sortie. Obsolète: utilisez permissionDetails/inheritedFrom à la place.
teamDrivePermissionDetails[]
(deprecated).inherited
(deprecated)

boolean

Uniquement en sortie. Obsolète: 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

et

metadata

sont les seules valeurs acceptées.

  • published

    : Le rôle de l'autorisation est published_reader.

  • metadata

    : L'élément n'est visible que dans la vue des métadonnées, car son accès est limité et la portée dispose au moins d'un accès en lecture au parent. Remarque :

    metadata

    n'est actuellement compatible qu'avec les dossiers.

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é.
inheritedPermissionsDisabled

boolean

Si cette valeur est définie sur "true", seuls les organisateurs, les propriétaires et les utilisateurs disposant d'autorisations ajoutées directement à l'élément peuvent y accéder.

Méthodes

delete

 Supprime une autorisation d'un fichier ou d'un Drive partagé.

get

 Récupère une autorisation par ID.

getIdForEmail

 Renvoie l'ID d'autorisation d'une adresse e-mail.

insert

 Insère une autorisation pour un fichier ou un Drive partagé.

list

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

patch

 Met à jour une autorisation à l'aide de la sémantique de correctif.

update

 Met à jour une autorisation.