Ein Mitglied aus einem Gruppenbereich entfernen

In diesem Leitfaden wird die Verwendung des delete() für die Ressource Membership der Google Chat API, um Mitglieder aus einem einer Mitgliedschaft löschen. Administratoren von Gruppenbereichen können in folgenden Fällen nicht entfernt werden: ist er der einzige Administrator des Gruppenbereichs. Einen anderen Nutzer als Gruppenbereich zuweisen Administrator, bevor du diese Mitgliedschaften entfernst.

Als Google Workspace-Administrator können Sie Nutzer entfernen Google Groups- oder Chat-Apps aus jedem Bereich in Ihrem Google Workspace-Organisation.

Die Membership-Ressource gibt an, ob ein menschlicher Nutzer oder die Google Chat App Teil eines Leerzeichens oder fehlt.

Vorbereitung

Node.js

Als Nutzer ein Mitglied aus einem Gruppenbereich entfernen

Wenn Sie einen Nutzer, eine Google-Gruppe oder eine Chat-App aus einem Gruppenbereich mit Nutzerauthentifizierung entfernen möchten, geben Sie Folgendes in Ihrer Anfrage an:

  • Geben Sie den Autorisierungsbereich für chat.memberships an. Der autorisierende Nutzer muss berechtigt sein, ihn oder die Google-Gruppe zu entfernen aus dem Gruppenbereich. Wenn Sie eine Chat-App entfernen möchten, geben Sie den Autorisierungsbereich chat.memberships.app an. Apps können nur ihre eigene Mitgliedschaft löschen, nicht die anderer Apps. Wählen Sie als Best Practice eingeschränkt, durch die Ihre App weiterhin funktioniert.
  • Rufen Sie die Methode DeleteMembership() auf.
  • Übergeben Sie das name der zu löschenden Mitgliedschaft. Wenn die Mitgliedschaft zum Nur Administrator des Gruppenbereichs in einem Gruppenbereich; weisen Sie zuerst einen anderen Nutzer als Administrator des Gruppenbereichs zu Löschen dieser Mitgliedschaft

So löschen Sie eine Mitgliedschaft mit Nutzerauthentifizierung:

Node.js

chat/client-libraries/cloud/delete-space-user-cred.js
import {createClientWithUserCredentials} from './authentication-utils.js';

const USER_AUTH_OAUTH_SCOPES = ['https://www.googleapis.com/auth/chat.delete'];

// This sample shows how to delete a space with user credential
async function main() {
  // Create a client
  const chatClient = await createClientWithUserCredentials(USER_AUTH_OAUTH_SCOPES);

  // Initialize request argument(s)
  const request = {
    // Replace SPACE_NAME here
    name: 'spaces/SPACE_NAME'
  };

  // Make the request
  const response = await chatClient.deleteSpace(request);

  // Handle the response
  console.log(response);
}

main().catch(console.error);

Ersetzen Sie Folgendes, um dieses Beispiel auszuführen:

  • SPACE_NAME: die ID aus der name des Gruppenbereichs. Sie erhalten die ID durch Aufrufen der ListSpaces() oder anhand der URL des Gruppenbereichs erfolgen.
  • MEMBER_NAME: die ID aus der name des Mitglieds. Sie können die ID abrufen, indem Sie die Methode ListMemberships() aufrufen.

Wenn der Vorgang erfolgreich ist, gibt der Antworttext die Mitgliedschaft mit 'state': 'NOT_A_MEMBER': Das Mitglied ist nicht mehr im Gruppenbereich.

{
    "name": "spaces/SPACE_NAME/members/MEMBER_NAME",
    "state": "NOT_A_MEMBER"
}

Mitglieder über eine Chat-App aus einem Gruppenbereich entfernen

Die App-Authentifizierung ist nur einmal erforderlich Administratorgenehmigung

