REST Resource: users

משאב: משתמש

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

ייצוג ב-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
}
שדות
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 רק בפעולה הפיכת משתמש לאדמין ( שיטה makeAdmin). אם עורכים את הפרטים בשיטות הוספה או עדכון של המשתמש, שירות ה-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

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

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

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

organizations[].department

string

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

organizations[].description

string

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

organizations[].domain

string

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

organizations[].fullTimeEquivalent

integer

אחוז המיליבר המקביל לעבודה במשרה מלאה בארגון (100000 = 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

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

gender.customGender

string

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

gender.type

string

 סוג המגדר.

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

thumbnailPhotoEtag

string

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

value (Value format)

חשבונות Instant Messenger (IM) של המשתמש. לחשבון משתמש יכולים להיות כמה נכסי ims, אבל רק אחד מנכסי ה-ims האלה יכול להיות איש הקשר הראשי בצ'אט.

שדות

ims[].customProtocol

string

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

ims[].customType

string

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

ims[].im

string

מזהה הרשת של המשתמש בצ'אט.

ims[].primary

boolean

אם זוהי תוכנת הצ'אט הראשית של המשתמש. רק לרשומה אחת ברשימת האימיילים יכול להיות הערך true.

ims[].protocol

string

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

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

ims[].type

string

סוג חשבון IM. אם המדיניות מוגדרת לערך 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.

UserName

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

string

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

string

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

string

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

string

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

שיטות

delete

 מחיקה של משתמש.

get

 אחזור משתמש.

insert

 יצירת משתמש.

list

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

makeAdmin

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

patch

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

signOut

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

undelete

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

update

 מעדכן משתמש.

watch

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