Nutzereinladungen erstellen und verwalten

Auf dieser Seite wird erläutert, wie Sie einige grundlegende Vorgänge mit der Cloud Identity User Invitation API ausführen.

Hinweis

Hinweis: Bevor Sie eine der Cloud Identity APIs verwenden können, müssen Sie Cloud Identity einrichten. Eine Anleitung finden Sie unter Cloud Identity einrichten.

Führen Sie folgende Aufgaben aus, bevor Sie die Informationen auf dieser Seite umsetzen:

• Weitere Informationen finden Sie in der Übersicht zur User Invitation API.
• Richten Sie die User Invitation API ein.

Voraussetzungen für die Einladung

Wie in der Übersicht erwähnt, muss ein Nutzerkonto mehrere Kriterien erfüllen. Mit der Methode IsInvitableUser() können Sie herausfinden, ob ein bestimmtes Nutzerkonto infrage kommt.

REST

Rufen Sie customers.userinvitations.isInvitableUser() mit der Kundennummer und der E-Mail-Adresse des Kontos auf, um die Berechtigung eines Nutzerkontos zu prüfen.

Beispielanfrage

GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[e-mail]:isInvitableUser

Nutzereinladungen abrufen

Die User Invitation API bietet Methoden zum Abrufen einer einzelnen Nutzereinladung und zum Abrufen aller Einladungen. Wenn Sie alle Nutzereinladungen abrufen, können Sie sie optional nach Status filtern und die Sortierreihenfolge festlegen.

Einladung für einen einzelnen Nutzer abrufen

REST

Rufen Sie customers.userinvitations.get() mit der Kundennummer und der E-Mail-Adresse des Kontos auf, um eine einzelne Nutzereinladungen abzurufen.

Beispielanfrage

GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[e-mail]

Liste mit Nutzereinladungen abrufen

Alle nicht verwalteten Nutzer werden automatisch als Einladungen im Status NOT_YET_SENT angezeigt, bis entweder der Administrator oder der Endbenutzer etwas anderes unternimmt. Sobald eine Einladung vom Nutzer akzeptiert wurde, wird das Konto nicht mehr als nicht verwaltet betrachtet.

• Wenn Sie customers.userinvitations.list() mit dem Status in der Anfrage aufrufen, werden nur Nutzer zurückgegeben, deren Einladung in diesem Status ist.
• Wenn Sie customers.userinvitations.list() ohne den Status in der Anfrage aufrufen, werden alle Nutzereinladungen zurückgegeben.

Sie können nach mehreren Status suchen, indem Sie dem Filter den Operator or hinzufügen: state=='accepted'||state=='declined'

REST

Wenn Sie eine Liste der Gästeeinladungen abrufen möchten, rufen Sie customers.userinvitations.list() mit der Kundennummer und allen gewünschten Abfrageparametern auf, um die Ergebnisse zu filtern, zu sortieren und paginieren. Im folgenden Beispiel wird eine Liste aller nicht verwalteten Nutzer zurückgegeben, sortiert nach der letzten Aktualisierungszeit in absteigender Reihenfolge.

Beispielanfrage

GET https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations?filter=state!='accepted'&orderBy='updateTime desc'

Nutzereinladungen senden

Nutzereinladungen werden nicht automatisch an berechtigte Nutzer gesendet. Wenn Sie eine Liste der Nutzer haben, die Sie einladen möchten, können Sie die Methode customers.userinvitations.send() verwenden. Dadurch wird auch eine Einladung erstellt, wenn keine vorhanden ist.

REST

Rufen Sie customers.userinvitations.send() mit der Kundennummer und der E-Mail-Adresse des Nutzerkontos auf, um eine E-Mail-Einladung an einen Nutzer zu senden.

Beispielanfrage

POST https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[e-mail]:send

Nutzereinladungen abbrechen

Nutzereinladungen können storniert werden, bis sie akzeptiert oder abgelehnt werden. Rufen Sie die Methode customers.userinvitations.cancel() auf, um eine Einladung zu stornieren.

REST

Rufen Sie zum Widerrufen einer Nutzer Einladung customers.userinvitations.cancel() mit der Kundennummer und der E-Mail-Adresse des Nutzerkontos auf.

Beispielanfrage

POST https://cloudidentity.googleapis.com/v1/customers/C00000000/userinvitations/[e-mail]:cancel