Nutzereinladungen erstellen und verwalten

Auf dieser Seite wird erläutert, wie Sie einige grundlegende Vorgänge mit der Cloud Identity User Invite 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:

Eignung für Einladungen ermitteln

Wie in der Übersicht erwähnt, muss ein Nutzerkonto für die Einladung mehrere Kriterien erfüllen. Mit der Methode IsInvitableUser() können Sie herausfinden, ob ein bestimmtes Nutzerkonto die Voraussetzungen erfüllt.

REST

Rufen Sie customers.userinvitations.isInvitableUser() mit der Kundennummer und der E-Mail-Adresse des Kontos auf, um zu prüfen, ob ein Nutzerkonto berechtigt ist.

Beispielanfrage

GET https://cloudidentity.googleapis.com/v1beta1/customers/C00000000/userinvitations/writer@altostrat.com:isInvitableUser

Nutzereinladungen abrufen

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

Einzelne Nutzereinladung abrufen

REST

Rufen Sie zum Abrufen einer einzelnen Nutzereinladung customers.userinvitations.get() mit der Kundennummer und der E-Mail-Adresse des Kontos auf.

Beispielanfrage

GET https://cloudidentity.googleapis.com/v1beta1/customers/C00000000/userinvitations/writer@altostrat.com

Liste von Nutzereinladungen abrufen

Alle nicht verwalteten Nutzer werden automatisch als Einladungen im Status NOT_YET_SENT angezeigt, bis sie vom Administrator oder vom Endnutzer ausgeführt wurden. Sobald der Nutzer eine Einladung angenommen hat, gilt das Konto nicht mehr als nicht verwaltet.

Sie können mehrere Status überprüfen, indem Sie dem Filter den Operator or hinzufügen: state=='accepted'||state=='declined'

REST

Rufen Sie zum Abrufen einer Liste mit Nutzereinladungen customers.userinvitations.list() mit der Kundennummer und den gewünschten Abfrageparameter auf, um die Ergebnisse zu filtern, zu sortieren und zu paginieren. Im folgenden Beispiel wird eine Liste aller nicht verwalteten Nutzer sortiert, sortiert in absteigender Reihenfolge nach der letzten aktualisierten Zeit.

Beispielanfrage

GET https://cloudidentity.googleapis.com/v1beta1/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 sie nicht existiert.

REST

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

Beispielanfrage

POST https://cloudidentity.googleapis.com/v1beta1/customers/C00000000/userinvitations/writer@altostrat.com:send

Nutzereinladungen werden zurückgenommen

Nutzereinladungen können zurückgezogen werden, bis sie angenommen oder abgelehnt werden. Rufen Sie die Methode customers.userinvitations.cancel() auf, um eine Einladung abzubrechen.

REST

Wenn Sie eine Nutzereinladung zurückziehen möchten, rufen Sie customers.userinvites.cancel() mit der Kundennummer und der E-Mail-Adresse des Nutzerkontos auf.

Beispielanfrage

POST https://cloudidentity.googleapis.com/v1beta1/customers/C00000000/userinvitations/writer@altostrat.com:cancel