‫Google משתמשת בטכנולוגיית AI כדי לתרגם תוכן לשפה המועדפת עליך. בתרגומים כאלו עשויות להיות שגיאות.

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

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

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

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

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

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

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

ה-method‏ 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": [
    "security-admin@example.com",
    "data-analysts@example.com",
    "looker-developers@example.com"
  ],
  "next_page_token": "AE12aBcDeFgHiJkLmNoPqRsTuVwXyZ"
}

שדות תשובה

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

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

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