REST Resource: users

משאב: משתמש

‫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 (UserName)
  },
  "kind": string,
  "etag": string,
  "emails": value,
  "externalIds": value,
  "relations": value,
  "aliases": [
    string
  ],
  "isMailboxSetup": boolean,
  "customerId": string,
  "addresses": value,
  "organizations": value,
  "lastLoginTime": string,
  "phones": value,
  "suspensionReason": string,
  "thumbnailPhotoUrl": string,
  "languages": value,
  "posixAccounts": value,
  "creationTime": string,
  "nonEditableAliases": [
    string
  ],
  "sshPublicKeys": value,
  "notes": value,
  "websites": value,
  "locations": value,
  "includeInGlobalAddressList": boolean,
  "keywords": value,
  "deletionTime": string,
  "gender": value,
  "thumbnailPhotoEtag": string,
  "ims": value,
  "customSchemas": value,
  "isEnrolledIn2Sv": boolean,
  "isEnforcedIn2Sv": boolean,
  "archived": boolean,
  "orgUnitPath": string,
  "recoveryEmail": string,
  "recoveryPhone": string,
  "isGuestUser": boolean,
  "guestAccountInfo": {
    object (GuestAccountInfo)
  },
  "suspensionTime": string,
  "archivalTime": string
}
שדות
id

string

המזהה הייחודי של המשתמש. אפשר להשתמש ב-id כ-userKey של URI של בקשת משתמש.
primaryEmail

string

כתובת האימייל הראשית של המשתמש. המאפיין הזה נדרש בבקשה ליצירת חשבון משתמש. הכינוי primaryEmail צריך להיות ייחודי, ואי אפשר להשתמש בו ככינוי של משתמש אחר.
password

value (Value format)

מאחסן את הסיסמה של חשבון המשתמש. כשיוצרים חשבון משתמש, צריך להזין את ערך הסיסמה של המשתמש. הפרמטר הזה הוא אופציונלי כשמעדכנים משתמש, וצריך לספק אותו רק אם המשתמש מעדכן את סיסמת החשבון שלו. ערך הסיסמה אף פעם לא מוחזר בגוף התגובה של ה-API.

הסיסמה יכולה להכיל כל שילוב של תווים בפורמט ASCII, והיא צריכה להיות באורך של 8 עד 100 תווים.

מומלץ לשלוח את הפרמטר password כערך hash בקידוד הקסדצימלי ולהגדיר את hashFunction בהתאם. אם מציינים את hashFunction, הסיסמה חייבת להיות מפתח גיבוב תקין.
hashFunction

string

מאחסן את פורמט הגיבוב של המאפיין password. מותרים הערכים הבאים של hashFunction:

  • ‫MD5 – מקבל ערכים פשוטים בקידוד הקסדצימלי.
  • ‫SHA-1 – מקבל ערכים פשוטים בקידוד הקסדצימלי.
  • ‫crypt – תואם לספריית ההצפנה C. תומך באלגוריתמי הגיבוב DES,‏ MD5 (קידומת גיבוב $1$),‏ SHA-256 (קידומת גיבוב $5$) ו-SHA-512 (קידומת גיבוב $6$).

אם מציינים סיבובים כחלק מהקידומת, מספר הסיבובים צריך להיות 10,000 או פחות.
isAdmin

boolean

פלט בלבד. מציין משתמש עם הרשאות סופר-אדמין. אפשר לערוך את הנכס isAdmin רק בפעולה Make a user an administrator ( השיטה makeAdmin). אם העריכה מתבצעת בשיטות insert או update של המשתמש, שירות ה-API מתעלם מהעריכה.
isDelegatedAdmin

boolean

פלט בלבד. מציין אם המשתמש הוא אדמין עם הרשאות מוגבלות.
ה-API תומך באדמינים עם הרשאות מוגבלות, אבל הם לא יכולים ליצור משתמשים, לבטל השבתה של משתמשים או להפוך משתמשים לאדמינים. שירות ה-API מתעלם מהבקשות האלה.
הקצאת תפקידים והרשאות לאדמינים מתבצעת באמצעות מסוף Admin.
agreedToTerms

boolean

פלט בלבד. המאפיין הזה הוא true אם המשתמש השלים התחברות ראשונית ואישר את הסכם התנאים וההגבלות.
suspended

boolean

מציין אם המשתמש מושעה.
changePasswordAtNextLogin

boolean

