Method: users.aliases.list

همه نام‌های مستعار را برای یک کاربر فهرست می‌کند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای مسیر

پارامترها
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 رویداد حذف شده مستعار