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,
  "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
}
Felder
id

string

Die ID des Nutzers, auf den sich diese Berechtigung bezieht. Sie ist mit der permissionId in den Ressourcen „Info“ und „Dateien“ identisch. 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. Während in Zukunft möglicherweise neue Werte unterstützt werden, ist derzeit Folgendes 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 aber möglicherweise weitere unterstützt.

authKey
(deprecated)

string

Nur Ausgabe. Verworfen.

value

string

Die E-Mail-Adresse oder der Domainname für die Entität. Dieser wird während des Einfügevorgangs verwendet und nicht in Antworten eingefügt. 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. Dies ist ein reines Ausgabefeld, das vorhanden ist, 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 zur Ausgabe und ist vorhanden, wenn der Berechtigungstyp user, group oder domain ist.

etag

string

Nur Ausgabe. Das ETag der Berechtigung.

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

string

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

permissionDetails[].inheritedFrom

string

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

permissionDetails[].inherited

boolean

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

expirationDate

string

Der Zeitpunkt, zu dem diese Berechtigung abläuft (RFC 3339-Datum/Uhrzeit). Für das Ablaufdatum 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. Eingestellt: Verwende stattdessen permissionDetails.

teamDrivePermissionDetails[]
(deprecated).teamDrivePermissionType
(deprecated)

string

Nur Ausgabe. Eingestellt: Verwende stattdessen permissionDetails/permissionType.

teamDrivePermissionDetails[]
(deprecated).role
(deprecated)

string

Nur Ausgabe. Eingestellt: Verwende stattdessen permissionDetails/role.

teamDrivePermissionDetails[]
(deprecated).additionalRoles[]
(deprecated)

string

Nur Ausgabe. Eingestellt: Verwende stattdessen permissionDetails/additionalRoles.

teamDrivePermissionDetails[]
(deprecated).inheritedFrom
(deprecated)

string

Nur Ausgabe. Eingestellt: Verwende stattdessen permissionDetails/inheritedFrom.

teamDrivePermissionDetails[]
(deprecated).inherited
(deprecated)

boolean

Nur Ausgabe. Eingestellt: Verwende 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. published 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

delete

Damit wird eine Berechtigung aus einer Datei oder geteilten Ablage gelöscht.

get

Ruft eine Berechtigung nach 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 geteilte Ablage ein.

list

Listet die Berechtigungen einer Datei oder geteilten Ablage auf.

patch

Aktualisiert eine Berechtigung mit Patch-Semantik.

update

Aktualisiert eine Berechtigung.