Skip to content

New-EntraGuestUser

SYNOPSIS

Creates a new guest user in Azure Active Directory.

SYNTAX

New-EntraGuestUser [-EmailAddresses] <Array> [-UseOwnAuth] [<CommonParameters>]

DESCRIPTION

The `New-EntraGuestUser` function creates a new guest user in Azure Active Directory by sending an invitation to the specified email addresses. It supports authentication using an Azure Service Principal or the user's own Azure AD authentication session.

EXAMPLES

EXAMPLE 1

New-EntraGuestUser -EmailAddresses "[email protected]", "[email protected]"

Sends invitations to the specified email addresses using the default authentication session.

EXAMPLE 2

New-EntraGuestUser -EmailAddresses "[email protected]" -UseOwnAuth

Sends an invitation to the specified email address using the user's own Azure AD authentication session.

PARAMETERS

-EmailAddresses

An array of email addresses to which the guest user invitations will be sent.

Type: Array
Parameter Sets: (All)
Aliases:

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

-UseOwnAuth

A switch parameter that, when specified, uses the user's own Azure AD authentication session instead of the default service principal.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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.

INPUTS

OUTPUTS

NOTES