Method: users.settings.cse.identities.list

هویت‌های رمزگذاری‌شده‌ی سمت کلاینت را برای یک کاربر احراز هویت‌شده فهرست می‌کند.

برای مدیرانی که هویت‌ها و جفت‌کلیدهای کاربران سازمان خود را مدیریت می‌کنند، درخواست‌ها نیاز به مجوز با یک حساب کاربری سرویس دارند که اختیار واگذاری در سطح دامنه برای جعل هویت کاربران با دامنه https://www.googleapis.com/auth/gmail.settings.basic را دارد.

برای کاربرانی که هویت و جفت کلیدهای خود را مدیریت می‌کنند، درخواست‌ها مستلزم فعال و پیکربندی شدن رمزگذاری کلید سخت‌افزاری است.

درخواست HTTP

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/identities

این URL از سینتکس Transcoding در gRPC استفاده می‌کند.

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

پارامترها
userId

string

آدرس ایمیل اصلی درخواست‌کننده. برای مشخص کردن کاربر احراز هویت‌شده، می‌توانید از مقدار ویژه me استفاده کنید.

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

پارامترها
pageToken

string

توکن صفحه‌بندی که نشان می‌دهد کدام صفحه از شناسه‌ها برگردانده شود. اگر توکن ارائه نشود، API صفحه اول نتایج را برمی‌گرداند.

pageSize

integer

تعداد شناسه‌هایی که باید برگردانده شوند. در صورت عدم ارائه، اندازه صفحه به طور پیش‌فرض ۲۰ ورودی خواهد بود.

درخواست بدنه

بدنه درخواست باید خالی باشد.

بدنه پاسخ

در صورت موفقیت، بدنه پاسخ شامل داده‌هایی با ساختار زیر است:

نمایش JSON 
{
  "cseIdentities": [
    {
      object (CseIdentity)
    }
  ],
  "nextPageToken": string
}
فیلدها
cseIdentities[]

object ( CseIdentity )

یک صفحه از لیست هویت‌های CSE پیکربندی‌شده برای کاربر.

nextPageToken

string

نشانه صفحه‌بندی که به فراخوانی بعدی identity.list ارسال می‌شود تا صفحه بعدی identityها بازیابی شود. اگر این مقدار برگردانده نشود یا رشته خالی باشد، صفحات دیگری باقی نمی‌مانند.

دامنه‌های مجوز

به یکی از حوزه‌های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/gmail.settings.basic
  • https://mail.google.com/
  • https://www.googleapis.com/auth/gmail.modify
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/gmail.settings.sharing

برای اطلاعات بیشتر، بهOAuth 2.0 Overview .