Invoke-MgInviteUserDriveItem

Module:

Microsoft.Graph.Users.Actions

Sends a sharing invitation for a driveItem.A sharing invitation provides permissions to the recipients and optionally sends them an email with a sharing link.

Note

To view the beta release of this cmdlet, view Invoke-MgBetaInviteUserDriveItem

Syntax

Invoke-MgInviteUserDriveItem
      -DriveId <String>
      -DriveItemId <String>
      -UserId <String>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-ExpirationDateTime <String>]
      [-Message <String>]
      [-Password <String>]
      [-Recipients <IMicrosoftGraphDriveRecipient[]>]
      [-RequireSignIn]
      [-RetainInheritedPermissions]
      [-Roles <String[]>]
      [-SendInvitation]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-MgInviteUserDriveItem
      -DriveId <String>
      -DriveItemId <String>
      -UserId <String>
      -BodyParameter <IPaths1F3Q2E6UsersUserIdDrivesDriveIdItemsDriveitemIdMicrosoftGraphInvitePostRequestbodyContentApplicationJsonSchema>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-MgInviteUserDriveItem
      -InputObject <IUsersActionsIdentity>
      [-ResponseHeadersVariable <String>]
      [-AdditionalProperties <Hashtable>]
      [-ExpirationDateTime <String>]
      [-Message <String>]
      [-Password <String>]
      [-Recipients <IMicrosoftGraphDriveRecipient[]>]
      [-RequireSignIn]
      [-RetainInheritedPermissions]
      [-Roles <String[]>]
      [-SendInvitation]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Invoke-MgInviteUserDriveItem
      -InputObject <IUsersActionsIdentity>
      -BodyParameter <IPaths1F3Q2E6UsersUserIdDrivesDriveIdItemsDriveitemIdMicrosoftGraphInvitePostRequestbodyContentApplicationJsonSchema>
      [-ResponseHeadersVariable <String>]
      [-Headers <IDictionary>]
      [-ProgressAction <ActionPreference>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Sends a sharing invitation for a driveItem.A sharing invitation provides permissions to the recipients and optionally sends them an email with a sharing link.

Permissions

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	Files.ReadWrite	Files.ReadWrite.All, Sites.ReadWrite.All
Delegated (personal Microsoft account)	Files.ReadWrite	Files.ReadWrite.All
Application	Files.ReadWrite.All	Sites.ReadWrite.All

Parameters

-AdditionalProperties

Additional Parameters

Type:	Hashtable
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BodyParameter

. To construct, see NOTES section for BODYPARAMETER properties and create a hash table.

Type:	IPaths1F3Q2E6UsersUserIdDrivesDriveIdItemsDriveitemIdMicrosoftGraphInvitePostRequestbodyContentApplicationJsonSchema
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DriveId

The unique identifier of drive

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-DriveItemId

The unique identifier of driveItem

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ExpirationDateTime

.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Headers

Optional headers that will be added to the request.

Type:	IDictionary
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-InputObject

Identity Parameter To construct, see NOTES section for INPUTOBJECT properties and create a hash table.

Type:	IUsersActionsIdentity
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Message

.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Password

.

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProgressAction

{{ Fill ProgressAction Description }}

Type:	ActionPreference
Aliases:	proga
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Recipients

. To construct, see NOTES section for RECIPIENTS properties and create a hash table.

Type:	IMicrosoftGraphDriveRecipient[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RequireSignIn

.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ResponseHeadersVariable

Optional Response Headers Variable.

Type:	String
Aliases:	RHV
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RetainInheritedPermissions

.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Roles

.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SendInvitation

.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UserId

The unique identifier of user

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.Graph.PowerShell.Models.IPaths1F3Q2E6UsersUserIdDrivesDriveIdItemsDriveitemIdMicrosoftGraphInvitePostRequestbodyContentApplicationJsonSchema

Microsoft.Graph.PowerShell.Models.IUsersActionsIdentity

System.Collections.IDictionary

Outputs

Microsoft.Graph.PowerShell.Models.IMicrosoftGraphPermission

Notes

COMPLEX PARAMETER PROPERTIES

To create the parameters described below, construct a hash table containing the appropriate properties. For information on hash tables, run Get-Help about_Hash_Tables.

BODYPARAMETER <IPaths1F3Q2E6UsersUserIdDrivesDriveIdItemsDriveitemIdMicrosoftGraphInvitePostRequestbodyContentApplicationJsonSchema>: .

• [(Any) <Object>]: This indicates any property can be added to this object.
• [ExpirationDateTime <String>]:
• [Message <String>]:
• [Password <String>]:
• [Recipients <IMicrosoftGraphDriveRecipient- []>]:
  • [Alias <String>]: The alias of the domain object, for cases where an email address is unavailable (e.g. security groups).
  • [Email <String>]: The email address for the recipient, if the recipient has an associated email address.
  • [ObjectId <String>]: The unique identifier for the recipient in the directory.
• [RequireSignIn <Boolean?>]:
• [RetainInheritedPermissions <Boolean?>]:
• [Roles <String- []>]:
• [SendInvitation <Boolean?>]:

INPUTOBJECT <IUsersActionsIdentity>: Identity Parameter

• [AuthenticationMethodId <String>]: The unique identifier of authenticationMethod
• [CalendarId <String>]: The unique identifier of calendar
• [ChatId <String>]: The unique identifier of chat
• [ChatMessageId <String>]: The unique identifier of chatMessage
• [ChatMessageId1 <String>]: The unique identifier of chatMessage
• [ContentTypeId <String>]: The unique identifier of contentType
• [DeviceLogCollectionResponseId <String>]: The unique identifier of deviceLogCollectionResponse
• [DocumentSetVersionId <String>]: The unique identifier of documentSetVersion
• [DriveId <String>]: The unique identifier of drive
• [DriveItemId <String>]: The unique identifier of driveItem
• [DriveItemVersionId <String>]: The unique identifier of driveItemVersion
• [EventId <String>]: The unique identifier of event
• [EventId1 <String>]: The unique identifier of event
• [ListItemId <String>]: The unique identifier of listItem
• [ListItemVersionId <String>]: The unique identifier of listItemVersion
• [MailFolderId <String>]: The unique identifier of mailFolder
• [MailFolderId1 <String>]: The unique identifier of mailFolder
• [ManagedDeviceId <String>]: The unique identifier of managedDevice
• [MessageId <String>]: The unique identifier of message
• [NotebookId <String>]: The unique identifier of notebook
• [OnenotePageId <String>]: The unique identifier of onenotePage
• [OnenoteSectionId <String>]: The unique identifier of onenoteSection
• [OnlineMeetingId <String>]: The unique identifier of onlineMeeting
• [PermissionId <String>]: The unique identifier of permission
• [PhoneAuthenticationMethodId <String>]: The unique identifier of phoneAuthenticationMethod
• [SubscriptionId <String>]: The unique identifier of subscription
• [TeamsAppInstallationId <String>]: The unique identifier of teamsAppInstallation
• [TodoTaskId <String>]: The unique identifier of todoTask
• [TodoTaskListId <String>]: The unique identifier of todoTaskList
• [UserId <String>]: The unique identifier of user

RECIPIENTS <IMicrosoftGraphDriveRecipient- []>: .

• [Alias <String>]: The alias of the domain object, for cases where an email address is unavailable (e.g. security groups).
• [Email <String>]: The email address for the recipient, if the recipient has an associated email address.
• [ObjectId <String>]: The unique identifier for the recipient in the directory.

Related Links

• https://learn.microsoft.com/powershell/module/microsoft.graph.users.actions/invoke-mginviteuserdriveitem
• https://learn.microsoft.com/graph/api/driveitem-invite?view=graph-rest-1.0