יצירת כינוי משתמש
כתובת האימייל החלופית של המשתמש היא כתובת אימייל חלופית שמשתמשת באותה תיבת דואר שמשמשת את כתובת האימייל הראשית של המשתמש. ניתן לשייך כתובת אימייל חלופית של משתמש לדומיין חשבון שונה מזה שמשמש את כתובת האימייל הראשית של המשתמש. תוך 24 שעות (לרוב מוקדם יותר), המשתמש מתחיל לקבל אימיילים שנשלחו לכתובת הזו. כדי ליצור כתובת אימייל חלופית של משתמש, צריך לאשר את הבעלות על הדומיין ב-API.
כדי ליצור כתובת אימייל חלופית למשתמש, יש להשתמש בבקשת POST
הבאה ולכלול את ההרשאה שמתוארת בקטע בקשות הרשאה. השדה userKey
יכול להיות כתובת האימייל הראשית של המשתמש, id
או כל אחת מכתובות האימייל החלופיות של המשתמש. בחומר העזר בנושא API תוכלו למצוא את מאפייני הבקשה והתגובה:
POST https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
בקשת JSON
בבקשת ה-JSON הבאה מוצגת בקשה לדוגמה ליצירת כינוי של משתמש. המשתמש הוא liz@example.com והכינוי הוא chata@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
הזו נמחק את הכינוי יום ההולדת ה-שיקa@example.com של userKey, liz@example.com:
DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com
תגובה מוצלחת מחזירה קוד סטטוס HTTP 200.