Wenn Sie einen Nutzer, eine Google-Gruppe oder eine Chat-App aus einem Gruppenbereich mit App-Authentifizierung entfernen möchten, geben Sie Folgendes in Ihrer Anfrage an:

  • Geben Sie den chat.app.memberships Autorisierungsbereich an. Das Löschen der Mitgliedschaft eines Administrators eines Gruppenbereichs ist nur werden in Gruppenbereichen unterstützt, die von Chat-Apps erstellt wurden.
  • Rufen Sie die Methode delete auf. am membership-Ressource.
  • Übergib die name der zu löschenden Mitgliedschaft. Wenn die Mitgliedschaft dem einzigen Administrator eines Gruppenbereichs gehört, weisen Sie vor dem Löschen dieser Mitgliedschaft einen anderen Nutzer als Administrator des Gruppenbereichs zu.

API-Schlüssel erstellen

Zum Aufrufen einer Developer Preview API-Methode müssen Sie eine nicht öffentliche Entwicklervorschauversion des API-Discovery-Dokuments verwenden. Zur Authentifizierung der Anfrage müssen Sie einen API-Schlüssel übergeben.

Öffnen Sie zum Erstellen des API-Schlüssels das Google Cloud-Projekt Ihrer Anwendung und gehen Sie so vor:

  1. Gehen Sie in der Google Cloud Console zu „Menü“  > APIs und Dienste > Anmeldedaten.

    Zu den Anmeldedaten

  2. Klicken Sie auf Anmeldedaten erstellen > API-Schlüssel:
  3. Ihr neuer API-Schlüssel wird angezeigt.
    • Klicken Sie auf „Kopieren“ . um Ihren API-Schlüssel zur Verwendung im Code Ihrer App zu kopieren. Der API-Schlüssel kann auch unter „API-Schlüssel“ der Anmeldedaten Ihres Projekts.
    • Klicken Sie auf Schlüssel einschränken, um die erweiterten Einstellungen zu aktualisieren und die Verwendung einzuschränken. Ihres API-Schlüssels. Weitere Informationen finden Sie unter Einschränkungen für API-Schlüssel anwenden.

Script zum Aufrufen der Chat API schreiben

So löschen Sie eine Mitgliedschaft mit App-Authentifizierung:

Python

  1. Erstellen Sie in Ihrem Arbeitsverzeichnis eine Datei mit dem Namen chat_membership_delete_app.py.

  2. 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, discoveryServiceUrl='https://chat.googleapis.com/$discovery/rest?version=v1&labels=DEVELOPER_PREVIEW&key=API_KEY')

    # 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()

  3. Ersetzen Sie im Code Folgendes:

    • API_KEY: API-Schlüssel, den Sie zum Erstellen erstellt haben Dienstendpunkt für die Chat API

    • SPACE: ein Name für den Gruppenbereich, den Sie über die Methode spaces.list in der Chat API oder über die URL eines Gruppenbereichs.

    • MEMBER: ein Name der Mitgliedschaft, den Sie abrufen können mit der Methode spaces.members.list in der Chat API. Um die Mitgliedschaft einer App zu löschen, ersetzen Sie MEMBER mit app.

  4. Erstellen und führen Sie das Beispiel in Ihrem Arbeitsverzeichnis aus:

    python3 chat_membership_delete_app.py

Wenn der Vorgang erfolgreich ist, gibt der Antworttext die Mitgliedschaft mit 'state': 'NOT_A_MEMBER': Das Mitglied ist nicht mehr im Gruppenbereich.

{
    "name": "spaces/SPACE/members/MEMBER",
    "state": "NOT_A_MEMBER"
}

Einschränkungen und Überlegungen

  • Bei der App-Authentifizierung können Nutzer über eine Chat-App entfernt werden, nicht jedoch über Google Groups.

Als Google Workspace-Administrator Nutzer oder Google-Gruppen aus einem Gruppenbereich entfernen

Wenn Sie Google Workspace-Administrator sind, können Sie die DeleteMembership()-Methode zum Entfernen von Nutzern, Google Groups-Gruppen oder Chat-Apps in jedem Bereich in Google Workspace Unternehmen.

So rufen Sie diese Methode als Google Workspace-Administrator auf:

  • Rufen Sie die Methode mit 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 an true an.

Weitere Informationen und Beispiele finden Sie unter Google Chat-Gruppenbereiche als Google Workspace-Administrator verwalten.