Freigabeeinladung sendenSend a sharing invitation

Namespace: microsoft.graphNamespace: microsoft.graph

Sendet eine Freigabeeinladung für eine driveItem.Sends a sharing invitation for a driveItem. Eine Freigabeeinladung stellt Berechtigungen für Empfänger bereit und sendet ihnen optional eine E-Mail-Nachricht mit einem [Freigabelink][].A sharing invitation provides permissions to the recipients and optionally sends them an email with a sharing link.

BerechtigungenPermissions

Eine der nachfolgenden Berechtigungen ist erforderlich, um diese API aufrufen zu können. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie im Artikel zum Thema Berechtigungen.One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

BerechtigungstypPermission type Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten)Permissions (from least to most privileged)
Delegiert (Geschäfts-, Schul- oder Unikonto)Delegated (work or school account) Files.ReadWrite, Files.ReadWrite.All, Sites.ReadWrite.AllFiles.ReadWrite, Files.ReadWrite.All, Sites.ReadWrite.All
Delegiert (persönliches Microsoft-Konto)Delegated (personal Microsoft account) Files.ReadWrite, Files.ReadWrite.AllFiles.ReadWrite, Files.ReadWrite.All
AnwendungApplication Files.ReadWrite.All, Sites.ReadWrite.AllFiles.ReadWrite.All, Sites.ReadWrite.All

HTTP-AnforderungHTTP request

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

AnforderungstextRequest body

Geben Sie im Anforderungstext ein JSON-Objekt mit den folgenden Parametern an.In the request body, provide a JSON object with the following parameters.

{
  "requireSignIn": false,
  "sendInvitation": false,
  "roles": [ "read | write"],
  "recipients": [
    { "@odata.type": "microsoft.graph.driveRecipient" },
    { "@odata.type": "microsoft.graph.driveRecipient" }
  ],
  "message": "string"
}
ParameterParameter TypType BeschreibungDescription
recipientsrecipients Collection(DriveRecipient)Collection(DriveRecipient) Eine Sammlung der Empfänger, die Zugriff und die Freigabeeinladung erhalten.A collection of recipients who will receive access and the sharing invitation.
messagemessage StringString Eine formatierte Nur-Text-Nachricht, die in der Freigabeeinladung enthalten ist. Die maximale Länge beträgt 2000 Zeichen.A plain text formatted message that is included in the sharing invitation. Maximum length 2000 characters.
requireSignInrequireSignIn BooleanBoolean Gibt an, ob der Empfänger der Einladung sich anmelden muss, um auf das freigegebene Element zuzugreifen.Specifies whether the recipient of the invitation is required to sign-in to view the shared item.
sendInvitationsendInvitation Boolescher WertBoolean Bei „wahr“ wird ein [Freigabelink][] an den Empfänger gesendet.If true, a sharing link is sent to the recipient. Andernfalls wird direkt eine Berechtigung erteilt, ohne dass eine Benachrichtigung gesendet wird.Otherwise, a permission is granted directly without sending a notification.
rolesroles Collection(String)Collection(String) Gibt die Rollen an, die den Empfängern der Freigabeeinladung erteilt werden.Specify the roles that are to be granted to the recipients of the sharing invitation.
expirationDateTimeexpirationDateTime DateTimeOffsetDateTimeOffset Geben Sie die DateTime an, nach der die Berechtigung abläuft.Specify the DateTime after which the permission expires. Verfügbar auf OneDrive für Unternehmen-, SharePoint-und Premium-persönlichen OneDrive-Konten.Available on OneDrive for Business, SharePoint, and premium personal OneDrive accounts.
passwordpassword StringString Das für die Einladung vom Ersteller festgelegte Kennwort.The password set on the invite by the creator. Optional und OneDrive nur persönlich.Optional and OneDrive Personal only.

BeispielExample

In diesem Beispiel wird eine Einladung zur Freigabe an einen Benutzer mit der E-Mail-Adresse "ryan@contoso.com" versandt, in der dieser über eine Datei für die Zusammenarbeit benachrichtigt wird.This example sends a sharing invitation to a user with email address "ryan@contoso.com" with a message about a file being collaborated on. Die Einladung gewährt Ryan Lese-/ Schreibzugriff auf die Datei.The invitation grants Ryan read-write access to the file.

HTTP-AnforderungHTTP request

Wenn die Methode erfolgreich verläuft, werden der Antwortcode 200 OK und das permission-Sammlungsobjekt im Antworttext zurückgegeben.If successful, this method returns 200 OK response code and permission collection object in the response body.

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" ],
  "password": "password123",
  "expirationDateTime": "2018-07-15T14:00:00.000Z"
}

AntwortResponse

Nachfolgend sehen Sie ein Beispiel der Antwort.Here is an example of the response.

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

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

HinweiseRemarks

  • Laufwerke mit demdriveTypepersonal (OneDrive Personal) können keine Berechtigungen am Stamm-DriveItem erstellen oder ändern.Drives with a driveType of personal (OneDrive personal) cannot create or modify permissions on the root DriveItem.
  • Eine Liste der verfügbaren Rollen finden Sie unter roles-Eigenschaftswerte.For a list of available roles, see roles property values.

FehlerantwortenError responses

Weitere Informationen dazu, wie Fehler zurückgegeben werden, finden Sie im Thema Fehlerantworten.Read the Error Responses topic for more information about how errors are returned.