הממשק Admin SDK Directory API מאפשר לאדמינים בדומיינים ארגוניים להציג ולנהל את המשתמשים, הקבוצות, המכשירים והמשאבים שקשורים לארגון שלהם. ממשקי Cloud Identity API מציעים דרכים נוספות לניהול חלק מאותם משאבים.
שירות: admin.googleapis.com
כדי לקרוא לשירות הזה, מומלץ להשתמש בספריות הלקוח ש-Google מספקת. אם האפליקציה צריכה להשתמש בספריות משלה כדי לקרוא לשירות הזה, צריך להשתמש במידע הבא כשמבצעים את בקשות ה-API.
מסמך Discovery
מסמך גילוי הוא מפרט שניתן לקריאה על ידי מכונה, שמתאר ומאפשר שימוש בממשקי API ל-REST. היא משמשת לבניית ספריות לקוח, תוספים ל-IDE וכלים אחרים שמתקשרים עם Google APIs. שירות אחד יכול לספק כמה מסמכי גילוי. השירות הזה מספק את מסמך הגילוי הבא:
נקודת קצה של שירות
נקודת קצה של שירות היא כתובת URL בסיסית שמציינת את כתובת הרשת של שירות API. לשירות אחד יכולות להיות כמה נקודות קצה של שירות. לשירות הזה יש נקודת קצה לשירות הבאה, וכל כתובות ה-URI שבהמשך הן יחסיות לנקודת הקצה הזו:
https://admin.googleapis.com
משאב REST: asps
| Methods | |
|---|---|
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 רשימת ספקי ה-ASP שהונפקו על ידי משתמש. |
משאב REST: chromeosdevices
| Methods | |
|---|---|
action |
POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{resourceId}/action במקום זאת, אפשר להשתמש ב-BatchChangeChromeOsDeviceStatus. |
get |
GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId} שליפת המאפיינים של מכשיר ChromeOS. |
list |
GET /admin/directory/v1/customer/{customerId}/devices/chromeos מאחזר רשימה עם חלוקה לדפים של מכשירי ChromeOS בחשבון. |
moveDevicesToOu |
POST /admin/directory/v1/customer/{customerId}/devices/chromeos/moveDevicesToOu העברה או הוספה של כמה מכשירי ChromeOS ליחידה ארגונית. |
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.chromeos
| Methods | |
|---|---|
batchChangeStatus |
POST /admin/directory/v1/customer/{customerId}/devices/chromeos:batchChangeStatus שינוי הסטטוס של קבוצת מכשירי ChromeOS. |
countChromeOsDevices |
GET /admin/directory/v1/customer/{customerId}/devices/chromeos:countChromeOsDevices סופר את מכשירי ChromeOS שתואמים לבקשה. |
issueCommand |
POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand הפעלת פקודה לביצוע במכשיר. |
משאב REST: customer.devices.chromeos.commands
| Methods | |
|---|---|
get |
GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}/commands/{commandId} מקבל נתוני פקודה של פקודה ספציפית שהונפקה למכשיר. |
משאב REST: customers
| Methods | |
|---|---|
get |
GET /admin/directory/v1/customers/{customerKey} מאחזר לקוח. |
patch |
PATCH /admin/directory/v1/customers/{customerKey} מעדכן לקוח. |
update |
PUT /admin/directory/v1/customers/{customerKey} עדכון לקוח. |
משאב REST: domainAliases
| Methods | |
|---|---|
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: domains
| Methods | |
|---|---|
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: groups
| Methods | |
|---|---|
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
| Methods | |
|---|---|
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: members
| Methods | |
|---|---|
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: mobiledevices
| Methods | |
|---|---|
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: orgunits
| Methods | |
|---|---|
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: privileges
| Methods | |
|---|---|
list |
GET /admin/directory/v1/customer/{customer}/roles/ALL/privileges שליפת רשימה עם חלוקה לדפים של כל ההרשאות של לקוח. |
משאב REST: resources.buildings
| Methods | |
|---|---|
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
| Methods | |
|---|---|
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
| Methods | |
|---|---|
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: roleAssignments
| Methods | |
|---|---|
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: roles
| Methods | |
|---|---|
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: schemas
| Methods | |
|---|---|
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: tokens
| Methods | |
|---|---|
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: twoStepVerification
| Methods | |
|---|---|
turnOff |
POST /admin/directory/v1/users/{userKey}/twoStepVerification/turnOff השבתה של האימות הדו-שלבי למשתמש. |
משאב REST: users
| Methods | |
|---|---|
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
| Methods | |
|---|---|
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
| Methods | |
|---|---|
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
| Methods | |
|---|---|
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 מחזירה את קבוצת קודי האימות התקפים הנוכחית לגיבוי עבור המשתמש שצוין. |