User.Invite.All
Allows the app to invite guest users to the organization, on behalf of the signed-in user.
Graph Methods
Type: A = Application Permission, D = Delegate Permission
Delegate Permission
|
|
Id |
63dd7cd9-b489-4adf-a28c-ac38b9a0f962 |
Consent Type |
Admin |
Display String |
Invite guest users to the organization |
Description |
Allows the app to invite guest users to the organization, on behalf of the signed-in user. |
Application Permission
|
|
Id |
09850681-111b-4a89-9bed-3f2cae46d706 |
Display String |
Invite guest users to the organization |
Description |
Allows the app to invite guest users to the organization, without a signed-in user. |
Resources
Property |
Type |
Description |
invitedUserDisplayName |
String |
The display name of the user being invited. |
invitedUserEmailAddress |
String |
The email address of the user being invited. Required. The following special characters are not permitted in the email address:
- Tilde (
~ ) - Exclamation point (
! ) - Number sign (
# ) - Dollar sign (
$ ) - Percent (
% ) - Circumflex (
^ ) - Ampersand (
& ) - Asterisk (
* ) - Parentheses (
( ) ) - Plus sign (
+ ) - Equal sign (
= ) - Brackets (
[ ] ) - Braces (
{ } ) - Backslash (
\ ) - Slash mark (
/ ) - Pipe (
\| ) - Semicolon (
; ) - Colon (
: ) - Quotation marks (
" ) - Angle brackets (
< > ) - Question mark (
? ) - Comma (
, )
However, the following exceptions apply:
- A period (
. ) or a hyphen (- ) is permitted anywhere in the user name, except at the beginning or end of the name. - An underscore (
_ ) is permitted anywhere in the user name. This includes at the beginning or end of the name.
|
invitedUserMessageInfo |
invitedUserMessageInfo |
Additional configuration for the message being sent to the invited user, including customizing message text, language and cc recipient list. |
invitedUserType |
String |
The userType of the user being invited. By default, this is Guest . You can invite as Member if you are a company administrator. |
inviteRedirectUrl |
String |
The URL the user should be redirected to once the invitation is redeemed. Required. |
inviteRedeemUrl |
String |
The URL the user can use to redeem their invitation. Read-only. |
resetRedemption |
Boolean |
Reset the user's redemption status and reinvite a user while retaining their user identifier, group memberships, and app assignments. This property allows you to enable a user to sign-in using a different email address from the one in the previous invitation. For more information about using this property, see Reset redemption status for a guest user. |
sendInvitationMessage |
Boolean |
Indicates whether an email should be sent to the user being invited. The default is false . |
status |
String |
The status of the invitation. Possible values are: PendingAcceptance , Completed , InProgress , and Error . |
Property |
Type |
Description |
ccRecipients |
Recipient collection |
Additional recipients the invitation message should be sent to. Currently only 1 additional recipient is supported. |
customizedMessageBody |
String |
Customized message body you want to send if you don't want the default message. |
messageLanguage |
String |
The language you want to send the default message in. If the customizedMessageBody is specified, this property is ignored, and the message is sent using the customizedMessageBody. The language format should be in ISO 639. The default is en-US. |