Berechtigungsressourcentyp

  • Artikel

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Die Berechtigungsressource enthält Informationen zu einer Freigabeberechtigung, die für eine driveItem-Ressource gewährt wird.

Freigabeberechtigungen haben viele verschiedene Formen. Die Berechtigung-Ressource stellt diese verschiedenen Formen über Facets für die Ressource dar.

Hinweis: OneDrive for Business- und SharePoint-Dokumentbibliotheken geben die inheritedFrom-Eigenschaft nicht zurück.

OneDrive for Business- und SharePoint-Dokumentbibliotheken geben die inheritedFrom-Eigenschaft nicht zurück. grantedTo und grantedToIdentities werden in Zukunft als veraltet markiert, und die Antwort wird jeweils zu grantedToV2 und grantedToIdentitiesV2, unter entsprechenden Eigenschaftsnamen, migriert.

JSON-Darstellung

Die folgende JSON-Darstellung zeigt den Ressourcentyp.

{
  "id": "string (identifier)",
  "grantedTo": {"@odata.type": "microsoft.graph.identitySet"},
  "grantedToIdentities": [{"@odata.type": "microsoft.graph.identitySet"}],
  "grantedToV2": {"@odata.type": "microsoft.graph.sharePointIdentitySet"},
  "grantedToIdentitiesV2": [{"@odata.type": "microsoft.graph.sharePointIdentitySet"}],
  "inheritedFrom": {"@odata.type": "microsoft.graph.itemReference"},
  "invitation": {"@odata.type": "microsoft.graph.sharingInvitation"},
  "link": {"@odata.type": "microsoft.graph.sharingLink"},
  "roles": ["string"],
  "shareId": "string",
  "expirationDateTime": "string (timestamp)",
  "hasPassword": "boolean"
}

Eigenschaften

Eigenschaft Typ Beschreibung
id String Die eindeutige ID der Berechtigung für alle Berechtigungen für das Element. Schreibgeschützt.
grantedToV2 SharePointIdentitySet Für Benutzertypberechtigungen, die Details der Benutzer und Anwendungen für diese Berechtigung. Schreibgeschützt.
grantedToIdentitiesV2 Collection(SharePointIdentitySet) Für Verknüpfungstyp-Berechtigungen: die Details der Benutzer, denen die Berechtigung erteilt wurde. Schreibgeschützt.
invitation SharingInvitation Details zu verknüpften Einladungen zur Freigabe für diese Berechtigung. Schreibgeschützt.
inheritedFrom ItemReference Stellt einen Verweis auf den Vorgänger der aktuellen Berechtigung bereit, wenn sie von einem Vorgänger geerbt wird. Schreibgeschützt.
Link SharingLink Stellt die Linkdetails der aktuellen Berechtigung bereit, wenn es sich um eine Linktypberechtigung handelt. Schreibgeschützt.
roles Collection(String) Der Berechtigungstyp, z. B. read. Die vollständige Liste der Rollen finden Sie im Abschnitt Rolleneigenschaftswerte. Schreibgeschützt.
shareId String Ein eindeutiges Token, das verwendet werden kann, um über die Freigabe-API auf dieses freigegebene Element zuzugreifen. Schreibgeschützt.
expirationDateTime DateTimeOffset Das Format jjjj-MM-ttTHH:mm:ssZ von DateTimeOffset gibt den Ablaufzeitpunkt der Berechtigung an. DateTime.MinValue gibt an, dass für diese Berechtigung kein Ablauf festgelegt ist. Optional.
hasPassword Boolescher Wert Gibt an, ob das Kennwort für diese Berechtigung festgelegt ist. Diese Eigenschaft wird nur in der Antwort angezeigt. Optional. Schreibgeschützt. Nur für OneDrive Personal.
grantedTo (veraltet) IdentitySet Bei Benutzertypberechtigungen, die Details der Benutzer und Anwendungen für diese Berechtigung. Schreibgeschützt.
grantedToIdentities (veraltet) Collection(IdentitySet) Bei Typberechtigungen die Details der Benutzer, denen die Berechtigung erteilt wurde. Schreibgeschützt.

Rollen-Eigenschaftswerte

Wert Beschreibung
Lesen Ermöglicht das Lesen der Metadaten und Inhalte des Elements.
Schreiben Ermöglicht das Lesen und Ändern der Metadaten und Inhalte des Elements.
Besitzer Für SharePoint und OneDrive for Business stellt dies die Besitzerrolle dar.

Die Permission-Ressource verwendet Facets zum Bereitstellen von Informationen über die Art der Berechtigung, die von Ressource dargestellt wird.

Freigabelinks enthalten ein eindeutiges Token, das für den Zugriff auf das Element erforderlich ist.

Berechtigungen mit einem Einladungsfacet stellen Berechtigungen dar, die durch das Einladen bestimmter Benutzer oder Gruppen hinzugefügt wurden, um Zugriff auf die Datei zu haben.

Berechtigungen für ein link-Facet stellen Freigabe-Links dar, die für das Element erstellt wurden. Dies sind die am häufigsten verwendeten Berechtigungsarten. Freigabelinks stellen eine eindeutige URL dar, die für den Zugriff auf eine Datei oder einen Ordner verwendet werden kann. Sie können so eingerichtet werden, dass der Zugriff auf verschiedene Arten gewährt wird. Sie können z. b. die CreateLink-API verwenden, um einen Link zu erstellen, der für alle Benutzer in Ihrer Organisation geeignet ist, oder Sie können einen Link erstellen, der für jeden geeignet ist, ohne sich anmelden zu müssen. Sie können die Einladungs -API verwenden, um einen Link zu erstellen, der nur für bestimmte Personen funktioniert – ganz gleich, ob sich diese in Ihrem Unternehmen befinden oder nicht.

