Freigabeeinladung senden
Namespace: microsoft.graph
Sendet eine Freigabeeinladung für ein driveItem -Objekt. Eine Freigabeeinladung stellt Berechtigungen für Empfänger bereit und sendet ihnen optional eine E-Mail-Nachricht mit einem [Freigabelink][].
Berechtigungen
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.
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. |
expirationDateTime | DateTimeOffset | Geben Sie DateTime an, nach dem die Berechtigung abläuft. Verfügbar für OneDrive for Business-, SharePoint- und Premium-konten für persönliche OneDrive. |
password | String | Das Kennwort, das für die Einladung des Erstellers festgelegt wurde. Optional und nur OneDrive Persönlich. |
Beispiel
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. 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" ],
"password": "password123",
"expirationDateTime": "2018-07-15T14:00:00.000Z"
}
Antwort
Nachfolgend sehen Sie ein Beispiel der Antwort.
HTTP/1.1 200 OK
Content-type: application/json
{
"value": [
{
"@deprecated.GrantedTo": "GrantedTo has been deprecated. Refer to GrantedToV2",
"grantedTo": {
"user": {
"displayName": "Robin Danielsen",
"id": "42F177F1-22C0-4BE3-900D-4507125C5C20"
}
},
"grantedToV2": {
"user": {
"id": "42F177F1-22C0-4BE3-900D-4507125C5C20",
"displayName": "Robin Danielsen"
},
"siteUser": {
"id": "1",
"displayName": "Robin Danielsen",
"loginName": "Robin Danielsen"
}
},
"hasPassword": true,
"id": "CCFC7CA3-7A19-4D57-8CEF-149DB9DDFA62",
"invitation": {
"email": "robin@contoso.com",
"signInRequired": true
},
"roles": [ "write" ],
"expirationDateTime": "2018-07-15T14:00:00.000Z"
}
]
}
Hinweise
- Laufwerke mit dem driveType
personal
(OneDrive Personal) können keine Berechtigungen am Stamm-DriveItem erstellen oder ändern. - Eine Liste der verfügbaren Rollen finden Sie unter Rolleneigenschaftenwerte.
Fehlerantworten
Weitere Informationen dazu, wie Fehler zurückgegeben werden, finden Sie im Thema Fehlerantworten.
Feedback
Feedback senden und anzeigen für