REST Resource: permissions

Ressource: Berechtigung

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

Für einige Ressourcenmethoden wie 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
{
  "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 der Förderung 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 Werts der Berechtigung. Die folgende Liste enthält Beispiele für die einzelnen Berechtigungstypen:

  • user: Der vollständige Name des Nutzers, wie für sein Google-Konto definiert, z. B. Max Mustermann
  • group: Name der Google Groups-Gruppe, z. B. „Administratoren des Unternehmens“
  • domain: Domainname des Strings, z. B. „IhrUnternehmen.de“.
  • anyone: Kein displayName vorhanden.
type

string

Der Typ des Ad Grantees. Gültige Werte sind:

  • user
  • group
  • domain
  • anyone

Wenn type eine user oder group ist, müssen Sie beim Erstellen einer Berechtigung eine emailAddress für den Nutzer oder die Gruppe angeben. Wenn type den Wert domain hat, müssen Sie einen 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: fester String "drive#permission".

permissionDetails[]

object

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

permissionDetails[].permissionType

string

Nur Ausgabe. Der Berechtigungstyp für diesen Nutzer. Es können derzeit neue Werte hinzugefügt werden. Derzeit ist Folgendes möglich:

  • file
  • member
permissionDetails[].inheritedFrom

string

Nur Ausgabe. Die ID des Elements, von dem diese Berechtigung übernommen wird. Dieses Feld dient nur zur Ausgabe.

permissionDetails[].role

string

Nur Ausgabe. Die primäre Rolle des Nutzers. In Zukunft können neue Werte hinzugefügt werden. Derzeit ist 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 diese Berechtigung verweist.

role

string

Die durch diese Berechtigung gewährte Rolle. Neue Werte werden zwar in Zukunft möglicherweise unterstützt, aber derzeit sind folgende zulässig:

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

boolean

Gibt an, ob die Berechtigung erlaubt, die Datei über die Suche zu finden. Dies gilt nur für Berechtigungen vom Typ domain oder anyone.

domain

string

Die Domain, auf die diese Berechtigung verweist.

expirationTime

string

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

  • Sie lassen sich nur für Nutzer- und Gruppenberechtigungen festlegen.
  • Die Zeit muss in der Zukunft liegen.
  • Die Zeit 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 betrifft nur 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. „publish“ ist der einzige unterstützte Wert.

pendingOwner

boolean

Ob das mit dieser Berechtigung verknüpfte Konto ein Inhaber ist, für den die Änderung aussteht. Wird nur für Berechtigungen des Typs user für Dateien ausgefüllt, die sich nicht in einer geteilten Ablage befinden.

Methoden

create

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

delete

Löscht eine Berechtigung

get

Ruft eine Berechtigung nach ID ab.

list

Listet die Berechtigungen einer Datei oder einer geteilten Ablage auf

update

Aktualisiert eine Berechtigung mit Patchsemantik.