REST Resource: permissions

Ressource: Permission

Eine Berechtigung für eine Datei. Eine Berechtigung gewährt einem Nutzer, einer Gruppe, einer Domain oder allen Nutzern Zugriff auf eine Datei oder eine Ordnerhierarchie. Weitere Informationen finden Sie unter Dateien, Ordner und Ablagen freigeben.

Standardmäßig wird bei Berechtigungsanfragen nur eine Teilmenge der Felder zurückgegeben. Die Berechtigungen kind, ID, type und role werden immer zurückgegeben. Informationen zum Abrufen bestimmter Felder finden Sie unter Bestimmte Felder zurückgeben.

Für einige Ressourcenmethoden (z. B. permissions.update) ist ein permissionId erforderlich. Verwenden Sie die Methode permissions.list, um die ID für eine Datei, einen Ordner oder eine geteilte Ablage abzurufen.

JSON-Darstellung 
{
  "permissionDetails": [
    {
      "permissionType": string,
      "inheritedFrom": string,
      "role": string,
      "inherited": boolean
    }
  ],
  "teamDrivePermissionDetails": [
    {
      "teamDrivePermissionType": string,
      "inheritedFrom": string,
      "role": string,
      "inherited": boolean
    }
  ],
  "id": string,
  "displayName": string,
  "type": string,
  "kind": string,
  "photoLink": string,
  "emailAddress": string,
  "role": string,
  "allowFileDiscovery": boolean,
  "domain": string,
  "expirationTime": string,
  "deleted": boolean,
  "view": string,
  "pendingOwner": boolean,
  "inheritedPermissionsDisabled": boolean
}
Felder
permissionDetails[]

object

Nur Ausgabe. Details dazu, ob die Berechtigungen für dieses Element übernommen oder direkt für dieses Element festgelegt wurden.
permissionDetails[].permissionType

string

Nur Ausgabe. Der Berechtigungstyp für diesen Nutzer. Unterstützte Werte sind:

  • file
  • member
permissionDetails[].inheritedFrom

string

Nur Ausgabe. Die ID des Elements, von dem diese Berechtigung übernommen wird. Wird nur für Elemente in geteilten Ablagen ausgefüllt.
permissionDetails[].role

string

Nur Ausgabe. Die primäre Rolle für diesen Nutzer. Unterstützte Werte sind:

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

Weitere Informationen finden Sie unter Rollen und Berechtigungen.
permissionDetails[].inherited

boolean

Nur Ausgabe. Gibt an, ob diese Berechtigung übernommen wird. Dieses Feld ist immer ausgefüllt. Dieses Feld dient nur der Ausgabe.
teamDrivePermissionDetails[]
(deprecated)

object

Nur Ausgabe. Veraltet: Nur Ausgabe. Verwenden Sie stattdessen permissionDetails.
teamDrivePermissionDetails[]
(deprecated).teamDrivePermissionType
(deprecated)

string

Veraltet: Nur Ausgabe. Verwenden Sie stattdessen permissionDetails/permissionType.
teamDrivePermissionDetails[]
(deprecated).inheritedFrom
(deprecated)

string

Veraltet: Nur Ausgabe. Verwenden Sie stattdessen permissionDetails/inheritedFrom.
teamDrivePermissionDetails[]
(deprecated).role
(deprecated)

string

Veraltet: Nur Ausgabe. Verwenden Sie stattdessen permissionDetails/role.
teamDrivePermissionDetails[]
(deprecated).inherited
(deprecated)

boolean

Veraltet: Nur Ausgabe. Verwenden Sie stattdessen permissionDetails/inherited.
id

string

Nur Ausgabe. Die ID dieser Berechtigung. Dies ist eine eindeutige Kennung für den Empfänger, die in der Nutzerressource als permissionId veröffentlicht wird. IDs sollten als undurchsichtige Werte behandelt werden.
displayName

string

Nur Ausgabe. Der „hübsche“ Name des Berechtigungswerts. Im Folgenden finden Sie eine Liste mit Beispielen für die einzelnen Berechtigungstypen:

  • user: Der vollständige Name des Nutzers, wie er für sein Google-Konto definiert ist, z. B. „Dana A.“
  • group: Name der Google-Gruppe, z. B. „Die Unternehmensadministratoren“.
  • domain: String-Domainname, z. B. „cymbalgroup.com“.
  • anyone: Es ist kein displayName vorhanden.
type

string

Der Typ des Empfängers. Unterstützte Werte sind:

  • user
  • group
  • domain
  • anyone

Wenn Sie eine Berechtigung erstellen und type user oder group ist, müssen Sie eine emailAddress für den Nutzer oder die Gruppe angeben. Wenn type domain ist, müssen Sie einen domain angeben. Wenn type anyone ist, sind keine zusätzlichen Informationen erforderlich.
kind

string

Nur Ausgabe. Kennzeichnet, welche Art von Ressource dies ist. Wert: der feste String "drive#permission".
emailAddress

string

Die E-Mail-Adresse des Nutzers oder der Gruppe, auf die sich diese Berechtigung bezieht.
role

string

Die Rolle, die durch diese Berechtigung gewährt wird. Unterstützte Werte sind:

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

Weitere Informationen finden Sie unter Rollen und Berechtigungen.
allowFileDiscovery

boolean

Gibt an, ob die Datei aufgrund der Berechtigung durch die Suche gefunden werden kann. Dies gilt nur für Berechtigungen vom Typ domain oder anyone.
domain

string

Die Domain, auf die sich diese Berechtigung bezieht.
expirationTime

string

Der Zeitpunkt, zu dem diese Berechtigung abläuft (RFC 3339-Datum/Uhrzeit). Für Ablaufzeiten gelten die folgenden Einschränkungen:

  • Sie können nur für Nutzer- und Gruppenberechtigungen festgelegt werden.
  • Die Zeit muss in der Zukunft liegen.
  • Die Zeit darf nicht mehr als ein Jahr in der Zukunft liegen.
deleted

boolean

Nur Ausgabe. Gibt an, ob das mit dieser Berechtigung verknüpfte Konto gelöscht wurde. Dieses Feld bezieht sich nur auf Berechtigungen vom Typ user oder group.
view

string

Gibt die Ansicht für diese Berechtigung an. Wird nur für Berechtigungen ausgefüllt, die zu einer Ansicht gehören.

Die einzigen unterstützten Werte sind published und metadata:

  • published: Die Rolle der Berechtigung ist publishedReader.
  • metadata: Das Element ist nur in der Ansicht metadata sichtbar, da der Zugriff auf das Element eingeschränkt ist und der Bereich mindestens Lesezugriff auf das übergeordnete Element hat. Die Ansicht metadata wird nur für Ordner unterstützt.

Weitere Informationen finden Sie unter Ansichten.
pendingOwner

boolean

Gibt an, ob das mit dieser Berechtigung verknüpfte Konto ein ausstehender Inhaber ist. Wird nur für Berechtigungen vom Typ user für Dateien ausgefüllt, die sich nicht in einer geteilten Ablage befinden.
inheritedPermissionsDisabled

boolean

Wenn true, können nur Organisatoren, Inhaber und Nutzer mit Berechtigungen, die direkt für das Element hinzugefügt wurden, darauf zugreifen.

Methoden

create

 Erstellt eine Berechtigung für eine Datei oder geteilte Ablage.

delete

 Löscht eine Berechtigung.

get

 Ruft eine Berechtigung anhand der ID ab.

list

 Listet die Berechtigungen einer Datei oder einer geteilten Ablage auf.

update

 Aktualisiert eine Berechtigung mit Patch-Semantik.