REST Resource: permissions

Ressource: Berechtigung

Eine Berechtigung für eine Datei. Eine Berechtigung gewährt einem Nutzer, einer Gruppe, einer Domain oder weltweit Zugriff auf eine Datei- oder Ordnerhierarchie.

Einige Ressourcenmethoden (z. B. permissions.update) erfordern eine permissionId. 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 Empfänger und wird in den Nutzerressourcen als permissionId veröffentlicht. IDs sollten als opake Werte behandelt werden.
displayName

string

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

  • user: Vollständiger Name des Nutzers, so wie er für sein Google-Konto festgelegt ist, z. B. „Max Mustermann“.
  • group: Name der Google-Gruppe, z. B. „Die Administratoren des Unternehmens“
  • domain: String-Domainname wie „thecompany.com“
  • anyone: Es ist kein displayName vorhanden.
type

string

Der Typ des Empfängers einer Förderung. Gültige Werte sind:

  • user
  • group
  • domain
  • anyone

Wenn type beim Erstellen einer Berechtigung den Wert user oder group hat, müssen Sie eine emailAddress für den Nutzer oder die Gruppe angeben. Wenn type den Wert domain hat, müssen Sie eine 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. Details dazu, ob die Berechtigungen für dieses Element in der geteilten Ablage übernommen werden oder direkt für dieses Element Dies ist ein reines Ausgabefeld, das nur für Elemente in geteilten Ablagen vorhanden ist.
permissionDetails[].permissionType

string

Nur Ausgabe. Der Berechtigungstyp für diesen Nutzer. Während in Zukunft möglicherweise neue Werte hinzugefügt werden, ist derzeit Folgendes möglich:

  • file
  • member
permissionDetails[].inheritedFrom

string

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

string

Nur Ausgabe. Die primäre Rolle für diesen Nutzer. Während in Zukunft möglicherweise neue Werte hinzugefügt werden, ist derzeit Folgendes möglich:

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

boolean

Nur Ausgabe. Gibt an, ob diese Berechtigung übernommen wurde. Dieses Feld wird immer ausgefüllt. Dieses Feld dient nur zur Ausgabe.
emailAddress

string

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

string

Die durch diese Berechtigung gewährte Rolle. Während in Zukunft möglicherweise neue Werte unterstützt werden, ist derzeit Folgendes zulässig:

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

boolean

Gibt an, ob die Berechtigung erlaubt, die Datei über eine Suche zu finden. 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.
  • Der Zeitpunkt darf nicht mehr als ein Jahr in der Zukunft liegen.
teamDrivePermissionDetails[]
(deprecated)

object

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

string

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

string

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

string

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

boolean

Verworfen: 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 Ansicht gehören. 'veröffentlicht' ist der einzige unterstützte Wert.
pendingOwner

boolean

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

Methoden

create

 Dadurch wird eine Berechtigung für eine Datei oder eine geteilte Ablage erstellt.

delete

 Löscht eine Berechtigung.

get

 Ruft eine Berechtigung nach ID ab.

list

 Listet die Berechtigungen einer Datei oder geteilten Ablage auf.

update

 Aktualisiert eine Berechtigung mit Patch-Semantik.