How to Invite Guest Users in Azure Active Directory using PowerShell

1 minute read

Tags: ,

Categories: ,

Updated:

You can invite guest users on your tenant using the Azure Active Directory B2B collaboration. This blog post shows you how to invite guest users using PowerShell.

Installation of AzurePowerShell Modules

Make sure that you have the Azure AD PowerShell for Graph module (AzureADPreview) installed on your machine. Execute the below commands to check if they are already installed and to install them if they are not already installed.

Get-Module -ListAvailable AzureAD*
Import-Module -Name AzureADPreview
Get-Command -Module AzureADPreview

Screenshot of AzureAD Preview PowerShell Module

This is a screenshot of how the results look like. I have the 2.0.1.11 version installed. In case you have the AzureAD module or older versions of the AzureADPreview module installed, check out the docs on how to proceed with the installation.

Show me the Code !!!

Once you have the right PowerShell modules installed, you can go ahead and invite the users using the script below.

The script allows you to

  • Customize the invitation message
  • Specify a Redirect URL
$invitationMessageBody = @"
This is where you enter your custom invitation message.

This can be a multiline message with line breaks.
"@

$invitation = @{ customizedMessageBody = $invitationMessageBody }

Connect-AzureAD -TenantId "your-azure-active-directory-tenant-id"

$users = @("Populate", "your", "list", "of", "emails", "from", "excel", "or", "however", "you", "see", "fit");

For ($i = 0; $i -lt $users.Count; $i++) {

    $currentEmail = $users[$i];

        if ((Get-AzureADUser -SearchString $currentEmail).Length -le 0) {  # User not in AD. Send invite
            New-AzureADMSInvitation -InvitedUserEmailAddress $currentEmail -SendInvitationMessage $true `
                                      -InvitedUserMessageInfo invitation -InviteRedirectUrl "https://www.my-super-fancy-app.com"
        }
}

Using this small script, you can connect to Azure AD and invite new users to the tenant using the Azure Active Directory B2B collaboration via PowerShell.

Cheers 😊😊😊