Skip to main content

entra user guest add

Invite an external user to the organization


m365 entra user guest add [options]


m365 aad user guest add [options]


--emailAddress <emailAddress>

The email address of the user.

--displayName [displayName]

The display name of the user.

--inviteRedirectUrl [inviteRedirectUrl]

The URL the user should be redirected to once the invitation is redeemed. If not specified, default URL will be set.

--welcomeMessage [welcomeMessage]

Personal welcome message which will be added to the email along with the default email.

--ccRecipients [ccRecipients]

Additional recipients the invitation message should be sent to. Currently only 1 additional recipient is supported.

--messageLanguage [messageLanguage]

The language you want to send the default message in. The language format should be in ISO 639. The default is en-US.


Indicates whether an email should be sent to the user.

-h, --help [help]

Output usage information. Optionally, specify which section of command's help you want to see. Allowed values are options, examples, remarks, response, full. Default is options.

--query [query]

JMESPath query string. See for more information and examples.

-o, --output [output]

Output type. json, text, csv, md, none. Default json.


Runs command with verbose logging.


Runs command with debug logging.


Invite a user via email and set the display name

m365 entra user guest add --emailAddress --displayName "John Doe" --sendInvitationMessage

Invite a user with a custom email and custom redirect url

m365 entra user guest add --emailAddress --welcomeMessage "Hi John, welcome to the organization!" --inviteRedirectUrl --sendInvitationMessage

Invite a user and send an invitation mail in Dutch

m365 entra user guest add --emailAddress --messageLanguage nl-BE --sendInvitationMessage


"id": "35f7f726-c541-4aef-a64e-a7b6868fe47f",
"inviteRedeemUrl": "",
"invitedUserDisplayName": "John Doe",
"invitedUserType": "Guest",
"invitedUserEmailAddress": "",
"sendInvitationMessage": true,
"resetRedemption": false,
"inviteRedirectUrl": "",
"status": "PendingAcceptance",
"invitedUserMessageInfo": {
"messageLanguage": "en-US",
"customizedMessageBody": "Hi John, welcome to the organization!",
"ccRecipients": [
"emailAddress": {
"name": null,
"address": ""
"invitedUser": {
"id": "5257b5b2-4056-4a45-a05e-df5c92d53e6e"