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
ดูข้อมูลเพิ่มเติมได้ที่คู่มือการให้สิทธิ์
เนื้อหาของหน้าเว็บนี้ได้รับอนุญาตภายใต้ใบอนุญาตที่ต้องระบุที่มาของครีเอทีฟคอมมอนส์ 4.0 และตัวอย่างโค้ดได้รับอนุญาตภายใต้ใบอนุญาต Apache 2.0 เว้นแต่จะระบุไว้เป็นอย่างอื่น โปรดดูรายละเอียดที่นโยบายเว็บไซต์ Google Developers Java เป็นเครื่องหมายการค้าจดทะเบียนของ Oracle และ/หรือบริษัทในเครือ
อัปเดตล่าสุด 2025-07-25 UTC
[null,null,["อัปเดตล่าสุด 2025-07-25 UTC"],[],[],null,["# Method: users.settings.cse.identities.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListCseIdentitiesResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists the client-side encrypted identities for an authenticated user.\n\nFor administrators managing identities and keypairs for users in their organization, requests require authorization with a [service account](https://developers.google.com/identity/protocols/OAuth2ServiceAccount) that has [domain-wide delegation authority](https://developers.google.com/identity/protocols/OAuth2ServiceAccount#delegatingauthority) to impersonate users with the `https://www.googleapis.com/auth/gmail.settings.basic` scope.\n\nFor users managing their own identities and keypairs, requests require [hardware key encryption](https://support.google.com/a/answer/14153163) turned on and configured.\n\n### HTTP request\n\n`GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/identities`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-------------------------------------------------------------------------------------------------------------------------|\n| `userId` | `string` The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageToken` | `string` Pagination token indicating which page of identities to return. If the token is not supplied, then the API will return the first page of results. |\n| `pageSize` | `integer` The number of identities to return. If not provided, the page size will default to 20 entries. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"cseIdentities\": [ { object (/workspace/gmail/api/reference/rest/v1/users.settings.cse.identities#CseIdentity) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `cseIdentities[]` | `object (`[CseIdentity](/workspace/gmail/api/reference/rest/v1/users.settings.cse.identities#CseIdentity)`)` One page of the list of CSE identities configured for the user. |\n| `nextPageToken` | `string` Pagination token to be passed to a subsequent identities.list call in order to retrieve the next page of identities. If this value is not returned or is the empty string, then no further pages remain. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/gmail.settings.basic`\n- `\n https://mail.google.com/`\n- `\n https://www.googleapis.com/auth/gmail.modify`\n- `\n https://www.googleapis.com/auth/gmail.readonly`\n- `\n https://www.googleapis.com/auth/gmail.settings.sharing`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]