REST Resource: permissions

Ressource: Berechtigung

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.

Standardmäßig geben Berechtigungsanfragen nur einen Teil der Felder zurück. Art, ID, Typ und Rolle der Berechtigung werden immer zurückgegeben. Informationen zum Abrufen bestimmter Felder finden Sie unter https://developers.google.com/drive/api/guides/fields-parameter.

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

JSON-Darstellung 
{
  "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
}
Felder
id

string

Nur Ausgabe. Die ID dieser Berechtigung. Dies ist eine eindeutige Kennung für den Begünstigten und wird in den Nutzerressourcen als permissionId veröffentlicht. IDs sollten als undurchsichtige Werte behandelt werden.
displayName

string

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

  • user: Der vollständige Name des Nutzers, wie er für sein Google-Konto definiert ist, z. B. „Max Muster“.
  • group: Name der Google-Gruppe, z. B. „Administratoren des Unternehmens“
  • domain: String-Domainname, z. B. „beispiel.de“.
  • anyone – Es ist kein displayName vorhanden.
type

string

Der Typ des Begünstigten. Gültige Werte sind:

  • user
  • group
  • domain
  • anyone

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

string

Nur Ausgabe. Gibt an, um welche Art von Ressource es sich handelt. Wert: der feste String "drive#permission".
permissionDetails[]

object

Nur Ausgabe. Gibt an, ob die Berechtigungen für dieses Element in der geteilten Ablage übernommen oder direkt für dieses Element festgelegt wurden. Dieses Feld dient nur der Ausgabe und ist nur für Elemente in geteilten Ablagen vorhanden.
permissionDetails[].permissionType

string

Nur Ausgabe. Der Berechtigungstyp für diesen Nutzer. Neue Werte können in Zukunft hinzugefügt werden. Derzeit sind folgende Werte möglich:

  • file
  • member
permissionDetails[].inheritedFrom

string

Nur Ausgabe. Die ID des Elements, von dem diese Berechtigung übernommen wird. Dieses Feld dient nur der Ausgabe.
permissionDetails[].role

string

Nur Ausgabe. Die primäre Rolle für diesen Nutzer. Neue Werte können in Zukunft hinzugefügt werden. Derzeit sind folgende Werte möglich:

  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader
permissionDetails[].inherited

boolean

Nur Ausgabe. Gibt an, ob diese Berechtigung übernommen wird. Dieses Feld ist immer ausgefüllt. Dieses Feld dient nur der Ausgabe.
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. Neue Werte werden möglicherweise in Zukunft unterstützt. Derzeit sind folgende Werte zulässig:

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

boolean

Gibt an, ob die Datei aufgrund der Berechtigung über 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 (Datum und Uhrzeit im RFC 3339-Format). Für Ablaufzeiten gelten die folgenden Einschränkungen:

  • Sie können nur für Nutzer- und Gruppenberechtigungen festgelegt werden.
  • Die Uhrzeit muss in der Zukunft liegen.
  • Der Zeitpunkt darf nicht mehr als ein Jahr in der Zukunft liegen.
teamDrivePermissionDetails[]
(deprecated)

object

Nur Ausgabe. Nicht mehr unterstützt: Nur Ausgabe. Verwenden Sie stattdessen permissionDetails.
teamDrivePermissionDetails[]
(deprecated).teamDrivePermissionType
(deprecated)

string

Nicht mehr unterstützt: Nur Ausgabe. Verwenden Sie stattdessen permissionDetails/permissionType.
teamDrivePermissionDetails[]
(deprecated).inheritedFrom
(deprecated)

string

Nicht mehr unterstützt: Nur Ausgabe. Verwenden Sie stattdessen permissionDetails/inheritedFrom.
teamDrivePermissionDetails[]
(deprecated).role
(deprecated)

string

Nicht mehr unterstützt: Nur Ausgabe. Verwenden Sie stattdessen permissionDetails/role.
teamDrivePermissionDetails[]
(deprecated).inherited
(deprecated)

boolean

Nicht mehr unterstützt: Nur Ausgabe. Verwenden Sie stattdessen permissionDetails/inherited.
deleted

boolean

Nur Ausgabe. Gibt an, ob das mit dieser Berechtigung verknüpfte Konto gelöscht wurde. Dieses Feld bezieht sich nur auf Nutzer- und Gruppenberechtigungen.
view

string

Gibt die Ansicht für diese Berechtigung an. Wird nur für Berechtigungen ausgefüllt, die zu einer Datenansicht gehören. „published“ ist der einzige unterstützte Wert.
pendingOwner

boolean

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

Methoden

create

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

delete

 Löscht eine Berechtigung.

get

 Ruft eine Berechtigung anhand der ID ab.

list

 Hier werden die Berechtigungen für eine Datei oder eine geteilte Ablage aufgelistet.

update

 Aktualisiert eine Berechtigung mit Patch-Semantik.