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
}
שדות
id

string

המזהה הייחודי של המשתמש. המשתמש id יכול לשמש בתור userKey של בקשת משתמש מסוג URI.
primaryEmail

string

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

value (Value format)

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

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

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

string

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

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

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

boolean

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

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

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, telex, tty_tdd, telex, tty_tdd, other, mobile, otherworkwork_faxwork_mobilework_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

זמן תפוגה במיליוניות השנייה מאז epoch.

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

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

value (Value format)

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

שדות

ims[].customProtocol

string

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

ims[].customType

string

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

ims[].im

string

מזהה רשת ה-IM של המשתמש.

ims[].primary

boolean

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

ims[].protocol

string

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

ערכים קבילים:
  • aim: פרוטוקול AOL ללא התקנה
  • custom_protocol: פרוטוקול רשת IM בהתאמה אישית
  • gtalk: פרוטוקול Google Talk
  • icq: פרוטוקול ICQ
  • jabber: פרוטוקול Jabber
  • msn: פרוטוקול MSN Messenger
  • net_meeting: פרוטוקול פגישה Net
  • 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.

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

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