Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
142 lines (106 sloc) 3.19 KB
external help file online version schema ms.reviewer ms.custom
Microsoft.Open.MS.GraphV10.PowerShell.dll-Help.xml
2.0.0
rodejo
iamfeature=PowerShell

New-AzureADMSInvitation

SYNOPSIS

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

SYNTAX

New-AzureADMSInvitation [-InvitedUserDisplayName <String>] -InvitedUserEmailAddress <String>
 [-SendInvitationMessage <Boolean>] -InviteRedirectUrl <String>
 [-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.onmicrosoft.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

-InvitedUserDisplayName

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

Type: String
Parameter Sets: (All)
Aliases: 

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

-InvitedUserEmailAddress

The Email address to which the invitation is sent

Type: String
Parameter Sets: (All)
Aliases: 

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

-InvitedUserMessageInfo

Addition information to specify how the invitation message is sent

Type: InvitedUserMessageInfo
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases: 

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

-InviteRedirectUrl

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

Type: String
Parameter Sets: (All)
Aliases: 

Required: True
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases: 

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

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

None

OUTPUTS

System.Object

NOTES

RELATED LINKS

You can’t perform that action at this time.