Ressourcentyp Einladung

  • Artikel

Namespace: microsoft.graph

Stellt eine Einladung dar, die verwendet wird, um einer Organisation im Rahmen der Microsoft Entra Business-to-Business-Zusammenarbeit (Microsoft Entra B2B) externe Benutzer 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 darstellt, 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 (inviteRedeemUrl) zurückgegeben. Die API zum Erstellen von Einladungen kann automatisch eine E-Mail mit der Einlösungs-URL an den eingeladenen Benutzer senden, indem sendInvitationMessage auf truefestgelegt wird. Sie können auch die Nachricht anpassen, die an den eingeladenen Benutzer gesendet wird. Wenn Sie stattdessen die Einlösungs-URL auf andere Wege senden möchten, können Sie sendInvitationMessage auf false festlegen und die Einlöse-URL aus der Antwort verwenden, um Ihre eigene Kommunikation zu erstellen. Derzeit ist keine API verfügbar, um den Einlösungsprozess durchzuführen. Der eingeladene Benutzer muss den in der Kommunikation gesendeten InviteRedeemUrl-Link auswählen und den interaktiven Einlösungsprozess in einem Browser durchlaufen. Wenn der Prozess abgeschlossen ist, wird der eingeladene Benutzer zu einem externen Benutzer in der Organisation.

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 (!)
  • 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 Enthält die 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 den Einlösungsstatus des Benutzers zurück, und stellen 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 E-Mail-Adresse in der vorherigen Einladung anzumelden. Bei trueist die beziehung "invitedUser/id" erforderlich. Weitere Informationen zur Verwendung dieser Eigenschaft finden Sie unter Zurücksetzen des Einlösungsstatus 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 user Der Benutzer, der im Rahmen der Einladungserstellung erstellt wurde. Schreibgeschützt. Die Id-Eigenschaft ist im Anforderungstext erforderlich, um einen Einlösungsstatus 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 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"
}