New-EntraBetaInvitation
This cmdlet is used to invite a new external user to your directory
Syntax
Default (Default)
New-EntraBetaInvitation
[-InvitedUser <User>]
[-InvitedUserMessageInfo <InvitedUserMessageInfo>]
[-InvitedUserType <String>]
[-SendInvitationMessage <Boolean>]
-InvitedUserEmailAddress <String>
[-ResetRedemption]
[-InvitedUserDisplayName <String>]
-InviteRedirectUrl <String>
[<CommonParameters>]
Description
This cmdlet is used to invite a new external user to your directory.
Invitation adds an external user to the organization. When creating a new invitation, you have several options available:
On invitation creation, Microsoft Graph can automatically send an invitation email directly to the invited user, or your app can use the inviteRedeemUrl returned in the response to craft your own invitation (through your communication mechanism of choice) to the invited user. If you decide to have Microsoft Graph send an invitation email automatically, you can specify the content and language of the email by using invitedUserMessageInfo.
When the user is invited, a user entity (of userType Guest) is created and can be used to control access to resources. The invited user has to go through the redemption process to access any resources they have been invited to.
To reset the redemption status for a guest user, the User.ReadWrite.All permission is the minimum required.
For delegated scenarios, the signed-in user must have at least one of the following roles:
- Guest Inviter
- Directory Writers
- User Administrator
Additionally, to reset the redemption status, the signed-in user must have the:
- Helpdesk Administrator
- User Administrator role
Parameters
-InvitedUser
An existing user object in the directory that you want to add or update the B2B credentials for.
Parameter properties
| Type: | User |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InvitedUserDisplayName
The display name of the user as it appears in your directory.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InvitedUserEmailAddress
The Email address to which the invitation is sent.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InvitedUserMessageInfo
Addition information to specify how the invitation message is sent.
Parameter properties
| Type: | InvitedUserMessageInfo |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InvitedUserType
The userType of the user being invited. By default, this is Guest.
You can invite as Member if you are company administrator.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InviteRedirectUrl
The URL to which the invited user is forwarded after accepting the invitation.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ResetRedemption
Indicates whether the invite redemption on an existing external user should be removed so the user can re-redeem the account.
By default, this is false and should only be set when passing in a valid external user to the InvitedUser property.
Parameter properties
| Type: | System.Management.Automation.SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SendInvitationMessage
A Boolean parameter that indicates whether or not an invitation message will be sent to the invited user.
Parameter properties
| Type: | System.Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
Outputs
System.Object
Notes
- See more information - /graph/api/invitation-post.