Hier sind einige Beispiele für Freigabelinks.

Ein Anzeigelink bietet schreibgeschützten Zugriff auf ein Element.

{
  "id": "1",
  "roles": ["read"],
  "link": {
    "scope": "anonymous",
    "type": "view",
    "webUrl": "https://onedrive.live.com/redir?resid=5D33DD65C6932946!70859&authkey=!AL7N1QAfSWcjNU8&ithint=folder%2cgif",
    "application": { "id": "1234", "displayName": "Sample Application" }
  },
  "shareId": "!LKj1lkdlals90j1nlkascl",
  "expirationDateTime": "0001-01-01T00:00:00Z"
}

Mit diesem Bearbeitungslink wird jeder Person in der Organisation, die über den Link verfügt, Lese-und Schreibzugriff gewährt.

{
  "id": "2ceefb3g32hh",
  "roles": ["write"],
  "link": {
    "scope": "organization",
    "type": "edit",
    "webUrl": "https://contoso.sharepoint.com/:w:/t/design/fj277ghautbb422707565gnvg23",
    "application": { "id": "1234", "displayName": "Sample Application" }
  },
  "shareId": "!LKj1lkdlals90j1nlkascl",
  "expirationDateTime": "0001-01-01T00:00:00Z"
}

Dieser Link gewährt dem Benutzer keine zusätzlichen Berechtigungen.

{
  "id": "00000000-0000-0000-0000-000000000000",
  "roles": ["read"],
  "link": {
    "scope": "existingAccess",
    "type": "view",
    "webUrl": "https://contoso.sharepoint.com/:w:/t/design/Shared%20Documents/SampleDoc.docx?d=w12345",
  },
  "expirationDateTime": "0001-01-01T00:00:00Z"
}

Dieser Link bietet Lese- und Schreibzugriff für bestimmte Personen in der grantedToIdentities-Sammlung.

{
  "id": "3",
  "grantedToIdentities": [
    {
       "user": {
        "id": "35fij1974gb8832",
        "displayName": "Misty Suarez"
      }
    },
    {
       "user": {
        "id": "9397721fh4hgh73",
        "displayName": "Judith Clemons"
      }
    }
  ],
  "grantedToIdentitiesV2": [
    {
       "user": {
        "id": "35fij1974gb8832",
        "displayName": "Misty Suarez"
      },
      "siteUser": {
        "id": "1",
        "displayName": "Misty Suarez",
        "loginName": "Misty Suarez"
      }
    },
    {
       "user": {
        "id": "9397721fh4hgh73",
        "displayName": "Judith Clemons"
      },
      "siteUser": {
        "id": "2",
        "displayName": "Judith Clemons",
        "loginName": "Judith Clemons"
      }
    }
  ],
  "roles": ["write"],
  "link": {
    "webUrl": "https://contoso.sharepoint.com/:w:/t/design/a577ghg9hgh737613bmbjf839026561fmzhsr85ng9f3hjck2t5s",
    "application": { "id": "1234", "displayName": "Sample Application" }
  },
  "shareId": "!LKj1lkdlals90j1nlkascl",
  "expirationDateTime": "0001-01-01T00:00:00Z"
}

Freigeben von Einladungen

Berechtigungen, die von der Einladungs- oder Gewährungs-API gesendet werden, können zusätzliche Informationen im Einladungsfacet für E-Mail-Adressen enthalten, die nicht mit einem bekannten Konto übereinstimmen. In solchen Fällen wird die grantedTo-Eigenschaft möglicherweise erst festgelegt, wenn der Einladungslink eingelöst wird. Dies geschieht, wenn der Benutzer zum ersten Mal auf den Link klickt und sich anmeldet.

{
  "id": "1",
  "roles": ["write"],
  "invitation": {
    "email": "jd@fabrikam.com",
    "signInRequired": true
  },
  "shareId": "FWxc1lasfdbEAGM5fI7B67aB5ZMPDMmQ11U",
  "expirationDateTime": "0001-01-01T00:00:00Z"
}

Nachdem die Freigabeeinladung von einem Benutzer eingelöst wurde, enthält die Eigenschaft grantedTo die Informationen über das Konto, das die Berechtigungen eingelöst hat:

{
  "id": "1",
  "roles": ["write"],
  "grantedTo": {
    "user": {
      "id": "5D33DD65C6932946",
      "displayName": "Robin Danielsen"
    }
  },
  "grantedToV2": {
    "user": {
      "id": "5D33DD65C6932946",
      "displayName": "Robin Danielsen"
    },
    "siteUser": {
      "id": "1",
      "displayName": "Robin Danielsen",
      "loginName": "Robin Danielsen"
    }
  },
  "invitation": {
    "email": "rd@contoso.com",
    "signInRequired": true
  },
  "shareId": "FWxc1lasfdbEAGM5fI7B67aB5ZMPDMmQ11U",
  "expirationDateTime": "0001-01-01T00:00:00Z"
}

Methoden

Methode REST-Pfad
Berechtigungen auflisten GET /drive/items/{item-id}/permissions
Get permission GET /drive/items/{item-id}/permissions/{id}
Link "Erstellen" POST /drive/items/{item-id}/createLink
Personen einladen POST /drive/items/{item-id}/invite
Update PATCH /drive/items/{item-id}/permissions/{id}
Löschen DELETE /drive/items/{item-id}/permissions/{id}
Benutzer zu Freigabelink hinzufügen POST /shares/{encoded-sharing-url}/permission/grant
Zuweisungen widerrufen POST /drive/items/{item-id}/permissions/{id}/revokeGrants