יצירה וחיפוש של קבוצות Google

בדף הזה מוסבר איך לבצע כמה פעולות בסיסיות באמצעות Cloud Identity Groups API.

לפני שמתחילים

לפני שממשיכים לקרוא את המידע בדף הזה, צריך לבצע את המשימות הבאות:

יצירת קבוצת Google

REST

כדי ליצור קבוצת Google, קוראים ל-groups.create() עם מופע של הקבוצה החדשה. מופע הקבוצה צריך לכלול את הערכים groupKey,‏ Parent ו-label שמוגדרים ל-cloudidentity.googleapis.com/groups.discussion_forum.

צריך גם להגדיר את הפרמטר initialGroupConfig, שמגדיר את הבעלים הראשוני של הקבוצה. אפשר להשתמש בערכים הבאים לפרמטר הזה:

  • ‫WITH_INITIAL_OWNER: הופך את האדם ששולח את הבקשה לבעלים של הקבוצה. ברוב המקרים, כדאי להשתמש בערך הזה.
  • ‫EMPTY: יוצר קבוצה ללא בעלים ראשוניים. אפשר להשתמש בערך הזה רק אם אתם סופר-אדמינים או אדמינים של קבוצות ב-Google Workspace. מידע נוסף על תפקידים ב-Google Workspace זמין במאמר בנושא תפקידי אדמין מוגדרים מראש.

Python

בדוגמה הבאה מוצגת פונקציית עזר ליצירת קבוצת Google באמצעות ספריית הלקוח של Python:

def create_google_group(service, customer_id, group_id, group_display_name, group_description):
  group_key = {"id": group_id}
  group = {
    "parent": "customers/" + customer_id,
    "description": group_description,
    "displayName": group_display_name,
    "groupKey": group_key,
    # Set the label to specify creation of a Google Group.
    "labels": {
      "cloudidentity.googleapis.com/groups.discussion_forum": ""
    }
  }

  try:
    request = service.groups().create(body=group)
    request.uri += "&initialGroupConfig=WITH_INITIAL_OWNER"
    response = request.execute()
    print(response)
  except Exception as e:
    print(e)

חיפוש קבוצת Google

REST

כדי לחפש קבוצת Google, צריך להתקשר אל groups.search() עם מחרוזת שאילתה. כדי לחפש את כל הקבוצות, צריך לציין רק את התווית cloudidentity.googleapis.com/groups.discussion_forum.

Python

בדוגמה הבאה מוצגת פונקציית עזר שמשמשת לחיפוש קבוצת Google באמצעות ספריית הלקוח של Python:

from urllib.parse import urlencode

def search_google_groups(service, customer_id):
  search_query = urlencode({
          "query": "parent=='customerId/{}' && 'cloudidentity.googleapis.com/groups.discussion_forum' in labels".format(customer_id)
  })
  search_group_request = service.groups().search()
  param = "&" + search_query
  search_group_request.uri += param
  response = search_group_request.execute()

  return response

המאמרים הבאים