Create Guest User

Create a new invitation that adds an external Office 365 guest user to the organization.

Input

Field Definition Type Required
User
Invited User Display Name The display name of the user being invited. String FALSE
Invited User Email Address The email address of the user being invited. Required. String TRUE
Send Invitation Message true if the an email should be sent to the user; false, otherwise. The default is false. Boolean FALSE
Invite Redirect Url The URL user should be redirected to once the invitation is redeemed. Required. String TRUE
Invited User Type The type of the user being invited. By default, this is Guest. You can invite as Member if you are a company administrator. String FALSE
Invited User Message Info
Cc Recipient Address Additional recipient the invitation message should be sent to. The email address of the person or entity. Currently only 1 additional recipient is supported. String FALSE
Cc Recipient Name Additional recipient the invitation message should be sent to. The display name of the person or entity. String FALSE
Customized Message Body Customized message body you want to send if you don't want the default message. String FALSE
Message Language 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. Other language codes include: ja, sp, and en. See ISO 639-1 language codes. String FALSE

Output

Field Definition Type
User
Invited User Id The unique identifier for the invited user. String
Invitation Id The unique identifier for the invitation. String
Invite Redeem Url The URL that the user can use to redeem their invitation. String
Invited User Display Name The display name of the user being invited. String
Invited User Type The type of the user being invited. By default, this is Guest. String
Invited User Email Address The email address of the user being invited. String
Send Invitation Message true if the an email should be sent to the user; false, otherwise. Boolean
Invite Redirect Url The URL that the user should be redirected to once the invitation is redeemed. String
Status The status of the invitation. Possible values: PendingAcceptance, Completed, InProgress, and Error String
Invited User Message Info Additional configuration for the message being sent to the invited user, including customizing message text, language and cc recipient list. Object
Invited User Message Info
Cc Recipients Additional recipients that the invitation message should be sent to. Includes the email address and name of the recipients. Currently only 1 additional recipient is supported. List of objects
Customized Message Body Customized message body you want to send if you don't want the default message. String
Message Language 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. String

Related topics

Office 365 Admin connector

About the elements of Okta Workflows

Office 365 Admin Management APIs overview