Freigabeeinladung senden

Sendet eine Freigabeeinladung für ein DriveItem-Element. Eine Freigabeeinladung stellt Berechtigungen für Empfänger bereit und sendet ihnen optional eine E-Mail-Nachricht mit einem Freigabelink.

Berechtigungen

Eine der folgenden Berechtigungen ist erforderlich, um diese API aufzurufen. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie unter Berechtigungen.

Berechtigungstyp	Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)
Delegiert (Geschäfts-, Schul- oder Unikonto)	Files.ReadWrite, Files.ReadWrite.All, Sites.ReadWrite.All
Delegiert (persönliches Microsoft-Konto)	Files.ReadWrite, Files.ReadWrite.All
Anwendung	Files.ReadWrite.All, Sites.ReadWrite.All

HTTP-Anforderung

POST /drives/{drive-id}/items/{item-id}/invite
POST /groups/{group-id}/drive/items/{item-id}/invite
POST /me/drive/items/{item-id}/invite
POST /sites/{siteId}/drive/items/{itemId}/invite
POST /users/{userId}/drive/items/{itemId}/invite

Anforderungstext

Geben Sie im Anforderungstext ein JSON-Objekt mit den folgenden Parametern an.

{
  "requireSignIn": false,
  "sendInvitation": false,
  "roles": [ "read | write"],
  "recipients": [
    { "@odata.type": "microsoft.graph.driveRecipient" },
    { "@odata.type": "microsoft.graph.driveRecipient" }
  ],
  "message": "string"
}

Parameter	Typ	Beschreibung
recipients	Collection(DriveRecipient)	Eine Sammlung der Empfänger, die Zugriff und die Freigabeeinladung erhalten.
message	String	Eine formatierte Nur-Text-Nachricht, die in der Freigabeeinladung enthalten ist. Die maximale Länge beträgt 2000 Zeichen.
requireSignIn	Boolescher Wert	Gibt an, ob der Empfänger der Einladung sich anmelden muss, um auf das freigegebene Element zuzugreifen.
sendInvitation	Boolescher Wert	Bei „wahr“ wird ein Freigabelink an den Empfänger gesendet. Andernfalls wird direkt eine Berechtigung erteilt, ohne dass eine Benachrichtigung gesendet wird.
roles	Collection(String)	Gibt die Rollen an, die den Empfängern der Freigabeeinladung erteilt werden.

Beispiel

In diesem Beispiel wird eine Freigabeeinladung an einen Benutzer mit der E-Mail-Adresse "ryan@contoso.com" mit einer Nachricht über eine Datei gesendet, an der mitgearbeitet wird. Die Einladung gewährt Ryan Lese-/ Schreibzugriff auf die Datei.

HTTP-Anforderung

Wenn die Methode erfolgreich verläuft, werden der Antwortcode 200 OK und das permission-Sammlungsobjekt im Antworttext zurückgegeben.

POST /me/drive/items/{item-id}/invite
Content-type: application/json

{
  "recipients": [
    {
      "email": "ryan@contoso.com"
    }
  ],
  "message": "Here's the file that we're collaborating on.",
  "requireSignIn": true,
  "sendInvitation": true,
  "roles": [ "write" ]
}

Antwort

Nachfolgend sehen Sie ein Beispiel der Antwort.

HTTP/1.1 200 OK
Content-type: application/json

{
  "value": [
    {
      "grantedTo": {
        "user": {
          "displayName": "Ryan Gregg",
          "id": "42F177F1-22C0-4BE3-900D-4507125C5C20"
        }
      },
      "id": "CCFC7CA3-7A19-4D57-8CEF-149DB9DDFA62",
      "invitation": {
        "email": "ryan@contoso.com",
        "signInRequired": true
      },
      "roles": [ "write" ]
    }
  ]
}

Hinweise

• Laufwerke mit demdriveTypepersonal (OneDrive Personal) können keine Berechtigungen am Stamm-DriveItem erstellen oder ändern.
• Eine Liste der verfügbaren Rollen finden Sie unter Rollenaufzählung.

Fehlerantworten

Weitere Informationen dazu, wie Fehler zurückgegeben werden, finden Sie im Thema Fehlerantworten.