Directory API: כינויים של משתמשים

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

כתובת האימייל החלופית של משתמש היא כתובת אימייל חלופית שמשתמשת באותה תיבת דואר שבה משתמשים בכתובת האימייל הראשית של המשתמש. אפשר לשייך כתובת אימייל חלופית לדומיין חשבון שונה מהדומיין שבו נעשה שימוש בכתובת האימייל הראשית של המשתמש. תוך 24 שעות (לרוב מוקדם יותר), המשתמש מתחיל לקבל אימיילים שנשלחים לכתובת הזו. כדי ליצור את הכינוי של המשתמש, נדרש אישור הבעלות על הדומיין ב-API.

כדי ליצור כינוי משתמש, משתמשים בבקשת POST הבאה וכוללים את ההרשאה שמתוארת בקטע בקשות לאישור. השדה userKey יכול להיות כתובת האימייל הראשית של המשתמש, המשתמש id או כל אחד מהאימיילים של כתובות האימייל החלופיות של המשתמש. למאפייני הבקשה והתגובה, ראו חומר העזר בנושא API: 

POST https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases

בקשת JSON

בקשת ה-JSON הבאה היא דוגמה לבקשה ליצירת כינוי של משתמש. שם המשתמש הוא liz@example.com והכינוי הוא chica@example.com: 

POST https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases
 גוף הבקשה מכיל את פרטי הכינוי החדש: 
{  
 "alias": "chica@example.com"
}

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

אחזור כל כינויי המשתמש

כדי לאחזר את כל כתובות האימייל החלופיות של משתמש בכל הדומיינים, משתמשים בבקשה הבאה של GET וכוללים את ההרשאה שמתוארת בקטע אימות בקשות. השדה userKey יכול להיות כתובת האימייל הראשית של המשתמש, המשתמש id או כל אחד מהאימיילים של כתובות האימייל החלופיות של המשתמש. למאפייני הבקשה והתגובה, ראו חומר העזר בנושא API: 

GET https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
 לדוגמה, ה-URI של הבקשה הזו מחזיר את כל כתובות האימייל החלופיות של userKey‏, liz@example.com: 
GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases

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

תגובת JSON

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

{
"kind": "directory#user#aliases",
"aliases": [
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "liz@example.com",
  "alias": "chica@example.com"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "liz@example.com",
  "alias": "support@example.com"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "liz@example.com",
  "alias": "help@hr.example.com"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "liz@example.com",
  "alias": "tickets@jumboinc.com"
 }
]
}

מחיקת כתובת אימייל חלופית של משתמש

כדי למחוק כתובת אימייל חלופית של משתמש, משתמשים בבקשה הבאה מסוג DELETE וכוללים את ההרשאה שמתוארת בקטע בקשות לאישור. יכולות לחלוף לכל היותר 24 שעות עד שהכתובת החלופית תוסר. הערך של userKey יכול להיות כתובת האימייל הראשית של המשתמש, המשתמש id או כל אחת מכתובות האימייל החלופיות של המשתמש. הערך aliasId הוא כתובת האימייל החלופית שנמחקת. למאפייני הבקשה והתגובה, ראו חומר העזר בנושא API. 

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasId
 לדוגמה, הבקשה DELETE הזו מוחקת את כתובת האימייל החלופית chica@example.com של userKey‏, liz@example.com: 
DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com

תגובה מוצלחת מחזירה קוד סטטוס HTTP 200.