Ein Mitglied aus einem Gruppenbereich entfernen

In diesem Leitfaden wird erläutert, wie Sie die delete() Methode für die Membership Ressource der Google Chat API verwenden, um Mitglieder aus einem Gruppenbereich zu entfernen. Dies wird auch als Löschen einer Mitgliedschaft bezeichnet. Administratoren von Gruppenbereichen können nicht entfernt werden, wenn sie die einzigen Administratoren des Gruppenbereichs sind. Weisen Sie einen anderen Nutzer als Administrator des Gruppenbereichs zu, bevor Sie diese Mitgliedschaften entfernen.

Wenn Sie Google Workspace-Administrator sind, können Sie Nutzer, Google-Gruppen oder Chat-Apps aus jedem Gruppenbereich 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, Mitglied ist oder nicht teilnimmt.

Vorbereitung

Node.js

  • Ein Google Chat-Gruppenbereich. Informationen zum Erstellen eines Gruppenbereichs mit der Google Chat API finden Sie unter Gruppenbereich erstellen. Informationen zum Erstellen eines Gruppenbereichs in Chat finden Sie in der Hilfe .

Mitglieder als Nutzer aus einem Gruppenbereich entfernen

Wenn Sie einen Nutzer, eine Google-Gruppe oder eine Chat-App mit Nutzerauthentifizierungaus einem Gruppenbereich mit entfernen möchten, übergeben Sie Folgendes in Ihrer Anfrage:

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);
}

await main();

Ersetzen Sie in diesem Beispiel Folgendes:

  • SPACE_NAME: die ID aus dem Gruppenbereichs name. Sie können die ID abrufen, indem Sie die ListSpaces() Methode aufrufen oder die URL des Gruppenbereichs verwenden.
  • MEMBER_NAME: die ID aus dem name des Mitglieds. Sie können die ID abrufen, indem Sie die ListMemberships() Methode aufrufen.

Bei Erfolg gibt der Antworttext die Mitgliedschaft mit 'state': 'NOT_A_MEMBER' zurück. Das bedeutet, dass das Mitglied nicht mehr im Gruppenbereich ist.

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

Mitglieder als Chat-App 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 mit App-Authentifizierungaus einem Gruppenbereich mit entfernen möchten, übergeben Sie Folgendes in Ihrer Anfrage:

Skript schreiben, das die Chat API aufruft

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)

    # 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:

    • SPACE: ein Gruppenbereichsname, den Sie mit der spaces.list Methode in der Chat API oder über die URL eines Gruppenbereichs abrufen können.

    • MEMBER: ein Mitgliedschaftsname, den Sie mit der Methode spaces.members.listin der Chat API abrufen können. Wenn Sie die Mitgliedschaft einer App löschen möchten, ersetzen Sie MEMBER durch app.

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

    python3 chat_membership_delete_app.py

Bei Erfolg gibt der Antworttext die Mitgliedschaft mit 'state': 'NOT_A_MEMBER' zurück. Das bedeutet, dass das Mitglied nicht mehr im Gruppenbereich ist.

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

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

Wenn Sie Google Workspace-Administrator sind, können Sie die Methode DeleteMembership() aufrufen, um Nutzer, Google-Gruppen oder Chat-Apps aus jedem Gruppenbereich in Ihrer Google Workspace-Organisation zu entfernen.

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 Administratorberechtigungenunterstützt.
  • Geben Sie in Ihrer Anfrage den Abfrageparameter useAdminAccess auf true an.

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

Einschränkungen und Überlegungen

  • Mit der App-Authentifizierung kann eine Chat-App Nutzer, aber keine Google-Gruppen oder Chat-Apps entfernen.