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

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

אירוע

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

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