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

자세한 내용은 승인 가이드를 참고하세요.