Edit

Share via

New-AzureADMSInvitation

  • Reference
Module:
AzureADPreview

This cmdlet is used to invite a new external user to your directory.

Syntax

New-AzureADMSInvitation
   [-InvitedUserDisplayName <String>]
   -InvitedUserEmailAddress <String>
   [-SendInvitationMessage <Boolean>]
   -InviteRedirectUrl <String>
   [-InvitedUser <User>]
   [-InvitedUserMessageInfo <InvitedUserMessageInfo>]
   [-InvitedUserType <String>]
   [<CommonParameters>]

Description

This cmdlet is used to invite a new external user to your directory.

Examples

Invite a new external user to your directory

New-AzureADMSInvitation -InvitedUserEmailAddress someexternaluser@externaldomain.com -SendInvitationMessage $True -InviteRedirectUrl "http://myapps.microsoft.com"

Using the cmdlet in this example, an email is sent to the user who's email address is in the -InvitedUserEmailAddress parameter. When the user accepts the invitation, they are forwarded to the url as specified in the -InviteRedirectUrl parameter

Parameters

-InvitedUser

User object for existing on-prem non-synced guest-user

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

-InvitedUserDisplayName

The display name of the user as it will appear in your directory

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

-InvitedUserEmailAddress

The Email address to which the invitation is sent

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

-InvitedUserMessageInfo

Information to specify how the invitation message is sent.

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

-InvitedUserType

The userType of the user being invited. By default, this is Guest. You can invite as Member if you're are company administrator.

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

-InviteRedirectUrl

The URL to which the invited user is forwarded after accepting the invitation

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

-SendInvitationMessage

A Boolean parameter that indicates whether or not an invitation message will be sent to the invited user.

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

Inputs

None

Outputs

Object