משאב: משתמש
ה-Directory API מאפשר לך ליצור ולנהל את המשתמשים בחשבון, את כתובות האימייל החלופיות של המשתמשים ואת תמונות הפרופיל של המשתמשים ב-Google. לקבלת מידע נוסף על משימות נפוצות, עיין במדריך למפתחים של חשבונות משתמש ובמדריך למפתחים של כינויים של משתמשים.
ייצוג JSON |
---|
{
"id": string,
"primaryEmail": string,
"password": value,
"hashFunction": string,
"isAdmin": boolean,
"isDelegatedAdmin": boolean,
"agreedToTerms": boolean,
"suspended": boolean,
"changePasswordAtNextLogin": boolean,
"ipWhitelisted": boolean,
"name": {
object ( |
שדות | |||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id |
המזהה הייחודי של המשתמש. המשתמש |
||||||||||||||||||||||||||||||||||||||||||
primaryEmail |
זוהי כתובת האימייל הראשית של המשתמש. הנכס הזה נדרש כדי ליצור חשבון משתמש. השדה |
||||||||||||||||||||||||||||||||||||||||||
password |
שמירת הסיסמה של חשבון המשתמש. ערך הסיסמה של המשתמש נדרש בעת יצירת חשבון משתמש. זו אופציונלית כשמעדכנים משתמשים. חובה לציין אותה רק אם הם מעדכנים את סיסמת החשבון. ערך הסיסמה אף פעם לא מוחזר בגוף התגובה של ה-API. |
||||||||||||||||||||||||||||||||||||||||||
hashFunction |
שמירת פורמט הגיבוב של המאפיין
אם עיגולים מצוינים כחלק מהקידומת, הם חייבים להיות 10,000 או פחות. |
||||||||||||||||||||||||||||||||||||||||||
isAdmin |
פלט בלבד. מציין משתמש עם הרשאות סופר-אדמין. ניתן לערוך את המאפיין |
||||||||||||||||||||||||||||||||||||||||||
isDelegatedAdmin |
פלט בלבד. השדה הזה מציין אם המשתמש הוא אדמין בעל הרשאה. |
||||||||||||||||||||||||||||||||||||||||||
agreedToTerms |
פלט בלבד. הנכס הזה הוא |
||||||||||||||||||||||||||||||||||||||||||
suspended |
הערך מציין אם המשתמש מושעה. |
||||||||||||||||||||||||||||||||||||||||||
changePasswordAtNextLogin |
השדה הזה מציין אם המשתמש אולץ לשנות את הסיסמה בהתחברות הבאה. ההגדרה הזו לא חלה כשהמשתמש נכנס לחשבון דרך ספק זהויות של צד שלישי. |
||||||||||||||||||||||||||||||||||||||||||
ipWhitelisted |
אם הערך הוא |
||||||||||||||||||||||||||||||||||||||||||
name |
מכילה את שם המשתמש ואת שם המשפחה שלו, ואת הערך לקריאה בלבד של |
||||||||||||||||||||||||||||||||||||||||||
kind |
פלט בלבד. הסוג של משאב ה-API. במשאבי המשתמשים, הערך הוא |
||||||||||||||||||||||||||||||||||||||||||
etag |
פלט בלבד. ETag של המשאב. |
||||||||||||||||||||||||||||||||||||||||||
emails |
רשימת כתובות האימייל של המשתמש. גודל הנתונים המקסימלי המותר הוא 10KB.
|
||||||||||||||||||||||||||||||||||||||||||
externalIds |
רשימת המזהים החיצוניים של המשתמש, כמו מזהה עובד או מזהה רשת. גודל הנתונים המקסימלי המותר הוא 2KB.
|
||||||||||||||||||||||||||||||||||||||||||
relations |
רשימת הקשרים של המשתמש למשתמשים אחרים. גודל הנתונים המקסימלי המותר לשדה הזה הוא 2KB. מידע נוסף זמין במאמר ניהול חשבונות משתמשים.
|
||||||||||||||||||||||||||||||||||||||||||
aliases[] |
פלט בלבד. רשימת כתובות האימייל החלופיות של המשתמש. |
||||||||||||||||||||||||||||||||||||||||||
isMailboxSetup |
פלט בלבד. מציין אם תיבת הדואר של המשתמש ב-Google נוצרה. המאפיין הזה רלוונטי רק אם למשתמש הוקצה רישיון Gmail. |
||||||||||||||||||||||||||||||||||||||||||
customerId |
פלט בלבד. מספר הלקוח כדי לאחזר את כל המשתמשים בחשבון. |
||||||||||||||||||||||||||||||||||||||||||
addresses |
רשימת הכתובות של המשתמש. גודל הנתונים המקסימלי המותר הוא 10KB.
|
||||||||||||||||||||||||||||||||||||||||||
organizations |
רשימת הארגונים שאליהם המשתמש שייך. גודל הנתונים המקסימלי המותר הוא 10KB.
|
||||||||||||||||||||||||||||||||||||||||||
lastLoginTime |
פלט בלבד. הפעם האחרונה שהמשתמש התחבר לחשבון המשתמש. ערך התאריך והשעה כתוב לפי ISO 8601. השעה היא התאריך המלא בתוספת שעות, דקות ושניות, בפורמט |
||||||||||||||||||||||||||||||||||||||||||
phones |
רשימה של מספרי הטלפון של המשתמש. גודל הנתונים המקסימלי המותר הוא 1KB.
|
||||||||||||||||||||||||||||||||||||||||||
suspensionReason |
פלט בלבד. הסיבה להשעיה של חשבון משתמש על ידי האדמין או על ידי Google בזמן ההשעיה. המאפיין מוחזר רק אם המאפיין |
||||||||||||||||||||||||||||||||||||||||||
thumbnailPhotoUrl |
פלט בלבד. כתובת ה-URL של תמונת הפרופיל של המשתמש. כתובת ה-URL עשויה להיות זמנית או פרטית. |
||||||||||||||||||||||||||||||||||||||||||
languages |
רשימת השפות של המשתמש. גודל הנתונים המקסימלי המותר הוא 1KB.
|
||||||||||||||||||||||||||||||||||||||||||
posixAccounts |
רשימת פרטי חשבון POSIX של המשתמש.
|
||||||||||||||||||||||||||||||||||||||||||
creationTime |
פלט בלבד. השעה שבה נוצר החשבון של המשתמש. ערך התאריך והשעה כתוב לפי ISO 8601. השעה היא התאריך המלא בתוספת שעות, דקות ושניות, בפורמט |
||||||||||||||||||||||||||||||||||||||||||
nonEditableAliases[] |
פלט בלבד. רשימת כתובות האימייל החלופיות של המשתמש שלא ניתנות לעריכה. לרוב הם נמצאים מחוץ לדומיין הראשי או לתת-הדומיין של החשבון. |
||||||||||||||||||||||||||||||||||||||||||
sshPublicKeys |
רשימה של מפתחות SSH ציבוריים.
|
||||||||||||||||||||||||||||||||||||||||||
notes |
הערות למשתמש כאובייקט בתוך רכיב.
|
||||||||||||||||||||||||||||||||||||||||||
websites |
רשימת האתרים של המשתמש.
|
||||||||||||||||||||||||||||||||||||||||||
locations |
רשימת המיקומים של המשתמש. גודל הנתונים המקסימלי המותר הוא 10KB.
|
||||||||||||||||||||||||||||||||||||||||||
includeInGlobalAddressList |
שדה זה מציין אם פרופיל המשתמש גלוי ברשימת הכתובות הגלובלית של Google Workspace כשהתכונה לשיתוף אנשי קשר מופעלת בדומיין. מידע נוסף על אי-הכללה של פרופילים של משתמשים זמין במרכז העזרה למנהלי מערכת. |
||||||||||||||||||||||||||||||||||||||||||
keywords |
רשימת מילות המפתח של המשתמש. גודל הנתונים המקסימלי המותר הוא 1KB.
|
||||||||||||||||||||||||||||||||||||||||||
deletionTime |
פלט בלבד. הזמן שבו חשבון המשתמש נמחק. ערך התאריך והשעה כתוב לפי ISO 8601. השעה היא התאריך המלא בתוספת שעות, דקות ושניות, בפורמט |
||||||||||||||||||||||||||||||||||||||||||
gender |
אובייקט מקונן שמכיל את המגדר של המשתמש. גודל הנתונים המקסימלי המותר בשדה הזה הוא 1KB.
|
||||||||||||||||||||||||||||||||||||||||||
thumbnailPhotoEtag |
פלט בלבד. ETag של תמונת המשתמש (לקריאה בלבד) |
||||||||||||||||||||||||||||||||||||||||||
ims |
חשבונות מיידי במסנג'ר (IM) של המשתמש. חשבון משתמש יכול להכיל מספר נכסי
|
||||||||||||||||||||||||||||||||||||||||||
customSchemas |
שדות מותאמים אישית של המשתמש. המפתח הוא
|
||||||||||||||||||||||||||||||||||||||||||
isEnrolledIn2Sv |
פלט בלבד. רשום לאימות דו-שלבי (לקריאה בלבד) |
||||||||||||||||||||||||||||||||||||||||||
isEnforcedIn2Sv |
פלט בלבד. נעשה אכיפה של אימות דו-שלבי (לקריאה בלבד) |
||||||||||||||||||||||||||||||||||||||||||
archived |
שדה זה מציין אם המשתמש הועבר לארכיון. |
||||||||||||||||||||||||||||||||||||||||||
orgUnitPath |
הנתיב המלא של ארגון ההורה המשויך למשתמש. אם ארגון ההורה הוא ברמה העליונה, הוא מיוצג כקו נטוי ( |
||||||||||||||||||||||||||||||||||||||||||
recoveryEmail |
כתובת האימייל לשחזור החשבון של המשתמש. |
||||||||||||||||||||||||||||||||||||||||||
recoveryPhone |
מספר הטלפון לשחזור החשבון של המשתמש. מספר הטלפון חייב להיות בפורמט E.164, שמתחיל בסימן הפלוס (+). לדוגמה: +16506661212. |
UserName
ייצוג JSON |
---|
{ "fullName": string, "familyName": string, "givenName": string, "displayName": string } |
שדות | |
---|---|
fullName |
השם המלא של המשתמש שנוצר על ידי שרשור הערכים של השם הפרטי ושם המשפחה. |
familyName |
שם המשפחה של המשתמש. נדרש בעת יצירת חשבון משתמש. |
givenName |
השם הפרטי של המשתמש. נדרש בעת יצירת חשבון משתמש. |
displayName |
השם המוצג של המשתמש. מגבלה: 256 תווים. |
שיטות |
|
---|---|
|
מוחק משתמש. |
|
אחזור של משתמש. |
|
יוצר משתמש. |
|
אחזור רשימה מעומדת של משתמשים שנמחקו או של כל המשתמשים בדומיין. |
|
הופך משתמש לסופר-אדמין. |
|
עדכון משתמש באמצעות סמנטיקה של תיקון. |
|
מנתקת את המשתמש מכל הסשנים באינטרנט ובמכשיר ומאפסת את קובצי ה-Cookie לכניסה שלו. |
|
מבטל את המחיקה של משתמש שנמחק. |
|
עדכון משתמש. |
|
מעקב אחר שינויים ברשימת המשתמשים. |