Method: users.update

עדכון משתמש.

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

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

בקשת HTTP

PUT https://admin.googleapis.com/admin/directory/v1/users/{userKey}

בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.

פרמטרים של נתיב

פרמטרים
userKey

string

מזהה את המשתמש בבקשת ה-API. הערך יכול להיות כתובת האימייל הראשית, כתובת האימייל החלופית או מזהה המשתמש הייחודי של המשתמש.

גוף הבקשה

גוף הבקשה מכיל מופע של User.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה מכיל מופע של User.

היקפי הרשאות

נדרש היקף ההרשאות הבא של OAuth:

  • https://www.googleapis.com/auth/admin.directory.user

למידע נוסף, עיינו במדריך ההרשאות.