Admin SDK Directory API מאפשר לאדמינים של דומיינים ארגוניים להציג ולנהל את המשתמשים, הקבוצות, המכשירים והמשאבים הקשורים של הארגון. ממשקי Cloud Identity API מציעים דרכים נוספות לניהול חלק מאותם משאבים.
שירות: admin.googleapis.com
כדי לקרוא לשירות הזה, מומלץ להשתמש בספריות הלקוח ש-Google מספקת. אם האפליקציה שלכם צריכה להשתמש בספריות משלכם כדי לקרוא לשירות הזה, צריך להשתמש במידע הבא כששולחים את בקשות ה-API.
מסמך Discovery
מסמך 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 הצגת רשימת ה-ASPs שהונפקו על ידי משתמש. |
משאב 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} אחזור המאפיינים של מכשיר 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.chromeos
| Methods | |
|---|---|
batchChangeStatus |
POST /admin/directory/v1/customer/{customerId}/devices/chromeos:batchChangeStatus שינוי הסטטוס של קבוצה של מכשירי 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 אחזור של כל הקבוצות בדומיין או של משתמש לפי userKey (חלוקה לדפים). |
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 אחזור רשימה מחולקת לדפים של כל ה-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 הפונקציה מחזירה את הקבוצה הנוכחית של קודי אימות לגיבוי התקפים של המשתמש שצוין. |