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,
  "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
}
Champs
id

string

ID de l'utilisateur auquel cette autorisation fait référence et identique à permissionId dans les ressources "À propos" et "Fichiers". Lorsque vous effectuez une requête drive.permissions.insert, un seul des champs id ou value doit être spécifié, 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. 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
  • reader
additionalRoles[]

string

Rôles supplémentaires pour cet utilisateur. Seule la valeur commenter est autorisée pour le moment, mais d'autres pourront l'être à 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, un seul des champs id ou value doit être spécifié, sauf si le type d'autorisation est anyone, auquel cas id et value sont ignorés.

kind

string

Uniquement en sortie. Il s'agit toujours de 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 en 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. Ce champ n'est disponible qu'en sortie et 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 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[].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
  • reader
permissionDetails[].additionalRoles[]

string

Uniquement en sortie. Rôles supplémentaires pour cet utilisateur. Seule la valeur commenter est possible pour le moment, mais d'autres seront peut-être compatibles à l'avenir.

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[].inherited

boolean

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

expirationDate

string

Heure d'expiration de cette autorisation (date et heure 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 doit pas être postérieure de plus d'un an à la date du jour.
teamDrivePermissionDetails[]
(deprecated)

object

Uniquement en sortie. Obsolète: utilisez plutôt permissionDetails.

teamDrivePermissionDetails[]
(deprecated).teamDrivePermissionType
(deprecated)

string

Uniquement en sortie. Obsolète: utilisez plutôt permissionDetails/permissionType.

teamDrivePermissionDetails[]
(deprecated).role
(deprecated)

string

Uniquement en sortie. Obsolète: utilisez plutôt permissionDetails/role.

teamDrivePermissionDetails[]
(deprecated).additionalRoles[]
(deprecated)

string

Uniquement en sortie. Obsolète: utilisez plutôt permissionDetails/additionalRoles.

teamDrivePermissionDetails[]
(deprecated).inheritedFrom
(deprecated)

string

Uniquement en sortie. Obsolète: utilisez plutôt permissionDetails/inheritedFrom.

teamDrivePermissionDetails[]
(deprecated).inherited
(deprecated)

boolean

Uniquement en sortie. Obsolète: utilisez plutôt permissionDetails/inherited.

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. published 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

delete

Supprime une autorisation associée à un fichier ou à un Drive partagé.

get

Récupère une autorisation par ID.

getIdForEmail

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

insert

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

list

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

patch

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

update

Met à jour une autorisation.