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