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 ใช้ไวยากรณ์การแปลงรหัส gRPC

พารามิเตอร์เส้นทาง

พารามิเตอร์
userId

string

อีเมลหลักของผู้ขอ หากต้องการระบุผู้ใช้ที่ได้รับการตรวจสอบสิทธิ์ คุณสามารถใช้ค่าพิเศษ me

พารามิเตอร์การค้นหา

พารามิเตอร์
pageToken

string

โทเค็นการแบ่งหน้าซึ่งระบุหน้าของข้อมูลประจำตัวที่จะแสดง หากไม่ได้ระบุโทเค็น API จะแสดงผลการค้นหาหน้าแรก
pageSize

integer

จำนวนข้อมูลประจำตัวที่จะแสดงผล หากไม่ได้ระบุ ระบบจะกำหนดขนาดหน้าเป็น 20 รายการโดยค่าเริ่มต้น

เนื้อความของคำขอ

เนื้อหาของคำขอต้องว่างเปล่า

เนื้อหาการตอบกลับ

หากทำสำเร็จ เนื้อหาการตอบกลับจะมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON 
{
  "cseIdentities": [
    {
      object (CseIdentity)
    }
  ],
  "nextPageToken": string
}
ช่อง
cseIdentities[]

object (CseIdentity)

หน้าหนึ่งของรายการข้อมูลระบุตัวตนของ CSE ที่กำหนดค่าไว้สำหรับผู้ใช้
nextPageToken

string

โทเค็นการแบ่งหน้าที่จะส่งไปยังการเรียก identities.list ที่ตามมาเพื่อดึงข้อมูลหน้าถัดไปของข้อมูลประจำตัว หากไม่มีการแสดงผลค่านี้หรือเป็นสตริงว่าง แสดงว่าไม่มีหน้าเว็บเหลืออยู่

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต 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