Admin SDK: Directory API

באמצעות Admin SDK Directory API מנהלי מערכת של דומיינים ארגוניים יכולים להציג ולנהל את המשתמשים, הקבוצות, המכשירים והמשאבים הקשורים לארגון של הארגון. ממשקי Cloud Identity API מציעים דרכים נוספות לניהול חלק מאותם משאבים.

שירות: admin.googleapis.com

כדי להתקשר לשירות הזה, מומלץ להשתמש בספריות לקוח ש-Google מספקת. אם האפליקציה שלכם צריכה להשתמש בספריות משלכם כדי להתקשר לשירות הזה, השתמשו במידע הבא כשתבצעו את בקשות ה-API.

מסמך Discovery

מסמך Discovery הוא מפרט שמחשב יכול לקרוא כדי לתאר ולצרוך ממשקי API של REST. הוא משמש לבניית ספריות לקוח, יישומי פלאגין של IDE וכלים אחרים שיוצרים אינטראקציה עם Google APIs. שירות אחד עשוי לספק מספר מסמכי גילוי. השירות הזה מספק את מסמך הגילוי הבא:

נקודת הקצה של השירות

נקודת קצה (endpoint) היא כתובת URL בסיסית המציינת את כתובת הרשת של שירות API. ייתכן שלשירות אחד יהיו כמה נקודות קצה. לשירות הזה יש נקודת קצה (endpoint) הבאה וכל ה-URIs הבאים הם יחסיים לנקודת הקצה הזו:

  • https://admin.googleapis.com

משאב REST: asp

שיטות
delete DELETE /admin/directory/v1/users/{userKey}/asps/{codeId}
ה-ASP נמחק על ידי משתמש.
get GET /admin/directory/v1/users/{userKey}/asps/{codeId}
מקבל מידע על ASP שנוצר על ידי משתמש.
list GET /admin/directory/v1/users/{userKey}/asps
פירוט ה-ASPs שמשתמש הנפיק.

משאב REST: חשיפות במכשירים

שיטות
action POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{resourceId}/action
נוקטת פעולה שמשפיעה על מכשיר Chrome OS.
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
מאחזר מאפיינים של מכשיר Chrome OS.
list GET /admin/directory/v1/customer/{customerId}/devices/chromeos
מאחזר רשימה מעומדת של מכשירי Chrome OS בחשבון.
moveDevicesToOu POST /admin/directory/v1/customer/{customerId}/devices/chromeos/moveDevicesToOu
העברה או הוספה של מספר מכשירי Chrome OS ליחידה ארגונית.
patch PATCH /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
מתבצע עדכון של מאפייני עדכון הנתונים במכשיר, כמו annotatedUser, annotatedLocation, notes, orgUnitPath או annotatedAssetId.
update PUT /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
מתבצע עדכון של מאפייני עדכון הנתונים במכשיר, כמו annotatedUser, annotatedLocation, notes, orgUnitPath או annotatedAssetId.

משאב REST: customer.devices.chrome

שיטות
issueCommand POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand
תונפק פקודה למכשיר.

משאב REST: customer.devices.chromeos.commands

שיטות
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}/commands/{commandId}
מקבלת נתוני פקודה שהופקו למכשיר הזה.

משאב REST: לקוחות

שיטות
get GET /admin/directory/v1/customers/{customerKey}
מאחזר לקוח.
patch PATCH /admin/directory/v1/customers/{customerKey}
הלקוח יתוקן.
update PUT /admin/directory/v1/customers/{customerKey}
הלקוח מתעדכן.

משאב REST: דומיינים חלופיים

שיטות
delete DELETE /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
מחיקת הדומיין החלופי של הלקוח.
get GET /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
מאחזר דומיין חלופי של הלקוח.
insert POST /admin/directory/v1/customer/{customer}/domainaliases
מוסיף כינוי דומיין של הלקוח.
list GET /admin/directory/v1/customer/{customer}/domainaliases
פירוט הכינויים של הדומיין של הלקוח.

משאב REST: דומיינים

שיטות
delete DELETE /admin/directory/v1/customer/{customer}/domains/{domainName}
מוחקת דומיין של הלקוח.
get GET /admin/directory/v1/customer/{customer}/domains/{domainName}
מאחזר דומיין של הלקוח.
insert POST /admin/directory/v1/customer/{customer}/domains
מוסיף דומיין של הלקוח.
list GET /admin/directory/v1/customer/{customer}/domains
רשימה של הדומיינים של הלקוח.

משאב REST: קבוצות

