Ressourcentyp Einladung

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Stellt eine Einladung dar, die verwendet wird, um externe Benutzer zu einer Organisation im Rahmen der Business-to-Business-Zusammenarbeit (B2B) in Microsoft Entra External ID hinzuzufügen.

Der Einladungsprozess verwendet den folgenden Ablauf:

  • Eine Einladung wird erstellt.
  • Eine Einladung, die einen Einladungslink enthält, wird an den eingeladenen Benutzer gesendet.
  • Der eingeladene Benutzer wählt den Einladungslink aus, meldet sich an und löst die Einladung ein, und die Benutzerentität, die den eingeladenen Benutzer repräsentiert, wird erstellt.
  • Der Benutzer wird nach Abschluss der Einlösung auf eine bestimmte Seite umgeleitet.

Beim Erstellen einer Einladung wird eine Einlösungs-URL in der Antwort zurückgegeben (inviteRedeemUrl). Die API zum Erstellen von Einladungen kann automatisch eine E-Mail mit der Einlösungs-URL an den eingeladenen Benutzer senden, indem sie die sendInvitationMessage auf truesetzt. Sie können auch die Nachricht anpassen, die an den eingeladenen Benutzer gesendet wird. Wenn Sie die Einlöse-URL stattdessen auf andere Weise senden möchten, können Sie die sendInvitationMessagefalse festlegen und die Einlöse-URL aus der Antwort verwenden, um Ihre eigene Kommunikation zu erstellen. Derzeit ist keine API für den Einlösevorgang verfügbar. Der eingeladene Benutzer muss den in der Mitteilung gesendeten Link inviteRedeemUrl auswählen und den interaktiven Einlösevorgang in einem Browser durchlaufen. Nach Abschluss des Vorgangs wird der eingeladene Benutzer ein externer Benutzer in der organization.

Hinweis

Die Einladungs status wird mithilfe der Eigenschaften externalUserState und externalUserStateChangeDateTime für die externe Benutzerressource nachverfolgt, die im Rahmen der Einladungsanforderung erstellt wird.

Methoden

Methode Rückgabetyp Beschreibung
Create invitation Erstellen Sie ein Einladungsobjekt.

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 an jeder Stelle im Benutzernamen zulässig, auch am Anfang oder Ende des Namens.
invitedUserMessageInfo invitedUserMessageInfo Enthält Konfigurationsinformationen für die Nachricht, die an den eingeladenen Benutzer gesendet wird, einschließlich der Anpassung des Nachrichtentextes, der Sprache und der CC-Empfängerliste.
inviteRedirectUrl Zeichenfolge Die URL, an die der eingeladene Benutzer umgeleitet werden sollte, nachdem die Einladung eingelöst wurde. Erforderlich.
inviteRedeemUrl Zeichenfolge Die URL, welche der Benutzer zur Einlösung seiner Einladung verwenden können. Schreibgeschützt.
invitedUserType Zeichenfolge Der userType des eingeladenen Benutzers. Der Standardwert ist Guest. Sie können einladen, als Member wären Sie ein Unternehmensadministrator. Der Standardwert lautet false.
resetRedemption Boolean Setzen Sie die Einlöse status des Benutzers zurück und laden Sie einen Benutzer erneut ein, während Sie seine Benutzer-ID, Gruppenmitgliedschaften und App-Zuweisungen beibehalten. Mit dieser Eigenschaft können Sie es einem Benutzer ermöglichen, sich mit einer anderen E-Mail-Adresse als der in der vorherigen Einladung anzumelden. Wenn true, ist die invitedUser-ID-Beziehung/ erforderlich. Weitere Informationen zur Verwendung dieser Eigenschaft finden Sie unter Zurücksetzen des Status der Einlösung für einen Gastbenutzer.
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, InProgressund Error

Beziehungen

Beziehung Typ Beschreibung
invitedUser user Der Benutzer, der im Rahmen der Einladungserstellung erstellt wurde. Schreibgeschützt. Die id-Eigenschaft ist im Anforderungstext erforderlich, um den Status einer Einlösung zurückzusetzen.
invitedUserSponsors directoryObject collection Die Benutzer oder Gruppen, die Sponsoren des eingeladenen Benutzers sind. Sponsoren sind Benutzer und Gruppen, die für die Berechtigungen von Gastbenutzern im Mandanten und dafür verantwortlich sind, die Informationen und den Zugriff der Gastbenutzer auf dem neuesten Stand zu halten.

JSON-Darstellung

Die folgende JSON-Darstellung veranschaulicht den Ressourcentyp.

{
  "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"
}
  • Last updated on