Ressourcentyp Einladunginvitation resource type

Stellt eine Einladung dar, die verwendet wird, um einer Organisation externe Benutzer hinzuzufügen.Represents an invitation that is used to add external users to an organization.

Der Einladungsprozess verwendet den folgenden Ablauf:The invitation process uses the following flow:

  • Eine Einladung wird erstellt.An invitation is created
  • Eine Einladung (mit einem Einladungs-Link) wird an den eingeladenen Benutzer gesendet.An invitation is sent to the invited user (containing an invitation link)
  • Der eingeladene Benutzer klickt auf den Einladungs-Link, meldet sich an und löst die Einladung und die Erstellung der Benutzerentität ein, die den eingeladenen Benutzer darstellt.The invited user clicks on the invitation link, signs in and redeems the invitation and creation of the user entity representing the invited user completes
  • Der Benutzer wird nach Abschluss der Einlösung zu einer bestimmten Seite umgeleitet.The user is redirected to a specific page after redemption completes

Durch Erstellen einer Einladung wird eine URL für die Einlösung in der Antwort zurückgegeben (InviteRedeemUrl). Die API zum Erstellen der Einladung kann automatisch eine E-Mail mit der Einlösungs-URL an den eingeladenen Benutzer senden, indem sendInvitationMessage auf „true“ festgelegt wird. Sie können die Nachricht, die an den eingeladenen Benutzer gesendet wird, auch anpassen. Wenn Sie die Einlösungs-URL anderweitig versenden möchten, können Sie die sendInvitationMessage auf „false“ festlegen und die Einlösungs-URL aus der Antwort verwenden, um Ihre eigene Mitteilung zu erstellen. Derzeit gibt es keine API, die den Einlösungsprozess durchführt. Der eingeladene Benutzer muss auf den Link inviteRedeemUrl klicken, der in der Mitteilung im Schritt oben versendet wurde, und den interaktiven Einlösungsprozess in einem Browser durchführen. Nach Abschluss wird der eingeladene Benutzer ein externer Benutzer in der Organisation.Creating an invitation will return a redemption URL in the response (inviteRedeemUrl). The create invitation API can automatically send an email containing the redemption URL to the invited user, by setting the sendInvitationMessage to true. You can also customize the message that will be sent to the invited user. Instead, if you wish to send the redemption URL through some other means, you can set the sendInvitationMessage to false and use the redeem URL from the response to craft your own communication. Currently, there is no API to perform the redemption process. The invited user has to click on the inviteRedeemUrl link sent in the communication in the step above, and go through the interactive redemption process in a browser. Once completed, the invited user becomes an external user in the organization.

MethodenMethods

MethodeMethod RückgabetypReturn Type BeschreibungDescription
Einladung erstellenCreate invitation invitationinvitation Dient zum Schreiben der Eigenschaften und der Beziehungen des Einladungsobjekts.Write properties and relationships of invitation object.

EigenschaftenProperties

EigenschaftProperty TypType BeschreibungDescription
invitedUserDisplayNameinvitedUserDisplayName StringString Der Anzeigename des eingeladenen Benutzers.The display name of the user being invited.
invitedUserEmailAddressinvitedUserEmailAddress StringString Die E-Mail-Adresse des eingeladenen Benutzers. Erforderlich. The email address of the user being invited. Required.
invitedUserMessageInfoinvitedUserMessageInfo invitedUserMessageInfoinvitedUserMessageInfo Zusätzliche Konfiguration für die an den eingeladenen Benutzer gesendete Nachricht, einschließlich des Anpassens des Nachrichtentexts, der Sprache und der Empfängerliste in CC.Additional configuration for the message being sent to the invited user, including customizing message text, language and cc recipient list.
sendInvitationMessagesendInvitationMessage BooleanBoolean Gibt an, ob eine E-Mail-Nachricht an den eingeladenen Benutzer gesendet werden soll oder nicht. Der Standardwert ist „false“.Indicates whether an email should be sent to the user being invited or not. The default is false.
inviteRedirectUrlinviteRedirectUrl StringString Die URL, an die der eingeladene Benutzer umgeleitet werden sollte, nachdem die Einladung eingelöst wurde. Erforderlich. The URL user should be redirected to once the invitation is redeemed. Required.
inviteRedeemUrlinviteRedeemUrl StringString Die URL, die der Benutzer zum Einlösen seiner Einladung verwenden kann. SchreibgeschütztThe URL user can use to redeem his invitation. Read-Only
invitedUserTypeinvitedUserType ZeichenfolgeString Der userType des eingeladenen Benutzers.The userType of the user being invited. Standardmäßig ist dieser Wert auf „Gast“ festgelegt.By default, this is Guest. Wenn Sie der Unternehmensadministrator sind, können Sie ihn als „Mitglied“ einladen.You can invite as Member if you are a company administrator.
statusstatus StringString Der Status der Einladung.The status of the invitation. Mögliche Werte: PendingAcceptance, Completed, InProgress und ErrorPossible values: PendingAcceptance, Completed, InProgress, and Error

BeziehungenRelationships

BeziehungRelationship TypType BeschreibungDescription
invitedUserinvitedUser BenutzerUser Der Benutzer, der im Rahmen der Einladungserstellung erstellt wurde. SchreibgeschütztThe user created as part of the invitation creation. Read-Only

JSON-DarstellungJSON representation

Es folgt eine JSON-Darstellung der Ressource.Here is a JSON representation of the resource

{
  "invitedUserDisplayName": "string",
  "invitedUserEmailAddress": "string",
  "invitedUserMessageInfo": {"@odata.type": "microsoft.graph.invitedUserMessageInfo"},
  "sendInvitationMessage": false,
  "inviteRedirectUrl": "string",
  "inviteRedeemUrl": "string",
  "status": "string",
  "invitedUser": {"@odata.type": "microsoft.graph.user"},
  "invitedUserType": "string"
}