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.

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,
  "name": string,
  "type": string,
  "role": string,
  "additionalRoles": [
    string
  ],
  "authKey": string,
  "value": string,
  "kind": string,
  "withLink": boolean,
  "photoLink": string,
  "selfLink": string,
  "emailAddress": string,
  "domain": string,
  "etag": string,
  "permissionDetails": [
    {
      "permissionType": string,
      "role": string,
      "additionalRoles": [
        string
      ],
      "inheritedFrom": string,
      "inherited": boolean
    }
  ],
  "expirationDate": string,
  "teamDrivePermissionDetails": [
    {
      "teamDrivePermissionType": string,
      "role": string,
      "additionalRoles": [
        string
      ],
      "inheritedFrom": string,
      "inherited": boolean
    }
  ],
  "deleted": boolean,
  "view": string,
  "pendingOwner": boolean,
  "inheritedPermissionsDisabled": boolean
}
Felder
id

string

Die ID des Nutzers, auf den sich diese Berechtigung bezieht. Sie stimmt mit der permissionId in den Ressourcen „Info“ und „Dateien“ überein. Bei einer drive.permissions.insert-Anfrage muss genau eines der Felder id oder value angegeben werden, es sei denn, der Berechtigungstyp ist anyone. In diesem Fall werden sowohl id als auch value ignoriert.
name

string

Nur Ausgabe. Der Name für diese Berechtigung.
type

string

Der Kontotyp. Zulässige Werte sind:

  • user
  • group
  • domain
  • anyone
role

string

Die primäre Rolle für diesen Nutzer. Neue Werte werden möglicherweise in Zukunft unterstützt. Derzeit sind folgende Werte zulässig:

  • owner
  • organizer
  • fileOrganizer
  • writer
  • reader
additionalRoles[]

string

Zusätzliche Rollen für diesen Nutzer. Derzeit ist nur commenter zulässig. In Zukunft werden möglicherweise weitere unterstützt.
authKey
(deprecated)

string

Nur Ausgabe. Verworfen.
value

string

Die E-Mail-Adresse oder der Domainname der Entität. Dieses Feld wird bei Einfügungen verwendet und nicht in Antworten ausgefüllt. Bei einer drive.permissions.insert-Anfrage muss genau eines der Felder id oder value angegeben werden, es sei denn, der Berechtigungstyp ist anyone. In diesem Fall werden sowohl id als auch value ignoriert.
kind

string

Nur Ausgabe. Dies ist immer drive#permission.
emailAddress

string

Nur Ausgabe. Die E-Mail-Adresse des Nutzers oder der Gruppe, auf die sich diese Berechtigung bezieht. Dieses Feld dient nur der Ausgabe und ist vorhanden, wenn der Berechtigungstyp user oder group ist.
domain

string

Nur Ausgabe. Der Domainname der Entität, auf die sich diese Berechtigung bezieht. Dieses Feld dient nur der Ausgabe und ist vorhanden, wenn der Berechtigungstyp user, group oder domain ist.
etag

string

Nur Ausgabe. Das ETag der Berechtigung.
permissionDetails[]

object

Nur Ausgabe. Gibt an, 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. Neue Werte können in Zukunft hinzugefügt werden. Derzeit sind folgende Werte möglich:

  • file
  • member
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
  • reader
permissionDetails[].additionalRoles[]

string

Nur Ausgabe. Zusätzliche Rollen für diesen Nutzer. Derzeit ist nur commenter möglich, aber es werden möglicherweise in Zukunft weitere unterstützt.
permissionDetails[].inheritedFrom

string

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

boolean

Nur Ausgabe. Gibt an, ob diese Berechtigung übernommen wird. Dieses Feld ist immer ausgefüllt.
expirationDate

string

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

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

object

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

string

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

string

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

string

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

string

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

boolean

Nur Ausgabe. Verworfen. 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

und

metadata

sind die einzigen unterstützten Werte.

  • published

    : Die Rolle der Berechtigung ist „published_reader“.

  • metadata

    : Das Element ist nur in der Metadatenansicht sichtbar, da es eingeschränkten Zugriff hat und der Umfang mindestens Lesezugriff auf das übergeordnete Element hat. Hinweis:

    metadata

    ist derzeit nur für Ordner verfügbar.

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.
inheritedPermissionsDisabled

boolean

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

Methoden

delete

 Löscht eine Berechtigung aus einer Datei oder geteilten Ablage.

get

 Ruft eine Berechtigung anhand der ID ab.

getIdForEmail

 Gibt die Berechtigungs-ID für eine E-Mail-Adresse zurück.

insert

 Fügt eine Berechtigung für eine Datei oder eine freigegebene Ablage ein.

list

 Hier werden die Berechtigungen einer Datei oder einer geteilten Ablage aufgeführt.

patch

 Aktualisiert eine Berechtigung mithilfe von Patch-Semantik.

update

 Aktualisiert eine Berechtigung.