Merge pull request #5489 from pnp/feat/1895-expiretime

Add expiration date parameter to sharing link commands

Author: gautamdsheth

CHANGELOG.md

@@ -28,6 +28,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 - Added `Set-PnPContainerApplicationPermission` to set the permissions of an application on the containers of a SharePoint Embedded container type registered in the tenant, through Microsoft Graph. [#5488](https://github.com/pnp/powershell/pull/5488)
 - Added `New-PnPContainer` and `Enable-PnPContainer` to create and activate a SharePoint Embedded container through Microsoft Graph. [#5488](https://github.com/pnp/powershell/pull/5488)
 - Added `-Name`, `-Description`, `-OcrEnabled`, `-ItemVersioningEnabled` and `-ItemMajorVersionLimit` to `Set-PnPContainer`, which change those settings of a container through Microsoft Graph. [#5488](https://github.com/pnp/powershell/pull/5488)
+- Added `-ExpirationDateTime` to `Add-PnPFolderUserSharingLink` and `Add-PnPFileUserSharingLink`, so a sharing link for specific people stops working after the given date. [#5484](https://github.com/pnp/powershell/issues/5484)
 - Added `-AllowLegacyAuthProtocolsEnabledSetting`, `-AllowLegacyBrowserAuthProtocolsEnabledSetting`, `-AppAccessInformationBarriersAllowList`, `-AppOnlyBypassPeoplePickerPolicies`, `-BlockAppAccessWithAuthenticationContext`, `-BlockDownloadLinksFileType`, `-BlockUserInfoVisibility`, `-CoreAnyoneSharingLinkMaxExpirationInDays`, `-CoreAnyoneSharingLinkRecommendedExpirationInDays`, `-DefaultContentCenterSite`, `-DefaultLanguageForSiteCreation`, `-DelegateRestrictedAccessControlManagement`, `-DelegateRestrictedContentDiscoverabilityManagement`, `-DisableSharePointStoreAccess`, `-DisableSpfxTopBottomPlaceholdersInElevatedContent`, `-DisableTeamsMeetingRecordingDeletedNotification`, `-EnableAgentWorkerSharingDisclaimer`, `-FilePreviewAllowedDomainList`, `-IsFilePreviewDomainRestrictionEnabled`, `-IsSharePointAddInsBlocked`, `-LimitedAccessFileType`, `-MassDeleteNotificationDisabledForODB`, `-MassDeleteNotificationDisabledForSPO`, `-OneDriveAnyoneSharingLinkMaxExpirationInDays`, `-OneDriveAnyoneSharingLinkRecommendedExpirationInDays`, `-PermissiveBrowserFileHandlingOverride`, `-RemoveVersionExpirationFileTypeOverride`, `-RestrictedAccessControlForOneDriveErrorHelpLink`, `-ReSyncTenantPrivacyProfile`, `-SiteOwnersCanAccessMissingContent`, `-StopAlerts`, `-StopNew2010Workflows`, `-SyncPrivacyProfileProperties`, `-UnlicensedOneDriveAccountsActiveStoragePeriod`, `-WhoCanShareAnonymousAllowList`, `-WhoCanShareAuthenticatedGuestAllowList` and `-Workflows2013Enabled` to `Set-PnPTenant`, and `-DisableWorkflow2010` as an alias of `-Workflow2010Disabled`, matching `Set-SPOTenant`. `Get-PnPTenant` now returns the values of these settings, including `WhoCanShareAnonymousAllowList` and `WhoCanShareAuthenticatedGuestAllowList`, which it always returned empty before. [#5491](https://github.com/pnp/powershell/pull/5491)
 
 ### Changed

documentation/Add-PnPFileUserSharingLink.md

@@ -15,7 +15,7 @@ Creates a sharing link to share a file with a list of specified users.
 ## SYNTAX
 
 ```powershell
-Add-PnPFileUserSharingLink -FileUrl <String> -Type <PnP.Core.Model.Security.ShareType> -Users <String[]> [-Connection <PnPConnection>] 
+Add-PnPFileUserSharingLink -FileUrl <String> -Users <String[]> [-ShareType <PnP.Core.Model.Security.ShareType>] [-ExpirationDateTime <DateTime>] [-Connection <PnPConnection>]
 ```
 
 ## DESCRIPTION
@@ -33,11 +33,18 @@ This will create an user sharing link for `Test.docx` file in the `Shared Docume
 
 ### EXAMPLE 2
 ```powershell
-Add-PnPFileUserSharingLink -FileUrl "/sites/demo/Shared Documents/Test.docx" -Type Edit -Users "john@contoso.onmicrosoft.com","jane@contoso.onmicrosoft.com"
+Add-PnPFileUserSharingLink -FileUrl "/sites/demo/Shared Documents/Test.docx" -ShareType Edit -Users "john@contoso.onmicrosoft.com","jane@contoso.onmicrosoft.com"
 ```
 
 This will create an user sharing link for `Test.docx` file in the `Shared Documents` library which will be editable by specified users in the organization.
 
+### EXAMPLE 3
+```powershell
+Add-PnPFileUserSharingLink -FileUrl "/sites/demo/Shared Documents/Test.docx" -Users "john@contoso.onmicrosoft.com" -ExpirationDateTime (Get-Date).AddDays(15)
+```
+
+This will create an user sharing link for `Test.docx` file in the `Shared Documents` library which will be viewable by the specified user. The link will stop working after 15 days.
+
 ## PARAMETERS
 
 ### -Connection
@@ -54,6 +61,20 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -ExpirationDateTime
+The date and time after which the sharing link stops working. A value without a time zone, such as `(Get-Date).AddDays(15)` or `"2026-12-31 18:00"`, is treated as local time. When not specified, the link does not expire unless an expiration policy applies to the tenant or site.
+
+```yaml
+Type: DateTime
+Parameter Sets: (All)
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -FileUrl
 The file in the site
 

documentation/Add-PnPFolderUserSharingLink.md

@@ -15,7 +15,7 @@ Creates a sharing link to share a folder with a list of specified users.
 ## SYNTAX
 
 ```powershell
-Add-PnPFolderUserSharingLink -Folder <FolderPipeBind> -ShareType <PnP.Core.Model.Security.ShareType> -Users <String[]> [-Connection <PnPConnection>] 
+Add-PnPFolderUserSharingLink -Folder <FolderPipeBind> -Users <String[]> [-ShareType <PnP.Core.Model.Security.ShareType>] [-ExpirationDateTime <DateTime>] [-Connection <PnPConnection>]
 ```
 
 ## DESCRIPTION
@@ -38,6 +38,13 @@ Add-PnPFolderUserSharingLink -Folder "/sites/demo/Shared Documents/Test" -ShareT
 
 This will create an user sharing link for `Test` folder in the `Shared Documents` library which will be editable by specified users in the organization.
 
+### EXAMPLE 3
+```powershell
+Add-PnPFolderUserSharingLink -Folder "/sites/demo/Shared Documents/Test" -Users "john@contoso.onmicrosoft.com" -ExpirationDateTime (Get-Date).AddDays(15)
+```
+
+This will create an user sharing link for `Test` folder in the `Shared Documents` library which will be viewable by the specified user. The link will stop working after 15 days.
+
 ## PARAMETERS
 
 ### -Connection
@@ -54,6 +61,20 @@ Accept pipeline input: False
 Accept wildcard characters: False
 ```
 
+### -ExpirationDateTime
+The date and time after which the sharing link stops working. A value without a time zone, such as `(Get-Date).AddDays(15)` or `"2026-12-31 18:00"`, is treated as local time. When not specified, the link does not expire unless an expiration policy applies to the tenant or site.
+
+```yaml
+Type: DateTime
+Parameter Sets: (All)
+
+Required: False
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
 ### -Folder
 The folder in the site
 

src/Commands/Security/AddFileUserSharingLink.cs

@@ -1,6 +1,7 @@
 using PnP.Core.Model.Security;
 using PnP.Framework.Utilities;
 using PnP.PowerShell.Commands.Model.SharePoint;
+using System;
 using System.Collections.Generic;
 using System.Management.Automation;
 
@@ -19,6 +20,9 @@ public class AddPnPFileUserSharingLink : PnPWebCmdlet
         [Parameter(Mandatory = false)]
         public ShareType ShareType = ShareType.View;
 
+        [Parameter(Mandatory = false)]
+        public DateTime ExpirationDateTime;
+
         protected override void ExecuteCmdlet()
         {
             var serverRelativeUrl = string.Empty;
@@ -52,6 +56,11 @@ protected override void ExecuteCmdlet()
                 Recipients = driveRecipients
             };
 
+            if (ParameterSpecified(nameof(ExpirationDateTime)))
+            {
+                shareLinkRequestOptions.ExpirationDateTime = ExpirationDateTime;
+            }
+
             var share = file.CreateUserSharingLink(shareLinkRequestOptions);
 
             FileSharingLinkResult fileUserSharingLinkResult = new()

src/Commands/Security/AddFolderUserSharingLink.cs

@@ -2,6 +2,7 @@
 using PnP.Core.Model.SharePoint;
 using PnP.PowerShell.Commands.Base.PipeBinds;
 using PnP.PowerShell.Commands.Model.SharePoint;
+using System;
 using System.Collections.Generic;
 using System.Management.Automation;
 
@@ -20,6 +21,9 @@ public class AddFolderUserSharingLink : PnPWebCmdlet
         [Parameter(Mandatory = false)]
         public ShareType ShareType = ShareType.View;
 
+        [Parameter(Mandatory = false)]
+        public DateTime ExpirationDateTime;
+
         protected override void ExecuteCmdlet()
         {
             var serverRelativeUrl = string.Empty;
@@ -43,6 +47,11 @@ protected override void ExecuteCmdlet()
                 Type = ShareType
             };
 
+            if (ParameterSpecified(nameof(ExpirationDateTime)))
+            {
+                shareLinkRequestOptions.ExpirationDateTime = ExpirationDateTime;
+            }
+
             var share = folder.CreateUserSharingLink(shareLinkRequestOptions);
 
             FolderSharingLinkResult folderUserSharingLinkResult = new()