משאב: משתמש
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. במשאבי Users, הערך הוא |
||||||||||||||||||||||||||||||||||||||||||
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 לכניסה שלו. |
|
מבטל את המחיקה של משתמש שנמחק. |
|
מעדכן משתמש. |
|
מעקב אחרי שינויים ברשימת המשתמשים. |