REST Resource: permissions

Ressource: Permission

Autorisation pour un fichier. Une autorisation permet à un utilisateur, à un groupe, à un domaine ou au monde entier d'accéder à un fichier ou à une hiérarchie de dossiers.

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 d'un identifiant unique pour le bénéficiaire. Il est publié dans les ressources utilisateur en tant que permissionId. Les ID 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 que défini pour son compte Google (par exemple, "Jean Dupont").
  • group : nom du groupe Google, par exemple "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 de bénéficiaire. Les valeurs possibles 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 défini sur domain, vous devez fournir un élément domain. Aucune information supplémentaire n'est requise pour un type anyone.

kind

string

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

permissionDetails[]

object

Uniquement en sortie. Indique si les autorisations pour cet élément du Drive partagé sont héritées ou directement sur cet élément. Ce champ généré uniquement n'est disponible que pour les éléments du Drive partagé.

permissionDetails[].permissionType

string

Uniquement en sortie. Type d'autorisation associé à cet utilisateur. Il est possible d'ajouter de nouvelles valeurs à l'avenir. Toutefois, les options suivantes sont actuellement disponibles:

  • 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 à l'avenir, voici les options 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 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. Bien que les nouvelles valeurs puissent ê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 autorise la recherche du fichier dans le cadre d'une recherche. Cela ne concerne que les 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 restrictions d'expiration sont les 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.
  • Cette date ne peut pas être située dans plus d'un an.
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 de cette autorisation. Renseigné uniquement pour les autorisations qui appartiennent à une vue. La valeur "publiée" est la seule acceptée.

pendingOwner

boolean

Indique si le compte associé à cette autorisation est propriétaire en attente. Renseignée uniquement 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 basée sur l'ID.

list

Répertorie les autorisations pour un fichier ou un Drive partagé.

update

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