Envía una invitación para compartir para un driveItem.
Una invitación para uso compartido proporciona permisos a los destinatarios y, de forma opcional, les envía un correo electrónico con un vínculo de uso compartido.
Permisos
Se requiere uno de los permisos siguientes para llamar a esta API. Para obtener más información, incluido cómo elegir permisos, vea Permisos.
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
Cuerpo de solicitud
En el cuerpo de la solicitud, proporcione un objeto JSON con los siguientes parámetros.
Una colección de los destinatarios que recibirán acceso y la invitación para uso compartido.
message
String
Un mensaje con formato de texto sin formato que se incluye en la invitación para uso compartido. La longitud máxima es de 2000 caracteres.
requireSignIn
Booleano
Especifica si el destinatario de la invitación debe iniciar sesión para ver el elemento compartido.
sendInvitation
Boolean
Si esto es así, se envía un vínculo de uso compartido al destinatario. En caso contrario, se otorga un permiso directamente sin enviar ninguna notificación.
roles
Collection(String)
Especifica los roles que se concederán a los destinatarios de la invitación para compartir.
expirationDateTime
DateTimeOffset
Especifica la fecha y hora después de la cual expira el permiso. Para OneDrive para la Empresa y SharePoint, xpirationDateTime solo es aplicable para los permisos sharingLink. Disponible en OneDrive para la Empresa, SharePoint y cuentas de OneDrive personales premium.
password
String
Contraseña establecida en la invitación por el creador. Opcional y solo OneDrive Personal.
retainInheritedPermissions
Booleano
Opcional. Si true es (valor predeterminado), los permisos heredados existentes se conservan en el elemento compartido al compartir este elemento por primera vez. Si falsees , se quitan todos los permisos existentes al compartir por primera vez.
Ejemplo
En este ejemplo se envía una invitación para compartir a un usuario con la dirección de correo electrónico "ryan@contoso.com" con un mensaje sobre un archivo en el que se está colaborando.
La invitación concede a Ryan acceso de lectura y escritura al archivo.
Solicitud HTTP
Si se ejecuta correctamente, este método devuelve el código de respuesta 200 OK y el objeto de colección permission en el cuerpo de la respuesta.
// Code snippets are only available for the latest version. Current version is 5.x
var graphClient = new GraphServiceClient(requestAdapter);
var requestBody = new Microsoft.Graph.Drives.Item.Items.Item.Invite.InvitePostRequestBody
{
Recipients = new List<DriveRecipient>
{
new DriveRecipient
{
Email = "ryan@contoso.com",
},
},
Message = "Here's the file that we're collaborating on.",
RequireSignIn = true,
SendInvitation = true,
Roles = new List<string>
{
"write",
},
Password = "password123",
ExpirationDateTime = "2018-07-15T14:00:00.000Z",
};
var result = await graphClient.Drives["{drive-id}"].Items["{driveItem-id}"].Invite.PostAsync(requestBody);
<?php
// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);
$requestBody = new InvitePostRequestBody();
$recipientsDriveRecipient1 = new DriveRecipient();
$recipientsDriveRecipient1->setEmail('ryan@contoso.com');
$recipientsArray []= $recipientsDriveRecipient1;
$requestBody->setRecipients($recipientsArray);
$requestBody->setMessage('Here\'s the file that we\'re collaborating on.');
$requestBody->setRequireSignIn(true);
$requestBody->setSendInvitation(true);
$requestBody->setRoles(['write', ]);
$requestBody->setPassword('password123');
$requestBody->setExpirationDateTime('2018-07-15T14:00:00.000Z');
$result = $graphServiceClient->drives()->byDriveId('drive-id')->items()->byItemId('driveItem-id')->invite()->post($requestBody);