מציין אם המשתמש נדרש לשנות את הסיסמה בכניסה הבאה. ההגדרה הזו לא חלה כשהמשתמש נכנס דרך ספק זהויות של צד שלישי.
ipWhitelisted

boolean

אם true, כתובת ה-IP של המשתמש כפופה להגדרה של כתובת IP שהוצאה משימוש allowlist.
name

object (UserName)

המשתנה הזה מכיל את השם הפרטי ושם המשפחה של המשתמש, ואת הערך fullName לקריאה בלבד. מספר התווים המקסימלי בערכים של givenName ושל familyName הוא 60. בנוסף, ערכי השמות תומכים בתווי Unicode/UTF-8, ויכולים להכיל רווחים, אותיות (a-z), מספרים (0-9), מקפים (-), קווים נטויים קדימה (/) ונקודות (.). מידע נוסף על כללי השימוש בתווים זמין במרכז העזרה לאדמינים. הגודל המקסימלי המותר של הנתונים בשדה הזה הוא 1KB.
kind

string

פלט בלבד. סוג משאב ה-API. במשאבי Users, הערך הוא admin#directory#user.
etag

string

פלט בלבד. ‫ETag של המשאב.
emails

value (Value format)

רשימת כתובות האימייל של המשתמש. הגודל המקסימלי המותר של הנתונים הוא 10KB.

שדות

emails[].address

string

כתובת האימייל של המשתמש. משמש גם כמזהה האימייל. הערך הזה יכול להיות כתובת האימייל הראשית של המשתמש או כתובת אימייל חלופית.

emails[].customType

string

אם כתובת האימייל type היא custom, המאפיין הזה מכיל את הערך המותאם אישית וחובה להגדיר אותו.

emails[].primary

boolean

מציין אם זו כתובת האימייל הראשית של המשתמש. אפשר לסמן רק רשומה אחת כראשית.

emails[].type

string

סוג חשבון האימייל. אם הערך הוא custom, צריך להגדיר גם את customType.

ערכים קבילים: custom, home, other, work.
externalIds

value (Value format)

רשימת המזהים החיצוניים של המשתמש, כמו מזהה עובד או מזהה רשת. הגודל המקסימלי המותר של הנתונים הוא 2KB.

שדות

externalIds[].customType

string

אם המזהה החיצוני type הוא custom, המאפיין הזה מכיל את הערך המותאם אישית וחובה להגדיר אותו.

externalIds[].type

string

סוג המזהה החיצוני. אם הערך הוא custom, צריך להגדיר גם את customType.
ערכים קבילים: account, custom, customer, login_id, network, organization.

externalIds[].value

string

הערך של המזהה החיצוני.
relations

value (Value format)

רשימת הקשרים של המשתמש עם משתמשים אחרים. הגודל המקסימלי המותר של הנתונים בשדה הזה הוא 2KB. מידע נוסף זמין במאמר בנושא ניהול חשבונות משתמשים.

שדות

relations[].customType

string

אם קשר הגומלין type הוא custom, המאפיין הזה מכיל את הערך המותאם אישית וחובה להגדיר אותו.

relations[].type

string

סוג הקשר. אם הערך הוא custom, צריך להגדיר גם את customType.

ערכים קבילים:
  • admin_assistant
  • assistant
  • brother
  • child
  • custom
  • domestic_partner
  • dotted_line_manager
  • exec_assistant
  • father
  • friend
  • manager
  • mother
  • parent
  • partner
  • referred_by
  • relative
  • sister
  • spouse

relations[].value

string

כתובת האימייל של האדם שהמשתמש קשור אליו.
aliases[]

string

פלט בלבד. רשימת כתובות האימייל החלופיות של המשתמש.
isMailboxSetup

boolean

פלט בלבד. מציין אם תיבת הדואר של המשתמש ב-Google נוצרה. המאפיין הזה רלוונטי רק אם למשתמש הוקצה רישיון ל-Gmail.
customerId

string

פלט בלבד. מספר הלקוח שרוצים לאחזר את כל המשתמשים בחשבון.
אפשר להשתמש בכינוי my_customer כדי לייצג את customerId של החשבון.
אדמינים של מפיצים יכולים להשתמש בcustomerId של חשבון הלקוח שנמכר. כדי לקבל customerId, משתמשים בדומיין הראשי של החשבון בפרמטר domain של בקשת users.list.
addresses

value (Value format)

רשימת הכתובות של המשתמש. הגודל המקסימלי המותר של הנתונים הוא 10KB.

שדות

addresses[].country

string

מדינה.

addresses[].countryCode