שיטות
delete DELETE /admin/directory/v1/groups/{groupKey}
מוחקת קבוצה.
get GET /admin/directory/v1/groups/{groupKey}
מאחזרת מאפיינים של קבוצה.
insert POST /admin/directory/v1/groups
יוצרת קבוצה.
list GET /admin/directory/v1/groups
מאחזר את כל הקבוצות של הדומיין או של משתמש שקיבל מפתח מפתח (עימוד).
patch PATCH /admin/directory/v1/groups/{groupKey}
מתבצע עדכון של המאפיינים של הקבוצה.
update PUT /admin/directory/v1/groups/{groupKey}
מתבצע עדכון של המאפיינים של הקבוצה.

משאב REST: groups.aliases

שיטות
delete DELETE /admin/directory/v1/groups/{groupKey}/aliases/{alias}
הסרת כינוי.
insert POST /admin/directory/v1/groups/{groupKey}/aliases
מוסיף כינוי לקבוצה.
list GET /admin/directory/v1/groups/{groupKey}/aliases
פירוט כל הכינויים של קבוצה.

משאב REST: חברים

שיטות
delete DELETE /admin/directory/v1/groups/{groupKey}/members/{memberKey}
מסיר חבר מקבוצה.
get GET /admin/directory/v1/groups/{groupKey}/members/{memberKey}
מאחזר מאפיינים של חבר קבוצה.
hasMember GET /admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}
בודקת אם המשתמש הנתון הוא חבר בקבוצה.
insert POST /admin/directory/v1/groups/{groupKey}/members
הוספת משתמש לקבוצה שצוינה.
list GET /admin/directory/v1/groups/{groupKey}/members
מאחזר רשימה מעומדת של כל החברים בקבוצה.
patch PATCH /admin/directory/v1/groups/{groupKey}/members/{memberKey}
עדכון מאפייני המינוי של משתמש בקבוצה שצוינה.
update PUT /admin/directory/v1/groups/{groupKey}/members/{memberKey}
מתבצע עדכון של החברות של משתמש בקבוצה שצוינה.

משאב REST: מכשירים ניידים

שיטות
action POST /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}/action
נוקטת פעולה שמשפיעה על המכשיר הנייד.
delete DELETE /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}
מסירה מכשיר נייד.
get GET /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}
מאחזר מאפיינים של מכשיר נייד.
list GET /admin/directory/v1/customer/{customerId}/devices/mobile
מאחזר רשימה מעומדת של כל המכשירים הניידים בבעלות החשבון.

משאב REST: יחידות ארגוניות

שיטות
delete DELETE /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
מסירה יחידה ארגונית.
get GET /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
מאחזרת יחידה ארגונית.
insert POST /admin/directory/v1/customer/{customerId}/orgunits
מוסיף יחידה ארגונית.
list GET /admin/directory/v1/customer/{customerId}/orgunits
מאחזר רשימה של כל היחידות הארגוניות בחשבון.
patch PATCH /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
מתבצע עדכון של יחידה ארגונית.
update PUT /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
מתבצע עדכון של יחידה ארגונית.

משאב REST: הרשאות

שיטות
list GET /admin/directory/v1/customer/{customer}/roles/ALL/privileges
מאחזר רשימה מעומדת של כל ההרשאות ללקוח.

משאב REST: resources.builds

שיטות
delete DELETE /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
מחיקת מבנה.
get GET /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
מאחזר בניין.
insert POST /admin/directory/v1/customer/{customer}/resources/buildings
מוסיף בניין.
list GET /admin/directory/v1/customer/{customer}/resources/buildings
מאחזרת רשימת מבנים לחשבון.
patch PATCH /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
מוסיפה בניין.
update PUT /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
מתבצע עדכון של מבנה.

משאב REST: resources.calendars

שיטות
delete DELETE /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
מחיקת משאב יומן.
get GET /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
מאחזר משאב של יומן.
insert POST /admin/directory/v1/customer/{customer}/resources/calendars
מוסיף משאב יומן.
list GET /admin/directory/v1/customer/{customer}/resources/calendars
מאחזר רשימה של משאבי יומן לחשבון.
patch PATCH /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
תותקן משאב יומן.
update PUT /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
מתבצע עדכון של משאב יומן.

משאב REST: resources.features

שיטות
delete DELETE /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
מוחקת תכונה.
get GET /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
מאחזרת תכונה.
insert POST /admin/directory/v1/customer/{customer}/resources/features
מוסיף תכונה.
list GET /admin/directory/v1/customer/{customer}/resources/features
מאחזרת רשימה של תכונות לחשבון.
patch PATCH /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
תיקון תכונה.
rename POST /admin/directory/v1/customer/{customer}/resources/features/{oldName}/rename
משנה שם של תכונה.
update PUT /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
עדכון פיצ'ר.

משאב REST: תפקיד

שיטות
delete DELETE /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}
מחיקת הקצאת התפקיד.
get GET /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}
מאחזרת תפקיד.
insert POST /admin/directory/v1/customer/{customer}/roleassignments
יוצרת הקצאת תפקיד.
list GET /admin/directory/v1/customer/{customer}/roleassignments
מאחזרת רשימה מעומדת של כל הקצאות התפקידים.

