New-EntraInvitation

New-EntraInvitation

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

Dieses Cmdlet wird verwendet, um einen neuen externen Benutzer in Ihr Verzeichnis einzuladen.

Einladung fügt der Organisation einen externen Benutzer hinzu. Beim Erstellen einer neuen Einladung stehen ihnen mehrere Optionen zur Verfügung:

• Bei der Einladungserstellung kann Microsoft Graph automatisch eine Einladungs-E-Mail direkt an den eingeladenen Benutzer senden, oder Ihre App kann die in der Antwort zurückgegebene inviteRedeemUrl verwenden, um Ihre eigene Einladung (über Ihren Kommunikationsmechanismus der Wahl) an den eingeladenen Benutzer zu erstellen. Wenn Sie Microsoft Graph eine Einladungs-E-Mail automatisch senden möchten, können Sie den Inhalt und die Sprache der E-Mail mithilfe von invitedUserMessageInfo angeben.

• Wenn der Benutzer eingeladen wird, wird eine Benutzerentität (userType Guest) erstellt und kann verwendet werden, um den Zugriff auf Ressourcen zu steuern. Der eingeladene Benutzer muss den Einlösungsprozess durchlaufen, um auf alle Ressourcen zuzugreifen, zu denen er eingeladen wurde.

Um den Einlösungsstatus für einen Gastbenutzer zurückzusetzen, ist die Berechtigung "User.ReadWrite.All" mindestens erforderlich.

Für delegierte Szenarien muss der angemeldete Benutzer über mindestens eine der folgenden Rollen verfügen:

• Gasteinladender
• Verzeichnisautoren
• Benutzeradministrator

Um den Einlösungsstatus zurückzusetzen, muss der angemeldete Benutzer über folgendes verfügen:

• Helpdesk-Administrator
• Rolle "Benutzeradministrator"

Connect-Entra -Scopes 'User.Invite.All'
$emailAddress = 'someexternaluser@externaldomain.com'
$sendInvitationMessage = $True
$redirectUrl = 'https://myapps.contoso.com'
New-EntraInvitation -InvitedUserEmailAddress $emailAddress -SendInvitationMessage $sendInvitationMessage -InviteRedirectUrl $redirectUrl

Id                                   InviteRedeemUrl
--                                   ---------------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb https://login.microsoftonline.com/redeem?rd=https%3a%2f%2finvitations.microsoft.com%2fredeem%2f%3ftenant%3dd5aec55f-2d12-4442-8d2f-cc…

In diesem Beispiel wurde eine E-Mail an den Benutzer gesendet, der sich in der E-Mail-Adresse des -InvitedUserEmailAddress Parameters befindet.

Wenn der Benutzer die Einladung akzeptiert, wird er wie im -InviteRedirectUrl Parameter angegeben an die URL weitergeleitet.

• -SendInvitationMessage Der Parameter gibt an, ob eine Einladungsnachricht an den eingeladenen Benutzer gesendet wird.

Connect-Entra -Scopes 'User.Invite.All'
$emailAddress = 'someexternaluser@externaldomain.com'
$sendInvitationMessage = $True
$redirectUrl = 'https://myapps.onmicrosoft.com'
$displayName = 'microsoftuser'
New-EntraInvitation -InvitedUserEmailAddress $emailAddress -SendInvitationMessage $sendInvitationMessage -InviteRedirectUrl $redirectUrl -InvitedUserDisplayName $displayName

Id                                   InviteRedeemUrl
--                                   ---------------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb https://login.microsoftonline.com/redeem?rd=https%3a%2f%2finvitations.microsoft.com%2fredeem%2f%3ftenant%3dd5aec55f-2d12-4442-8d2f-cc…

In diesem Beispiel wird veranschaulicht, wie Ein neuer externer Benutzer mit -InvitedUserDisplayName Parameter in Ihr Verzeichnis eingeladen wird.