string

קוד המדינה. התקן שבו משתמשים הוא ISO 3166-1.

addresses[].customType

string

אם הכתובת type היא custom, המאפיין הזה מכיל את הערך המותאם אישית וחובה להגדיר אותו.

addresses[].extendedAddress

string

לכתובות מורחבות, כמו כתובת שכוללת אזור משנה.

addresses[].formatted

string

כתובת מלאה למשלוח דואר, לא מובנית. השדה הזה לא מסונכרן עם שדות הכתובת המובנים. כולל את המאפיינים הבאים: כתובת, תא דואר, עיר, מדינה/מחוז, מיקוד, מדינה/אזור.

addresses[].locality

string

העיר או העיירה שמוגדרות בכתובת.

addresses[].poBox

string

תא הדואר, אם יש כזה.

addresses[].postalCode

string

המיקוד, אם רלוונטי.

addresses[].primary

boolean

אם זו הכתובת הראשית של המשתמש. רשימת הכתובות יכולה לכלול רק כתובת ראשית אחת.

addresses[].region

string

המדינה או המחוז בקיצור.

addresses[].sourceIsStructured

boolean

מציין אם הכתובת שסופקה על ידי המשתמש עברה עיצוב. בשלב הזה אין תמיכה בכתובות מפורמטות.

addresses[].streetAddress

string

הכתובת, למשל 1600 Amphitheatre Parkway. המערכת מתעלמת מרווחים לבנים בתוך המחרוזת, אבל מעברי שורה חשובים.

addresses[].type

string

סוג הכתובת. אם הערך הוא custom, צריך להגדיר גם את customType.

ערכים קבילים: custom, home, other, work.
organizations

value (Value format)

רשימת הארגונים שהמשתמש שייך אליהם. הגודל המקסימלי המותר של הנתונים הוא 10KB.

שדות

organizations[].costCenter

string

מרכז העלויות של הארגון של המשתמש.

organizations[].customType

string

אם הערך של type הוא custom, המאפיין הזה מכיל את הסוג המותאם אישית.

organizations[].department

string

מציין את המחלקה בארגון, כמו sales או engineering.

organizations[].description

string

תיאור הארגון.

organizations[].domain

string

הדומיין שאליו שייך הארגון.

organizations[].fullTimeEquivalent

integer

השווי המילימטרי של משרה מלאה בארגון (100,000 = 100%).

organizations[].location

string

המיקום הפיזי של הארגון. הכתובת לא צריכה להיות מוגדרת במלואה.

organizations[].name

string

שם הארגון.

organizations[].primary

boolean

מציין אם זה הארגון הראשי של המשתמש. לכל משתמש יכול להיות רק ארגון ראשי אחד.

organizations[].symbol

string

סמל מחרוזת הטקסט של הארגון. לדוגמה, סמל הטקסט של Google הוא GOOG.

organizations[].title

string

התפקיד של המשתמש בארגון. לדוגמה, member או engineer.

organizations[].type

string

סוג הארגון.

ערכים קבילים: domain_only, school, unknown, work.
lastLoginTime

string

פלט בלבד. הפעם האחרונה שבה המשתמש התחבר לחשבון שלו. הערך הוא בפורמט תאריך ושעה ISO 8601. הזמן הוא התאריך המלא בתוספת שעות, דקות ושניות בפורמט YYYY-MM-DDThh:mm:ssTZD. לדוגמה, 2010-04-05T17:30:04+01:00.
phones

value (Value format)

רשימה של מספרי הטלפון של המשתמש. הגודל המקסימלי המותר של הנתונים הוא 1KB.

שדות

phones[].customType

string

אם מספר הטלפון type הוא custom, המאפיין הזה מכיל את הערך המותאם אישית וחובה להגדיר אותו.

phones[].primary

boolean

אם true, זה מספר הטלפון הראשי של המשתמש. לכל משתמש יכול להיות רק מספר טלפון ראשי אחד.

phones[].type

string

סוג מספר הטלפון. אם הערך הוא custom, צריך להגדיר גם את customType.

ערכים קבילים: assistant, callback, car, company_main, custom, grand_central, home, home_fax, isdn, main, mobile, other, other_fax, pager, radio, telex, tty_tdd, work, work_fax, work_mobile, work_pager.

phones[].value

string

מספר טלפון שקריא לאנשים. יכול להיות בכל פורמט של מספר טלפון.
suspensionReason

string

