Method: users.settings.cse.keypairs.list

認証されたユーザーのクライアントサイド暗号化鍵ペアを一覧表示します。

HTTP リクエスト

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

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
userId

string

リクエスト元のメインのメールアドレス。認証済みユーザーを指定するには、特別な値 me を使用します。

クエリ パラメータ

パラメータ
pageToken

string

キーペアのどのページを返すかを示すページネーション トークン。トークンが指定されていない場合、API は結果の最初のページを返します。

pageSize

integer

返される鍵ペアの数。指定しない場合、ページサイズはデフォルトで 20 エントリになります。

リクエスト本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功すると、レスポンスの本文に次の構造のデータが含まれます。

JSON 表現
{
  "cseKeyPairs": [
    {
      object (CseKeyPair)
    }
  ],
  "nextPageToken": string
}
フィールド
cseKeyPairs[]

object (CseKeyPair)

ユーザーに対してインストールされた CSE 鍵ペアのリストの 1 ページ。

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

詳細については、承認ガイドをご覧ください。