Admin SDK Directory API מאפשר לאדמינים של דומיינים ארגוניים להציג ולנהל את המשתמשים, הקבוצות, המכשירים והמשאבים הקשורים בארגון. בממשקי ה-API של Cloud Identity יש דרכים נוספות לנהל חלק מאותם המשאבים.
שירות: admin.googleapis.com
כדי לקרוא לשירות הזה, מומלץ להשתמש בספריות הלקוח ש-Google מספקת. אם האפליקציה שלכם צריכה להשתמש בספריות משלכם כדי לקרוא לשירות הזה, תוכלו להשתמש בפרטים הבאים כשתשלחו את בקשות ה-API.
מסמך Discovery
מסמך Discovery הוא מפרט קריא למחשבים שמיועד לתיאור ולשימוש בממשקי API ל-REST. הוא משמש לבניית ספריות לקוח, יישומי פלאגין ל-IDE וכלים אחרים שיוצרים אינטראקציה עם Google APIs. שירות אחד יכול לספק כמה מסמכי גילוי. השירות הזה מספק את מסמך הגילוי הבא:
נקודת הקצה של השירות
נקודת קצה של שירות היא כתובת URL בסיסית שמציינת את כתובת הרשת של שירות ה-API. לשירות אחד יכולות להיות כמה נקודות קצה של שירות. לשירות הזה יש את נקודת הקצה הבאה של השירות, וכל מזהי ה-URI הבאים הם יחסיים לנקודת הקצה של השירות:
https://admin.googleapis.com
משאב REST: asps
| שיטות | |
|---|---|
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
| שיטות | |
|---|---|
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
| שיטות | |
|---|---|
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
| שיטות | |
|---|---|
get |
GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}/commands/{commandId} קבלת נתוני פקודה של פקודה ספציפית שהונפקו למכשיר. |
משאב REST: customers
| שיטות | |
|---|---|
get |
GET /admin/directory/v1/customers/{customerKey} אחזור לקוח. |
patch |
PATCH /admin/directory/v1/customers/{customerKey} תיקונים ללקוח. |
update |
PUT /admin/directory/v1/customers/{customerKey} עדכון לקוח. |
משאב REST: domainAliases
| שיטות | |
|---|---|
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 מאחזר את כל הקבוצות של דומיין או של משתמש הנתון באמצעות userKey (לפי עימוד). |
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: members
| שיטות | |
|---|---|
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
| שיטות | |
|---|---|
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
| שיטות | |
|---|---|
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.buildings
| שיטות | |
|---|---|
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: roleAssignments
| שיטות | |
|---|---|
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
| שיטות | |
|---|---|
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: tokens
| שיטות | |
|---|---|
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 (אימות דו-שלבי)
| שיטות | |
|---|---|
turnOff |
POST /admin/directory/v1/users/{userKey}/twoStepVerification/turnOff השבתת האימות הדו-שלבי למשתמש. |
משאב REST: users
| שיטות | |
|---|---|
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 מחזירה את הקבוצה הנוכחית של קודי אימות חוקיים לגיבוי עבור המשתמש שצוין. |