Method: users.settings.cse.keypairs.list

แสดงรายการคู่คีย์การเข้ารหัสฝั่งไคลเอ็นต์สําหรับผู้ใช้ที่ตรวจสอบสิทธิ์แล้ว

สําหรับผู้ดูแลระบบที่จัดการข้อมูลระบุตัวตนและคู่คีย์สําหรับผู้ใช้ในองค์กร คําขอต้องได้รับอนุญาตด้วยบัญชีบริการที่มีสิทธิ์มอบหมายทั่วทั้งโดเมนเพื่อแอบอ้างเป็นผู้ใช้ท��่มีขอบเขต https://www.googleapis.com/auth/gmail.settings.basic

สำหรับผู้ใช้ที่จัดการข้อมูลประจำตัวและคู่คีย์ของตนเอง คำขอจะต้องเปิดและกำหนดค่าการเข้ารหัสคีย์ฮาร์ดแวร์

คำขอ HTTP

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

URL ใช้ไวยากรณ์การแปลง gRPC

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

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

string

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

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

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

string

โทเค็นการแบ่งหน้าเว็บที่ระบุหน้าของคู่คีย์ที่จะแสดง หากไม่ได้ระบุโทเค็น API จะแสดงหน้าแรกของผลการค้นหา
pageSize

integer

จำนวนคู่คีย์ที่จะแสดง หากไม่ได้ระบุไว้ ระบบจะใช้ค่าเริ่มต้นเป็น 20 รายการ

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

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

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

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

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

object (CseKeyPair)

หน้าเดียวของรายการคู่คีย์ CSE ที่ติดตั้งไว้สำหรับผู้ใช้
nextPageToken

string

โทเค็นการแบ่งหน้าที่จะส่งไปยังการเรียก keypairs.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

ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์