פלט בלבד. הסיבה להשעיית חשבון משתמש על ידי האדמין או על ידי Google בזמן ההשעיה. המאפיין מוחזר רק אם המאפיין suspended הוא true.
thumbnailPhotoUrl

string

פלט בלבד. כתובת ה-URL של תמונת הפרופיל של המשתמש. יכול להיות שכתובת ה-URL זמנית או פרטית.
languages

value (Value format)

רשימת השפות של המשתמש. הגודל המקסימלי המותר של הנתונים הוא 1KB.

שדות

languages[].customLanguage

string

שפה אחרת. המשתמש יכול לספק שם שפה משלו אם אין קוד שפה תואם לפי תקן ISO 639. אם ההגדרה הזו מופעלת, אי אפשר להגדיר את languageCode.

languages[].languageCode

string

ייצוג מחרוזת של שפה לפי תקן ISO 639. כאן אפשר לעיין ברשימת הקודים הנתמכים. ממשק ה-API יקבל קודים תקפים של שפות שלא נכללים בקבוצת השפות הנתמכות, אבל יכול להיות שהם יובילו להתנהגות לא צפויה. ערכים לא חוקיים גורמים לSchemaException. אם ההגדרה הזו מופעלת, אי אפשר להגדיר את customLanguage.

languages[].preference

string

אופציונלי. אם המדיניות הזו מוגדרת, היא קובעת אם השפה שצוינה ב-languageCode היא השפה המועדפת על המשתמש. אם ההגדרה customLanguage מוגדרת, אי אפשר להגדיר את ההגדרה הזו. הערכים המותרים הם preferred ו-not_preferred.
posixAccounts

value (Value format)

רשימת פרטי החשבון של המשתמש על פי POSIX.

שדות

posixAccounts[].accountId

string

מזהה של שדה בחשבון POSIX.

posixAccounts[].gecos

string

GECOS (פרטי המשתמש) של החשבון הזה.

posixAccounts[].gid

unsigned long

מזהה הקבוצה שמוגדר כברירת מחדל.

posixAccounts[].homeDirectory

string

הנתיב לספריית הבית של החשבון הזה.

posixAccounts[].operatingSystemType

string

סוג מערכת ההפעלה של החשבון.

ערכים קבילים: linux, ‏ unspecified, ‏ windows.

posixAccounts[].primary

boolean

אם זה החשבון הראשי של המשתמש בתוך SystemId.

posixAccounts[].shell

string

הנתיב למעטפת הכניסה לחשבון הזה.

posixAccounts[].systemId

string

מזהה המערכת שאליה מתייחס שם המשתמש או ה-Uid של החשבון.

posixAccounts[].uid

unsigned long

מזהה המשתמש שתואם ל-POSIX.

posixAccounts[].username

string

שם המשתמש של החשבון.
creationTime

string

פלט בלבד. השעה שבה נוצר החשבון של המשתמש. הערך הוא בפורמט תאריך ושעה ISO 8601. הזמן הוא התאריך המלא בתוספת שעות, דקות ושניות בפורמט YYYY-MM-DDThh:mm:ssTZD. לדוגמה, 2010-04-05T17:30:04+01:00.
nonEditableAliases[]

string

פלט בלבד. רשימת כתובות האימייל של הכינויים של המשתמש שלא ניתן לערוך. בדרך כלל, הם לא נמצאים בדומיין הראשי או בתת-הדומיין של החשבון.
sshPublicKeys

value (Value format)

רשימה של מפתחות ציבוריים של SSH.

שדות

sshPublicKeys[].expirationTimeUsec

long

זמן התפוגה במיקרו-שניות מאז ראשית הזמן.

sshPublicKeys[].fingerprint

string

טביעת אצבע SHA-256 של מפתח SSH ציבורי. (לקריאה בלבד)

sshPublicKeys[].key

string

מפתח ציבורי SSH.
notes

value (Value format)

הערות למשתמש כאובייקט מקונן.

שדות

notes.contentType

string

סוג התוכן של ההערה, טקסט פשוט או HTML. ברירת המחדל היא טקסט פשוט.

ערכים קבילים: text_plain, ‏ text_html.

notes.value

string

התוכן של ההערות.
websites

value (Value format)

רשימת האתרים של המשתמש.

שדות

websites[].customType

string

אם האתר type הוא custom, המאפיין הזה מכיל את הערך המותאם אישית וחובה להגדיר אותו.

websites[].primary

boolean

אם true, זה האתר הראשי של המשתמש.

websites[].type

string

