Invite guest users with PowerShell using a custom email template
There are many ways to invite guest users to your Azure Active Directory. For example directly from the Azure Portal or by adding a guest to Microsoft Teams, if you have guest access enabled.
When you invite a new guest user directly from the Azure Portal, the invitee will receive an email invitation that looks like this:
Most of your users probably don’t even know what Azure Active Directory is. It could be that you are trying to educate your end users about email safety. To them, these emails seem ‘phishy’.
As an organization, you may want to consider inviting guests using a company branded email template. Sounds nice? Here’s how!
How to
- Download the New-CustomAzureADMSInvitation.ps1 script from the TechNet Gallery;
- Make sure you have the AzureAD module installed;
- Modify the $MailMessageProperties configuration to your needs;
$MailMessageProperties = @{ To = $InvitedUserEmailAddress From = "Jane Doe <noreply@domain.com>" Subject = "You're invited to the $($AzureADTenantDetail.DisplayName) organization" SmtpServer = "smtp.office365.com" Credential = $Credential Port = 587 } - Customize the HTML email template specified in the $MailBody variable;
Note: The script on TechNet contains a basic HTML template which you are free to customize.$MailBody = @" <html> <body> <table align="center" style="width:600px;"> <a href="$($AzureADMSInvitation.InviteRedeemUrl)">Click here to accept the invitation</a>. </table> </body> </html> "@ - Now you can run the script to invite guests to your Azure Active Directory!
New-CustomAzureADMSInvitation.ps1 -InvitedUserDisplayName "John Doe" ` -InvitedUserEmailAddress "john.doe@outlook.com" ` -InviteRedirectUrl "http://myapps.onmicrosoft.com" ` -InviteMessage "Are you coming to my tea party?"
Result
That’s it! You are now sending invites with PowerShell to external guest users using a custom email template. If you are using the basic HTML template provided in the script, the output will result in something like this:
