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. Sie wird in den Nutzerressourcen als permissionId veröffentlicht. IDs sollten als intransparente Werte behandelt werden.

displayName

string

Nur Ausgabe Der „schöne“ Name des Werts der Berechtigung. Im Folgenden finden Sie eine Liste mit Beispielen für jeden Berechtigungstyp:

  • user: Der vollständige Name des Nutzers, 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: Domainname des Strings, z. B. "thecompany.com"
  • anyone: Es ist keine displayName vorhanden.
type

string

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

  • user
  • group
  • domain
  • anyone

Wenn type beim Erstellen einer Berechtigung user oder group ist, müssen Sie eine emailAddress für den Nutzer oder die Gruppe angeben. Wenn type den Wert domain hat, musst du einen domain angeben. Für den Typ anyone sind keine zusätzlichen Informationen erforderlich.

kind

string

Nur Ausgabe Gibt an, welche Art von Ressource dies ist. 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. Dieses Feld dient ausschließlich der Ausgabe und ist nur für Elemente in geteilten Ablagen vorhanden.

permissionDetails[].permissionType

string

Nur Ausgabe Der Berechtigungstyp für diesen Nutzer. In Zukunft können zwar neue Werte hinzugefügt werden, derzeit ist jedoch 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. In Zukunft werden möglicherweise neue Werte hinzugefügt. Derzeit ist Folgendes möglich:

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

boolean

Nur Ausgabe Gibt an, ob diese Berechtigung übernommen wird. 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. In Zukunft werden zwar möglicherweise neue Werte unterstützt, derzeit sind jedoch die folgenden zulässig:

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

boolean

Gibt an, ob die Berechtigung zulässt, dass die Datei über die Suche gefunden wird. 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/Uhrzeit gemäß RFC 3339). 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 Eingestellt: Nur Ausgabe. Verwenden Sie stattdessen permissionDetails.

teamDrivePermissionDetails[]
(deprecated).teamDrivePermissionType
(deprecated)

string

Eingestellt: Nur Ausgabe. Verwenden Sie stattdessen permissionDetails/permissionType.

teamDrivePermissionDetails[]
(deprecated).inheritedFrom
(deprecated)

string

Eingestellt: Nur Ausgabe. Verwenden Sie stattdessen permissionDetails/inheritedFrom.

teamDrivePermissionDetails[]
(deprecated).role
(deprecated)

string

Eingestellt: Nur Ausgabe. Verwenden Sie stattdessen permissionDetails/role.

teamDrivePermissionDetails[]
(deprecated).inherited
(deprecated)

boolean

Eingestellt: 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 enthält nur 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 das mit dieser Berechtigung verknüpfte Konto ein ausstehender Inhaber ist. Wird nur mit Berechtigungen vom Typ „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

Hier sehen Sie die Berechtigungen für eine Datei oder geteilte Ablage.

update

Aktualisiert eine Berechtigung mit Patch-Semantik.