Ressourcentyp Einladung

Namespace: microsoft.graph

Wichtig

APIs unter der /beta Version in Microsoft Graph können geändert werden. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in Version 1.0 verfügbar ist, verwenden Sie die Versionsauswahl .

Stellt eine Einladung dar, die verwendet wird, um einer Organisation externe Benutzer hinzuzufügen.

Der Einladungsprozess verwendet den folgenden Ablauf:

• Eine Einladung wird erstellt.
• Eine Einladung (mit einem Einladungs-Link) wird an den eingeladenen Benutzer gesendet.
• 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.
• Der Benutzer wird nach Abschluss der Einlösung zu einer bestimmten Seite umgeleitet.

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.

Hinweis

Der Einladungsstatus wird mithilfe der Eigenschaften externalUserState und externalUserStateChangeDateTime für die externe Benutzerressource nachverfolgt, die als Teil der Einladungsanforderung erstellt wurde.

Methoden

Methode	Rückgabetyp	Beschreibung
Einladung erstellen	invitation	Dient zum Schreiben der Eigenschaften und der Beziehungen des Einladungsobjekts.

Eigenschaften

Eigenschaft	Typ	Beschreibung
invitedUserDisplayName	String	Der Anzeigename des eingeladenen Benutzers.
invitedUserEmailAddress	Zeichenfolge	Die E-Mail-Adresse des eingeladenen Benutzers. Erforderlich. Die folgenden Sonderzeichen sind in der E-Mail-Adresse nicht zulässig: Tilde (~) Ausrufezeichen (!) @-Zeichen (@) Nummernzeichen (#) Dollarzeichen ($) Prozentzeichen (%) Zirkumflex (^) Kaufmännisches Und-Zeichen (&) Sternchen (*) Runde Klammern (( )) Bindestrich (-) Pluszeichen (+) Gleichheitszeichen (=) Klammern ([ ]) Geschweifte Klammern ({ }) Umgekehrter Schrägstrich (\) Schrägstrich (/) Pipe (|) Semikolon (;) Doppelpunkt (:) Anführungszeichen (") Spitze Klammer (< >) Fragezeichen (?) Komma (,) Es gelten aber folgende Ausnahmen: Ein Punkt (.) oder ein Bindestrich (-) ist überall im Benutzernamen zulässig, außer am Anfang oder Ende des Namens. Ein Unterstrich (_) ist überall im Benutzernamen zulässig. Das gilt auch für den Anfang oder das Ende des Namens.
invitedUserMessageInfo	invitedUserMessageInfo	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.
inviteRedirectUrl	String	Die URL, an die der eingeladene Benutzer umgeleitet werden sollte, nachdem die Einladung eingelöst wurde. Erforderlich.
inviteRedeemUrl	Zeichenfolge	Die URL, die Benutzer zur Einlösung einer Einladung verwenden können. Schreibgeschützt.
invitedUserType	Zeichenfolge	Der userType des eingeladenen Benutzers. Der Standardwert ist Guest. Sie können Member einladen, als wären Sie Unternehmensadministrator. Der Standardwert lautet false.
resetRedemption	Boolean	Setzen Sie den Einlösungsstatus des Benutzers zurück, und fügen Sie einen Benutzer erneut ein, während er seine Benutzer-ID, Gruppenmitgliedschaften und App-Zuweisungen beibehält. Mit dieser Eigenschaft können Sie einem Benutzer ermöglichen, sich mit einer anderen E-Mail-Adresse als der in der vorherigen Einladung anzumelden. Weitere Informationen zur Verwendung dieser Eigenschaft finden Sie unter Zurücksetzen des Einlösungsstatus für einen Gastbenutzer (Vorschau).
sendInvitationMessage	Boolean	Gibt an, ob eine E-Mail an den eingeladenen Benutzer gesendet werden soll. Der Standardwert lautet false.
status	String	Der Status der Einladung. Mögliche Werte: PendingAcceptance Completed , , InProgress und Error

Beziehungen

Beziehung	Typ	Beschreibung
invitedUser	user	Der Benutzer, der im Rahmen der Einladungserstellung erstellt wurde. Schreibgeschützt

JSON-Darstellung

Es folgt eine JSON-Darstellung der Ressource.

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