Method: users.settings.cse.identities.list
컬렉션을 사용해 정리하기
내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.
인증된 사용자의 클라이언트 측 암호화된 ID를 나열합니다.
조직의 사용자에 대한 ID 및 키 쌍을 관리하는 관리자의 경우 요청에 https://www.googleapis.com/auth/gmail.settings.basic
범위로 사용자를 가장할 수 있는 도메인 전체 위임 권한이 있는 서비스 계정으로 승인해야 합니다.
자체 ID 및 키 쌍을 관리하는 사용자의 경우 요청에 하드웨어 키 암호화가 사용 설정되고 구성되어 있어야 합니다.
HTTP 요청
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/identities
URL은 gRPC 트랜스코딩 문법을 사용합니다.
경로 매개변수
매개변수 |
userId |
string
요청자의 기본 이메일 주소입니다. 인증된 사용자를 나타내려면 특수 값 me 를 사용할 수 있습니다.
|
쿼리 매개변수
매개변수 |
pageToken |
string
반환할 ID 페이지를 나타내는 페이지 나누기 토큰입니다. 토큰을 제공하지 않으면 API에서 결과의 첫 번째 페이지를 반환합니다.
|
pageSize |
integer
반환할 ID 수입니다. 제공하지 않으면 페이지 크기는 기본적으로 20개의 항목으로 설정됩니다.
|
응답 본문
성공한 경우 응답 본문은 다음과 같은 구조의 데이터를 포함합니다.
JSON 표현 |
{
"cseIdentities": [
{
object (CseIdentity )
}
],
"nextPageToken": string
} |
필드 |
cseIdentities[] |
object (CseIdentity )
사용자에 대해 구성된 CSE ID 목록의 한 페이지입니다.
|
nextPageToken |
string
다음 ID 페이지를 가져오기 위해 후속 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
자세한 내용은 승인 가이드를 참고하세요.
달리 명시되지 않는 한 이 페이지의 콘텐츠에는 Creative Commons Attribution 4.0 라이선스에 따라 라이선스가 부여되며, 코드 샘플에는 Apache 2.0 라이선스에 따라 라이선스가 부여됩니다. 자세한 내용은 Google Developers 사이트 정책을 참조하세요. 자바는 Oracle 및/또는 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)."]]