הסוג או המטרה של האתר. לדוגמה, אתר יכול לקבל את התווית home או blog. לחלופין, רשומה יכולה להיות מסוג custom. אם הערך שמוגדר הוא custom, צריך להגדיר גם את customType.

ערכים קבילים: app_install_page, blog, custom, ftp, home, home_page, other, profile, reservations, resume, work.

websites[].value

string

כתובת ה-URL של האתר.
locations

value (Value format)

רשימת המיקומים של המשתמש. הגודל המקסימלי המותר של הנתונים הוא 10KB.

שדות

locations[].area

string

חובה. מיקום טקסטואלי. השדה הזה שימושי בעיקר למטרות תצוגה, כדי לתאר את המיקום בצורה תמציתית. לדוגמה, Mountain View, CA או Near Seattle.

locations[].buildingId

string

מזהה הבניין.

locations[].customType

string

אם המיקום type הוא custom, המאפיין הזה מכיל את הערך המותאם אישית וחובה להגדיר אותו.

locations[].deskCode

string

הקוד הטקסטואלי הספציפי ביותר של מיקום שולחן עבודה מסוים.

locations[].floorName

string

שם או מספר הקומה.

locations[].floorSection

string

קטע בקומה. מיקום ספציפי יותר בקומה. לדוגמה, אם קומה מחולקת לקטעים A, B ו-C, השדה הזה יזהה אחד מהערכים האלה.

locations[].type

string

סוג המיקום. אם הערך הוא custom, צריך להגדיר גם את customType.

ערכים קבילים: custom, default, desk.
includeInGlobalAddressList

boolean

המאפיין הזה מציין אם הפרופיל של המשתמש גלוי ברשימת הכתובות הכללית של Google Workspace כשהתכונה 'שיתוף אנשי קשר' מופעלת בדומיין. מידע נוסף על החרגת פרופילים של משתמשים זמין במרכז העזרה למנהלים.
keywords

value (Value format)

רשימת מילות המפתח של המשתמש. הגודל המקסימלי המותר של הנתונים הוא 1KB.

שדות

keywords[].customType

string

אם מילת המפתח type היא custom, המאפיין הזה מכיל את הערך המותאם אישית וחובה להגדיר אותו.

keywords[].type

string

לכל רשומה יכול להיות סוג שמציין את הסוג הרגיל של הרשומה.

לדוגמה, מילת המפתח יכולה להיות מסוג occupation או outlook. בנוסף לסוג הרגיל, רשומה יכולה להיות מסוג custom, ואפשר לתת לה כל שם. אם הערך הוא custom, צריך להגדיר גם את customType.

ערכים קבילים: custom, mission, occupation, outlook.

keywords[].value

string

מילת מפתח.
deletionTime

string

פלט בלבד. השעה שבה נמחק החשבון של המשתמש. הערך הוא בפורמט תאריך ושעה ISO 8601. הזמן הוא התאריך המלא בתוספת שעות, דקות ושניות בפורמט YYYY-MM-DDThh:mm:ssTZD. לדוגמה 2010-04-05T17:30:04+01:00.
gender

value (Value format)

אובייקט מקונן שמכיל את המגדר של המשתמש. הגודל המקסימלי המותר של הנתונים בשדה הזה הוא 1KB.

שדות

gender.addressMeAs

string

מחרוזת שמתארת את הדרך הנכונה להתייחס לבעל הפרופיל, למשל "he/him/his" או "they/them/their".

gender.customGender

string

השם של מגדר מותאם אישית.

gender.type

string

 סוג המגדר.

ערכים קבילים:
  • female
  • male
  • other
  • unknown

thumbnailPhotoEtag

string

פלט בלבד. תג ETag של תמונת המשתמש (קריאה בלבד)
ims

value (Value format)

חשבונות המסרים המיידיים (IM) של המשתמש. לחשבון משתמש יכולות להיות כמה מאפיינים של ims, אבל רק אחד מהם יכול להיות איש הקשר הראשי למסרים מיידיים.ims

שדות

ims[].customProtocol

string

אם ערך הפרוטוקול הוא custom_protocol, המאפיין הזה מכיל את המחרוזת של הפרוטוקול המותאם אישית.

ims[].customType

string

אם שיטת התמחור type היא custom, המאפיין הזה מכיל את הערך המותאם אישית וחובה להגדיר אותו.

ims[].im

string

המזהה של רשת המסרים המיידיים של המשתמש.

ims[].primary

boolean

אם זוהי כתובת ה-IM הראשית של המשתמש. רק ערך אחד ברשימת ה-IM יכול להיות true.

