Method: users.aliases.list

בתיבת הדו-שיח הזו מפורטים כל הכינויים של המשתמש.

בקשת HTTP

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

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

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

פרמטרים
userKey

string

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

פרמטרים של שאילתה

פרמטרים
event

enum (Event)

אירועים לצפייה.

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

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

ייצוג JSON 
{
  "kind": string,
  "etag": string,
  "aliases": [
    {
      object (UserAlias)
    }
  ]
}
שדות
kind

string

זה סוג המשאב.
etag

string

ה-ETag של המשאב.
aliases[]

object (UserAlias)

רשימה של כינויים.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://apps-apis.google.com/a/feeds/alias/
  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/admin.directory.user.alias
  • https://www.googleapis.com/auth/admin.directory.user.alias.readonly
  • https://www.googleapis.com/auth/admin.directory.user.readonly

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

אירוע

סוג האירוע 'מינוי'

טיפוסים בני מנייה (enum)
ADD אירוע שנוצר באמצעות כינוי
DELETE כינוי לאירוע שנמחק