אחזור קבוצות ארגוניות באמצעות Cloud OAuth API

תצוגה מקדימה

השימוש בתכונה הזו כפוף לתנאי השימוש במוצרים בגרסת טרום-GA, שמפורטים בחלק "תנאי שירות הכלליים" בתנאים הספציפיים של השירות. השימוש בתכונות בגרסת טרום-GA הוא "כפי שהן" (As is), ויכול להיות שהתמיכה בהן תהיה מוגבלת. מידע נוסף זמין בקטע תיאור שלבי ההשקה.

במדריך הזה מוסבר איך לאחזר את החברות של משתמשים מאומתים בכוח העבודה בקבוצות ארגוניות באמצעות נקודת הקצה /groups ב-Cloud OAuth API‏ (cloudoauth.googleapis.com).

נקודת הקצה /groups משמשת כנקודת קצה מבוזרת של טענות לשילובים של OpenID Connect‏ (OIDC), ומחזירה חברות בקבוצות ארגוניות עם חלוקה לדפים עבור משתמשים במאגרי זהויות של כוח עבודה עם SCIM ובמאגרי זהויות של כוח עבודה ללא SCIM.

חשוב: נקודת הקצה /groups זמינה רק ב-Looker.

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

1. הגדרת ספק ומאגר זהויות של כוח עבודה. מידע נוסף זמין במאמר הגדרת איחוד שירותי אימות הזהות של כוח עבודה.
2. רושמים לקוח OAuth ומחליפים קוד הרשאה באסימון גישה. מידע נוסף זמין במאמר בנושא החלפת אסימונים באמצעות Cloud OAuth API.

3. מפעילים את Cloud OAuth API.

   תפקידים שנדרשים להפעלת ממשקי API

   כדי להפעיל ממשקי API, נדרשת ההרשאה serviceusage.services.enable. אם יצרתם את הפרויקט, סביר להניח שכבר יש לכם את ההרשאה הזו דרך התפקיד 'בעלים' (roles/owner). אחרת, תוכלו לקבל את ההרשאה הזו דרך התפקיד 'אדמין בממשק Service Usage' (roles/serviceusage.serviceUsageAdmin). איך מקצים תפקידים

   להפעלת ה-API

אחזור קבוצות ארגוניות

כדי לאחזר את החברות בקבוצות של המשתמש המאומת, שולחים בקשת HTTP‏ GET לנקודת הקצה /groups:

השיטה common.groups ב-Cloud OAuth API מאחזרת את חברות המשתמש המאומת בקבוצות של הארגון.

לפני שמשתמשים בנתוני הבקשה, צריך להחליף את הנתונים הבאים:

• ‫TOKEN: אסימון הגישה מסוג OAuth 2.0 לזמן קצר שהתקבל מנקודת הקצה להחלפת טוקנים.
• ‫PAGE_SIZE: אופציונלי. המספר המקסימלי של קבוצות שיוחזרו בכל דף (בין 2,500 ל-5,000).
• ‫PAGE_TOKEN: אופציונלי. טוקן של חלוקה לדפים שהתקבל מתשובה קודמת של /groups בשדה next_page_token.

ה-method של ה-HTTP וכתובת ה-URL:

GET https://cloudoauth.googleapis.com/v1/common/groups?page_size=PAGE_SIZE&page_token=PAGE_TOKEN

כדי לשלוח את הבקשה צריך להרחיב אחת מהאפשרויות הבאות:

‏Curl (Linux,‏ macOS או Cloud Shell)

מריצים את הפקודה הבאה:

curl -X GET \
     -H "Authorization: Bearer TOKEN" \
     "https://cloudoauth.googleapis.com/v1/common/groups?page_size=PAGE_SIZE&page_token=PAGE_TOKEN"

‎PowerShell (Windows)

מריצים את הפקודה הבאה:

$headers = @{ "Authorization" = "Bearer TOKEN" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://cloudoauth.googleapis.com/v1/common/groups?page_size=PAGE_SIZE&page_token=PAGE_TOKEN" | Select-Object -Expand Content

אתם אמורים לקבל תגובת JSON שדומה לזו:

{
  "groups": [
    "[e-mail]",
    "[e-mail]",
    "[e-mail]"
  ],
  "next_page_token": "AE12aBcDeFgHiJkLmNoPqRsTuVwXyZ"
}

שדות תשובה

התשובה מכילה את השדות הבאים:

שדה	סוג	תיאור
groups	array of strings	רשימת מזהי הקבוצות הארגוניות או כתובות האימייל שהמשתמש המאומת שייך אליהן.
next_page_token	string	טוקן שאפשר להעביר כ-page_token בבקשות הבאות כדי לאחזר את דף התוצאות הבא. אם השדה הזה ריק או מושמט, לא יופיעו דפים נוספים.

מידע על תגובות שגיאה שמוחזרות מנקודת הקצה /groups מופיע במאמר שגיאות במידע על משתמשים ובקבוצות ב-Cloud OAuth.

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

• אחזור פרטי משתמש באמצעות Cloud OAuth API
• החלפת אסימונים באמצעות Cloud OAuth API
• סקירה כללית על Cloud OAuth API
• ניהול אפליקציות OAuth לאיחוד שירותי אימות הזהות של כוח עבודה
• הפניית Cloud OAuth REST API