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 אירוע שנמחק עם כינוי