ims[].protocol

string

 פרוטוקול של הודעות מיידיות מזהה את רשת ההודעות המיידיות. הערך יכול להיות רשת מותאמת אישית או הרשת הרגילה.

ערכים קבילים:
  • ‫aim: פרוטוקול AOL Instant Messenger
  • ‫custom_protocol: פרוטוקול מותאם אישית של רשת צ'אט
  • gtalk: פרוטוקול Google Talk
  • ‫icq: פרוטוקול ICQ
  • ‫jabber: פרוטוקול Jabber
  • ‫msn: פרוטוקול MSN Messenger
  • ‫net_meeting: פרוטוקול פגישה נטו
  • ‫qq: פרוטוקול QQ
  • ‫skype: פרוטוקול Skype
  • ‫yahoo: פרוטוקול Yahoo Messenger

ims[].type

string

סוג חשבון הצ'אט. אם הערך הוא custom, צריך להגדיר גם את customType.

הערכים האפשריים: custom, ‏ home, ‏ other, ‏ work.
customSchemas

value (Value format)

שדות מותאמים אישית של המשתמש. המפתח הוא schemaName והערכים שלו הם 'fieldName': 'field_value'.

  • ‫customSchemas.(key) הוא אובייקט מקונן.
  • ‫customSchemas.(key).(key) יכול להיות כל ערך.
isEnrolledIn2Sv

boolean

פלט בלבד. רשום לאימות דו-שלבי (קריאה בלבד)
isEnforcedIn2Sv

boolean

פלט בלבד. האם נאכף אימות דו-שלבי (קריאה בלבד)
archived

boolean

מציין אם המשתמש הועבר לארכיון.
orgUnitPath

string

הנתיב המלא של הארגון ברמת ההורה שמשויך למשתמש. אם הארגון האב הוא ברמה העליונה, הוא מיוצג על ידי קו נטוי לפנים (/).
recoveryEmail

string

כתובת האימייל לשחזור החשבון של המשתמש.
recoveryPhone

string

מספר טלפון לשחזור חשבון של המשתמש. מספר הטלפון חייב להיות בפורמט E.164, שמתחיל בסימן פלוס (+). דוגמה: +16506661212.
isGuestUser

boolean

אי אפשר לשנות. מציין אם המשתמש שנוסף הוא אורח.
guestAccountInfo

object (GuestAccountInfo)

בלתי ניתן לשינוי. שדות נוספים של מטא-נתונים שקשורים למשתתפים
suspensionTime

string

פלט בלבד. זמן ההשעיה של חשבון המשתמש. (לקריאה בלבד)
archivalTime

string

פלט בלבד. הזמן שבו החשבון של המשתמש הועבר לארכיון. (לקריאה בלבד)

UserName

ייצוג ב-JSON 
{
  "fullName": string,
  "familyName": string,
  "givenName": string,
  "displayName": string
}
שדות
fullName

string

השם המלא של המשתמש, שנוצר משרשור של ערכי השם הפרטי והשם המשפחה.
familyName

string

שם המשפחה של המשתמש. חובה כשיוצרים חשבון משתמש.
givenName

string

השם הפרטי של המשתמש. חובה כשיוצרים חשבון משתמש.
displayName

string

השם המוצג של המשתמש. מכסה: 256 תווים.

GuestAccountInfo

פרטי החשבון הספציפיים למשתמשים אורחים.

ייצוג ב-JSON 
{
  "primaryGuestEmail": string
}
שדות
primaryGuestEmail

string

אי אפשר לשנות. כתובת האימייל החיצונית של האורח.

Methods

createGuest

 ליצור משתמש אורח עם גישה לקבוצת משנה של יכולות Workspace.

delete

 מחיקת משתמש.

get

 שליפת משתמש.

insert

 יצירת משתמש.

list

 מאחזר רשימה עם חלוקה לדפים של משתמשים שנמחקו או של כל המשתמשים בדומיין.

makeAdmin

 הופך משתמש לסופר-אדמין.

patch

 מעדכן משתמש באמצעות סמנטיקה של תיקון.

signOut

 מוציא את המשתמש מכל הסשנים באינטרנט ובמכשירים ומאפס את קובצי ה-Cookie של פרטי הכניסה שלו.

undelete

 מבטל את המחיקה של משתמש שנמחק.

update

 עדכון משתמש.

watch

 הפונקציה עוקבת אחרי שינויים ברשימת המשתמשים.