משאב REST: תפקידים

שיטות
delete DELETE /admin/directory/v1/customer/{customer}/roles/{roleId}
מוחקת תפקיד.
get GET /admin/directory/v1/customer/{customer}/roles/{roleId}
מאחזרת תפקיד.
insert POST /admin/directory/v1/customer/{customer}/roles
יוצרת תפקיד.
list GET /admin/directory/v1/customer/{customer}/roles
מאחזר רשימה מעומדת של כל התפקידים בדומיין.
patch PATCH /admin/directory/v1/customer/{customer}/roles/{roleId}
מקבלים תפקיד.
update PUT /admin/directory/v1/customer/{customer}/roles/{roleId}
עדכון התפקיד.

משאב REST: סכימות

שיטות
delete DELETE /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
מתבצעת מחיקה של סכימה.
get GET /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
מאחזר סכימה.
insert POST /admin/directory/v1/customer/{customerId}/schemas
יוצרת סכימה.
list GET /admin/directory/v1/customer/{customerId}/schemas
מאחזר את כל הסכימות ללקוח.
patch PATCH /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
תיקון סכימה.
update PUT /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
עדכון סכימה.

משאב REST: אסימונים

שיטות
delete DELETE /admin/directory/v1/users/{userKey}/tokens/{clientId}
מחיקת כל אסימוני הגישה שהונפקו על ידי משתמש לאפליקציה.
get GET /admin/directory/v1/users/{userKey}/tokens/{clientId}
מקבלת מידע על אסימון גישה שהונפק על ידי משתמש.
list GET /admin/directory/v1/users/{userKey}/tokens
מחזירה את קבוצת האסימונים שצוינו על ידי המשתמש לאפליקציות של צד שלישי.

משאב REST: שני שלבים באימות

שיטות
turnOff POST /admin/directory/v1/users/{userKey}/twoStepVerification/turnOff
תשבית את האימות הדו-שלבי למשתמש.

משאב REST: משתמשים

שיטות
delete DELETE /admin/directory/v1/users/{userKey}
מחיקת משתמש.
get GET /admin/directory/v1/users/{userKey}
מאחזר משתמש.
insert POST /admin/directory/v1/users
יוצר משתמש.
list GET /admin/directory/v1/users
מאחזר רשימה מעומדת של משתמשים שנמחקו או של כל המשתמשים בדומיין.
makeAdmin POST /admin/directory/v1/users/{userKey}/makeAdmin
הופך משתמש לסופר-אדמין.
patch PATCH /admin/directory/v1/users/{userKey}
עדכון משתמש באמצעות סמנטיקה של תיקון.
signOut POST /admin/directory/v1/users/{userKey}/signOut
המערכת מוציאה את המשתמש מכל הסשנים באינטרנט ובמכשירים של המכשיר ומאפסת את קובצי ה-cookie לכניסה.
undelete POST /admin/directory/v1/users/{userKey}/undelete
הפעולה הזו מוחקת את המשתמש שנמחק.
update PUT /admin/directory/v1/users/{userKey}
עדכון משתמש.
watch POST /admin/directory/v1/users/watch
מעקב אחר שינויים ברשימת המשתמשים.

משאב REST: users.aliases

שיטות
delete DELETE /admin/directory/v1/users/{userKey}/aliases/{alias}
הסרת כינוי.
insert POST /admin/directory/v1/users/{userKey}/aliases
הוספת כינוי.
list GET /admin/directory/v1/users/{userKey}/aliases
פירוט של כל הכינויים למשתמש.
watch POST /admin/directory/v1/users/{userKey}/aliases/watch
מעקב אחר שינויים ברשימת המשתמשים.

משאב REST: users.photos

שיטות
delete DELETE /admin/directory/v1/users/{userKey}/photos/thumbnail
הסרת התמונה של המשתמש.
get GET /admin/directory/v1/users/{userKey}/photos/thumbnail
מאחזר את התמונה של המשתמש.
patch PATCH /admin/directory/v1/users/{userKey}/photos/thumbnail
מוסיף תמונה עבור המשתמש.
update PUT /admin/directory/v1/users/{userKey}/photos/thumbnail
מוסיף תמונה עבור המשתמש.

משאב REST: verificationCodes

שיטות
generate POST /admin/directory/v1/users/{userKey}/verificationCodes/generate
המערכת תיצור קודי אימות חדשים לגיבוי עבור המשתמש.
invalidate POST /admin/directory/v1/users/{userKey}/verificationCodes/invalidate
התוקף של קודי האימות הנוכחיים של המשתמש פג.
list GET /admin/directory/v1/users/{userKey}/verificationCodes
מחזירה את הקבוצה הנוכחית של קודי אימות גיבוי חוקיים למשתמש שצוין.