REST Resource: permissions

Ressource: Permission

Autorisation pour un fichier. Une autorisation accorde à un utilisateur, à un groupe, à un domaine ou au monde entier l'accès à un fichier ou à une arborescence 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,
  "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. Cet identifiant unique est attribué au bénéficiaire. Il est publié dans les ressources utilisateur sous le nom permissionId. Les identifiants doivent être traités comme des valeurs opaques.

displayName

string

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

  • user : nom complet de l'utilisateur, tel qu'il est défini dans son compte Google (par exemple, "Jean Dupont").
  • group : nom du groupe Google tel que "Les administrateurs de l'entreprise".
  • domain : nom de domaine de la chaîne, tel que "entreprise.com."
  • anyone : aucun displayName n'est présent.
type

string

Type du bénéficiaire. Les valeurs possibles sont 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. Lorsque type est défini sur 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 associées à cet élément de Drive partagé sont héritées ou directement sur cet élément. Ce champ n'est accessible qu'en sortie et ne s'affiche que pour les éléments de Drive partagés.

permissionDetails[].permissionType

string

Uniquement en sortie. Type d'autorisation attribué à cet utilisateur. Bien que de nouvelles valeurs puissent être ajoutées ultérieurement, les opérations suivantes sont actuellement possibles:

  • file
  • member
permissionDetails[].inheritedFrom

string

Uniquement en sortie. ID de l'élément dont cette autorisation est héritée. Ce champ est en sortie uniquement.

permissionDetails[].role

string

Uniquement en sortie. Rôle principal de cet utilisateur. Bien que de nouvelles valeurs puissent être ajoutées ultérieurement, les opérations suivantes sont actuellement possibles:

  • 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 uniquement.

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. Même si de nouvelles valeurs seront peut-être acceptées à l'avenir, les éléments suivants sont actuellement autorisés:

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

boolean

Indique si l'autorisation permet de découvrir le fichier par le biais d'une 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 sur des autorisations d'utilisateur et de groupe.
  • L'heure doit être située dans le futur.
  • La date/heure ne peut 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 d'utilisateur et de groupe.

view

string

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

pendingOwner

boolean

Indique si le compte associé à cette autorisation est un propriétaire en attente. Renseigné uniquement pour les autorisations de type user appliquées aux 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

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

update

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