איך מסירים אנשים ממרחבים משותפים

במדריך הזה מוסבר איך להשתמש בשיטה delete() במשאב Membership של Google Chat API כדי להסיר משתתפים ממרחב, או במילים אחרות, למחוק את החברות במרחב. אי אפשר להסיר מנהלי מרחב אם הם המנהלים היחידים במרחב. לפני שמסירים את החברים האלה, צריך להקצות משתמש אחר כמנהל המרחב.

אדמינים ב-Google Workspace יכולים להסיר משתמשים, קבוצות Google או אפליקציות ל-Chat מכל מרחב בארגון שלהם ב-Google Workspace.

המשאב Membership מייצג אם משתמש אנושי או אפליקציית Google Chat הוזמנו למרחב, הם חלק ממנו או שהם לא נמצאים בו.

דרישות מוקדמות

Node.js

הסרת משתמש ממרחב

כדי להסיר משתמש, קבוצת Google או אפליקציית Chat ממרחב עם אימות משתמשים, צריך להעביר את הפרטים הבאים בבקשה:

  • מציינים את chat.memberships היקף ההרשאה. למשתמש המאשר צריכה להיות הרשאה להסיר את המשתמש או את קבוצת Google מהמרחב. כדי להסיר אפליקציה ל-Chat, צריך לציין את היקף ההרשאות chat.memberships.app (אפליקציות יכולות למחוק רק את החברות שלהן, ולא את החברות של אפליקציות אחרות). מומלץ לבחור את ההיקף המגביל ביותר שעדיין מאפשר לאפליקציה לפעול.
  • מבצעים קריאה ל-method‏ DeleteMembership().
  • מעבירים את name של המינוי למחיקה. אם החברות שייכת למנהל של מרחב היחיד במרחב, צריך להקצות משתמש אחר כמנהל של מרחב לפני שמוחקים את החברות הזו.

כך מוחקים חברות עם אימות משתמשים:

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

כדי להריץ את הדוגמה הזו, מחליפים את הערכים הבאים:

  • ‫SPACE_NAME: המזהה מname של המרחב. אפשר לקבל את המזהה באמצעות הקריאה ל-method‏ ListSpaces() או מכתובת ה-URL של המרחב.
  • ‫MEMBER_NAME: המזהה מתוך name של החבר. אפשר לקבל את המזהה באמצעות הפעלת השיטה ListMemberships().

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יחזיר את החברות עם 'state': 'NOT_A_MEMBER', מה שמציין שהמשתמש כבר לא חבר במרחב.

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

הסרת משתמש ממרחב באמצעות אפליקציית Chat

כדי לאמת אפליקציה, נדרש אישור אדמין חד-פעמי.

כדי להסיר משתמש, קבוצת Google או אפליקציה של Chat ממרחב עם אימות אפליקציות, צריך להעביר את הפרטים הבאים בבקשה:

  • מציינים את chat.app.memberships היקף ההרשאה. אפשר להסיר את החברות של מנהלי מרחבים רק במרחבים שנוצרו על ידי אפליקציות ל-Chat.
  • מבצעים קריאה ל-delete method ב-membership resource.
  • מעבירים את name של המינוי למחיקה. אם החברות שייכת למנהל של מרחב היחיד במרחב, צריך להקצות משתמש אחר כמנהל של מרחב לפני שמוחקים את החברות הזו.

כתיבת סקריפט שקורא ל-Chat API

כדי למחוק מינוי באמצעות אימות באפליקציה:

Python

  1. בספריית העבודה, יוצרים קובץ בשם chat_membership_delete_app.py.

  2. מוסיפים את הקוד הבא ל-chat_membership_delete_app.py:

    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. בקוד, מחליפים את הפרטים הבאים:

    • ‫SPACE: שם המרחב, שאפשר לקבל באמצעות השיטה spaces.list ב-Chat API, או מכתובת ה-URL של המרחב.

    • ‫MEMBER: שם החברות, שאפשר לקבל אותו באמצעות spaces.members.list method ב-Chat API. כדי למחוק את המינוי של אפליקציה, מחליפים את MEMBER ב-app.

  4. בספריית העבודה, מפתחים ומריצים את הדוגמה:

    python3 chat_membership_delete_app.py

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יחזיר את החברות עם 'state': 'NOT_A_MEMBER', מה שמציין שהמשתמש כבר לא חבר במרחב.

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

איך מסירים משתמשים או קבוצות Google ממרחבים כאדמינים ב-Google Workspace

אדמינים ב-Google Workspace יכולים להשתמש בשיטה DeleteMembership() כדי להסיר משתמשים, קבוצות Google או אפליקציות ל-Chat מכל מרחב בארגון שלהם ב-Google Workspace.

כדי להפעיל את ה-method הזה כאדמינים ב-Google Workspace, צריך לבצע את הפעולות הבאות:

  • קוראים ל-method באמצעות אימות משתמש, ומציינים היקף הרשאות שתומך בקריאה ל-method באמצעות הרשאות אדמין.
  • בבקשה, מציינים את פרמטר השאילתה useAdminAccess כ-true.

מידע נוסף ודוגמאות זמינים במאמר ניהול מרחבים ב-Google Chat כאדמינים ב-Google Workspace.

מגבלות ושיקולים

  • באמצעות אימות אפליקציות, אפליקציית Chat יכולה להסיר משתמשים, אבל לא קבוצות Google או אפליקציות Chat.