• -InvitedUserEmailAddressDer Parameter gibt die E-Mail-Adresse an, an die die Einladung gesendet wird.
• -SendInvitationMessage Parameter gibt an, ob eine Einladungsnachricht an den eingeladenen Benutzer gesendet wird.
• -InviteRedirectUrl Der Parameter gibt die URL an, an die der eingeladene Benutzer weitergeleitet wird, nachdem die Einladung akzeptiert wurde.
• -InvitedUserDisplayNameDer Parameter gibt den Anzeigenamen des Benutzers an.

Connect-Entra -Scopes 'User.Invite.All'
$a= New-Object Microsoft.Open.MSGraph.Model.InvitedUserMessageInfo
$a.CustomizedMessageBody = 'Hi there, how are you'
$a.MessageLanguage = 'EN'
$params = @{
    InvitedUserEmailAddress = 'someexternaluser@externaldomain.com'
    SendInvitationMessage = $True
    InviteRedirectUrl = 'https://myapps.microsoft.com'
    InvitedUserMessageInfo = $a
}

New-EntraInvitation @params

Id                                   InviteRedeemUrl
--                                   ---------------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb https://login.microsoftonline.com/redeem?rd=https%3a%2f%2finvitations.microsoft.com%2fredeem%2f%3ftenant%3dd5aec55f-2d12-4442-8d2f-cc…

In diesem Beispiel wird veranschaulicht, wie Sie einen neuen externen Benutzer mit dem Parameter "InviteUserMessageInfo" zu Ihrem Verzeichnis einladen.

• -InvitedUserEmailAddressDer Parameter gibt die E-Mail-Adresse an, an die die Einladung gesendet wird.
• -SendInvitationMessage Der Parameter gibt an, ob eine Einladungsnachricht an den eingeladenen Benutzer gesendet wird.
• -InviteRedirectUrl Der Parameter gibt die URL an, an die der eingeladene Benutzer weitergeleitet wird, nachdem die Einladung akzeptiert wurde.
• -InvitedUserMessageInfoDer Parameter gibt zusätzliche Informationen an, um anzugeben, wie die Einladungsnachricht gesendet wird.

Connect-Entra -Scopes 'User.Invite.All'
$emailAddress = 'someexternaluser@externaldomain.com'
$sendInvitationMessage = $True
$redirectUrl = 'https://myapps.onmicrosoft.com'
$userType = 'Guest'
New-EntraInvitation -InvitedUserEmailAddress $emailAddress -SendInvitationMessage $sendInvitationMessage -InviteRedirectUrl $redirectUrl -InvitedUserType $userType

Id                                   InviteRedeemUrl
--                                   ---------------
9e2b9f02-c2cb-4832-920d-81959f44e397 https://login.microsoftonline.com/redeem?rd=https%3a%2f%2finvitations.microsoft.com%2fredeem%2f%3ftenant%3dd5aec55f-2d12-4442-8d2f-cc…

In diesem Beispiel wird veranschaulicht, wie Sie einen neuen externen Benutzer mit dem Parameter "InviteUserType" in Ihr Verzeichnis einladen.

Connect-Entra -Scopes 'User.Invite.All'
$emailAddress = 'someexternaluser@externaldomain.com'
$sendInvitationMessage = $True
$redirectUrl = 'https://myapps.constoso.com'
$displayName = 'microsoftuser'
New-EntraInvitation -InvitedUserEmailAddress $emailAddress -SendInvitationMessage $sendInvitationMessage -InviteRedirectUrl $redirectUrl -InvitedUserDisplayName $displayName -ResetRedemption

Id                                   InviteRedeemUrl
--                                   ---------------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb https://login.microsoftonline.com/redeem?rd=https%3a%2f%2finvitations.microsoft.com%2fredeem%2f%3ftenant%3dd5aec55f-2d12-4442-8d2f-cc…

In diesem Beispiel wird gezeigt, wie ein Administrator die Einlösung für einen externen Benutzer im -InvitedUser Parameter zurücksetzen kann. Sie müssen den Schalter -ResetRedemptionübergeben. Nach dem Zurücksetzen muss der externe Benutzer die Einladung erneut einlösen, um weiterhin auf die Ressourcen zuzugreifen.

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

• Weitere Informationen https://learn.microsoft.com/graph/api/invitation-post- .