In diesem Leitfaden wird erläutert, wie Sie mit der Methode delete()
für die Ressource Membership
der Google Chat API Mitglieder aus einem Bereich entfernen, also eine Mitgliedschaft löschen. Administratoren eines Gruppenbereichs können nicht entfernt werden, wenn sie die einzigen Administratoren des Gruppenbereichs sind. Weisen Sie einem anderen Nutzer die Rolle „Administrator des Gruppenbereichs“ zu, bevor Sie diese Mitgliedschaften entfernen.
Als Google Workspace-Administrator können Sie Nutzer, Google-Gruppen oder Chat-Apps aus einem beliebigen Bereich in Ihrer Google Workspace-Organisation entfernen.
Die Membership
-Ressource gibt an, ob ein menschlicher Nutzer oder eine Google Chat-App zu einem Gruppenbereich eingeladen wurde, Teil eines Gruppenbereichs ist oder nicht.
Vorbereitung
Node.js
- Ein Google Workspace-Konto für Unternehmen mit Zugriff auf Google Chat.
- Umgebung einrichten:
- Google Cloud-Projekt erstellen
- OAuth-Zustimmungsbildschirm konfigurieren
- Aktivieren und konfigurieren Sie die Google Chat API mit einem Namen, einem Symbol und einer Beschreibung für Ihre Chat-App.
- Installieren Sie die Cloud-Clientbibliothek für Node.js.
- Erstellen Sie Anmeldedaten für den Zugriff, je nachdem, wie Sie sich in Ihrer Google Chat API-Anfrage authentifizieren möchten:
- Wenn Sie sich als Chat-Nutzer authentifizieren möchten, erstellen Sie Anmeldedaten für die OAuth-Client-ID und speichern Sie die Anmeldedaten als JSON-Datei mit dem Namen
credentials.json
in Ihrem lokalen Verzeichnis. - Wenn Sie sich als Chat-App authentifizieren möchten, erstellen Sie Anmeldedaten für das Dienstkonto und speichern Sie die Anmeldedaten als JSON-Datei mit dem Namen
credentials.json
.
- Wenn Sie sich als Chat-Nutzer authentifizieren möchten, erstellen Sie Anmeldedaten für die OAuth-Client-ID und speichern Sie die Anmeldedaten als JSON-Datei mit dem Namen
- Wählen Sie einen Autorisierungsbereich aus, je nachdem, ob Sie sich als Nutzer oder als Chat-App authentifizieren möchten.
- Ein Google Chat-Bereich. Informationen zum Erstellen eines Gruppenbereichs mit der Google Chat API finden Sie unter Gruppenbereich erstellen. Weitere Informationen zum Erstellen von Gruppenbereichen in Chat
Mitglieder als Nutzer aus einem Gruppenbereich entfernen
Wenn Sie einen Nutzer, eine Google-Gruppe oder eine Chat-App aus einem Bereich mit Nutzerauthentifizierung entfernen möchten, übergeben Sie Folgendes in Ihrer Anfrage:
- Geben Sie den
chat.memberships
-Autorisierungsbereich an. Der autorisierende Nutzer muss die Berechtigung haben, den Nutzer oder die Google-Gruppe aus dem Gruppenbereich zu entfernen. Wenn Sie eine Chat-App entfernen möchten, geben Sie den Autorisierungsbereichchat.memberships.app
an. Apps können nur ihre eigene Mitgliedschaft löschen, nicht die anderer Apps. Es empfiehlt sich, den restriktivsten Bereich auszuwählen, der die Funktion Ihrer App weiterhin ermöglicht. - Rufen Sie die Methode
DeleteMembership()
auf. - Übergeben Sie die
name
der zu löschenden Mitgliedschaft. Wenn die Mitgliedschaft zum einzigen Administrator eines Gruppenbereichs gehört, weisen Sie vor dem Löschen dieser Mitgliedschaft einen anderen Nutzer als Administrator des Gruppenbereichs zu.
So löschen Sie eine Mitgliedschaft mit Nutzerauthentifizierung:
Node.js
Um dieses Beispiel auszuführen, ersetzen Sie Folgendes:
SPACE_NAME
: Die ID aus demname
des Bereichs. Sie können die ID abrufen, indem Sie die MethodeListSpaces()
aufrufen oder die URL des Bereichs verwenden.MEMBER_NAME
: die ID aus demname
des Mitglieds. Sie können die ID abrufen, indem Sie die MethodeListMemberships()
aufrufen.
Bei Erfolg wird im Antworttext die Mitgliedschaft mit 'state': 'NOT_A_MEMBER'
zurückgegeben, was darauf hinweist, dass das Mitglied nicht mehr im Bereich ist.
{ "name": "spaces/SPACE_NAME/members/MEMBER_NAME", "state": "NOT_A_MEMBER" }
Mit einer Chat-App Mitglieder aus einem Gruppenbereich entfernen
Für die App-Authentifizierung ist eine einmalige Administratorgenehmigung erforderlich.
Wenn Sie einen Nutzer, eine Google-Gruppe oder eine Chat-App aus einem Bereich mit App-Authentifizierung entfernen möchten, übergeben Sie Folgendes in Ihrer Anfrage:
- Geben Sie den
chat.app.memberships
-Autorisierungsbereich an. Das Löschen der Mitgliedschaft eines Administrators des Gruppenbereichs wird nur in Gruppenbereichen unterstützt, die von Chat-Apps erstellt wurden. - Rufen Sie die Methode
delete
für die Ressourcemembership
auf. - Übergeben Sie die
name
der zu löschenden Mitgliedschaft. Wenn die Mitgliedschaft zum einzigen Administrator eines Gruppenbereichs gehört, weisen Sie vor dem Löschen dieser Mitgliedschaft einen anderen Nutzer als Administrator des Gruppenbereichs zu.
Skript schreiben, das die Chat API aufruft
So löschen Sie eine Mitgliedschaft mit App-Authentifizierung:
Python
- Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen
chat_membership_delete_app.py
. Fügen Sie den folgenden Code in
chat_membership_delete_app.py
ein:from google.oauth2 import service_account from apiclient.discovery import build # Define your app's authorization scopes. # When modifying these scopes, delete the file token.json, if it exists. SCOPES = ["https://www.googleapis.com/auth/chat.app.memberships"] def main(): ''' Authenticates with Chat API using app authentication, then deletes the specified membership. ''' # Specify service account details. creds = ( service_account.Credentials.from_service_account_file('credentials.json') .with_scopes(SCOPES) ) # Build a service endpoint for Chat API. chat = build('chat', 'v1', credentials=creds) # Use the service endpoint to call Chat API. result = chat.spaces().members().delete( # The membership to delete. # # Replace SPACE with a space name. # Obtain the space name from the spaces resource of Chat API, # or from a space's URL. # # Replace MEMBER with a membership name. # Obtain the membership name from the memberships resource of # Chat API. To delete a Chat app's membership, replace MEMBER # with app; an alias for the app calling the API. name='spaces/SPACE/members/MEMBER' ).execute() # Print Chat API's response in your command line interface. # When deleting a membership, the response body is empty. print(result) if __name__ == '__main__': main()
Ersetzen Sie im Code Folgendes:
SPACE
: Ein Bereichsname, den Sie über diespaces.list
-Methode in der Chat API oder über die URL eines Bereichs abrufen können.MEMBER
: Ein Mitgliedschaftsname, den Sie mit derspaces.members.list
-Methode in der Chat API abrufen können. Wenn Sie die Mitgliedschaft einer App löschen möchten, ersetzen SieMEMBER
durchapp
.
Erstellen Sie das Beispiel in Ihrem Arbeitsverzeichnis und führen Sie es aus:
python3 chat_membership_delete_app.py
Bei Erfolg wird im Antworttext die Mitgliedschaft mit 'state': 'NOT_A_MEMBER'
zurückgegeben, was darauf hinweist, dass das Mitglied nicht mehr im Bereich ist.
{ "name": "spaces/SPACE/members/MEMBER", "state": "NOT_A_MEMBER" }
Nutzer oder Google-Gruppen als Google Workspace-Administrator aus einem Gruppenbereich entfernen
Als Google Workspace-Administrator können Sie die Methode DeleteMembership()
aufrufen, um Nutzer, Google-Gruppen oder Chat-Apps aus einem beliebigen Bereich in Ihrer Google Workspace-Organisation zu entfernen.
So rufen Sie diese Methode als Google Workspace-Administrator auf:
- Rufen Sie die Methode mit der Nutzerauthentifizierung auf und geben Sie einen Autorisierungsbereich an, der den Aufruf der Methode mit Administratorberechtigungen unterstützt.
- Geben Sie in Ihrer Anfrage den Abfrageparameter
useAdminAccess
alstrue
an.
Weitere Informationen und Beispiele finden Sie unter Gruppenbereiche in Google Chat als Google Workspace-Administrator verwalten.
Einschränkungen und Überlegungen
- Bei der App-Authentifizierung kann eine Chat-App Nutzer, aber keine Google-Gruppen oder Chat-Apps entfernen.
Weitere Informationen
- Details zur Mitgliedschaft eines Nutzers oder einer Chat-App abrufen
- Mitglieder in einem Gruppenbereich auflisten
- Mitgliedschaft eines Nutzers in einem Google Chat-Gruppenbereich aktualisieren
- Nutzer oder Chat-App in einen Gruppenbereich einladen oder hinzufügen