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.