Ressourcentyp Einladung

  • Artikel

Namespace: microsoft.graph

Stellt eine Einladung dar, die zum Hinzufügen externer Benutzer zu einem organization im Rahmen Microsoft Entra B2B-Zusammenarbeit (Microsoft Entra B2B) verwendet wird.

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.

Beim Erstellen einer Einladung wird eine Einlösungs-URL in der Antwort (inviteRedeemUrl) zurückgegeben. 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 auch die Nachricht anpassen, die an den eingeladenen Benutzer gesendet wird. 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 zum Ausführen des Einlösungsprozesses. Der eingeladene Benutzer muss auf den im Kommunikationsschritt gesendeten Link inviteRedeemUrl klicken und den interaktiven Einlösungsprozess in einem Browser durchlaufen. Nach Abschluss wird der eingeladene Benutzer ein externer Benutzer in der Organisation.

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 (!)
  • Nummernzeichen (#)
  • Dollarzeichen ($)
  • Prozentzeichen (%)
  • Zirkumflex (^)
  • Kaufmännisches Und-Zeichen (&)
  • Sternchen (*)
  • Runde Klammern (( ))
  • 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, auch am Anfang oder Ende des Namens.
invitedUserMessageInfo invitedUserMessageInfo Zusätzliche Konfiguration für die Nachricht, die an den eingeladenen Benutzer gesendet wird, einschließlich anpassung des Nachrichtentexts, der Sprache und der CC-Empfängerliste.
invitedUserType Zeichenfolge Der userType des eingeladenen Benutzers. Der Standardwert ist Guest. Sie können einladen, als Member ob Sie ein Unternehmensadministrator sind.
inviteRedirectUrl String Die URL, an die der Benutzer umgeleitet werden soll, nachdem die Einladung eingelöst wurde. Erforderlich.
inviteRedeemUrl Zeichenfolge Die URL, welche der Benutzer zur Einlösung seiner Einladung verwenden können. Schreibgeschützt.
resetRedemption Boolesch Setzen Sie die Einlösung des Benutzers zurück, status und einen Benutzer erneut einzuladen, während seine Benutzer-ID, Gruppenmitgliedschaften und App-Zuweisungen beibehalten werden. Mit dieser Eigenschaft können Sie es einem Benutzer ermöglichen, sich mit einer anderen E-Mail-Adresse als der E-Mail-Adresse in der vorherigen Einladung anzumelden. Weitere Informationen zur Verwendung dieser Eigenschaft finden Sie unter Zurücksetzen der Einlösungs-status 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 sind: PendingAcceptance, Completed, InProgress, und Error.

Beziehungen

Beziehung Typ Beschreibung
invitedUser Benutzer Der Benutzer, der im Rahmen der Einladungserstellung erstellt wurde. Schreibgeschützt
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 zeigt den Ressourcentyp.

{
  "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"
}