- Permintaan HTTP
- Parameter lokasi
- Parameter kueri
- Isi permintaan
- Isi respons
- Cakupan otorisasi
- Cobalah!
Mencantumkan pasangan kunci enkripsi sisi klien untuk pengguna yang diautentikasi.
Untuk administrator yang mengelola identitas dan pasangan kunci enkripsi bagi pengguna di organisasi mereka, permintaan memerlukan otorisasi dengan akun layanan yang memiliki otoritas delegasi seluruh domain untuk meniru identitas pengguna dengan cakupan https://www.googleapis.com/auth/gmail.settings.basic
.
Untuk pengguna yang mengelola identitas dan pasangan kunci mereka sendiri, permintaan memerlukan enkripsi kunci hardware yang diaktifkan dan dikonfigurasi.
Permintaan HTTP
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs
URL menggunakan sintaksis gRPC Transcoding.
Parameter jalur
Parameter | |
---|---|
userId |
Alamat email utama pemohon. Untuk menunjukkan pengguna yang diautentikasi, Anda dapat menggunakan nilai khusus |
Parameter kueri
Parameter | |
---|---|
pageToken |
Token penomoran halaman yang menunjukkan halaman pasangan kunci yang akan ditampilkan. Jika token tidak diberikan, API akan menampilkan halaman pertama hasil. |
pageSize |
Jumlah pasangan kunci yang akan ditampilkan. Jika tidak diberikan, ukuran halaman akan ditetapkan secara default ke 20 entri. |
Isi permintaan
Isi permintaan harus kosong.
Isi respons
Jika berhasil, isi respons memuat data dengan struktur berikut:
Representasi JSON |
---|
{
"cseKeyPairs": [
{
object ( |
Kolom | |
---|---|
cseKeyPairs[] |
Satu halaman dari daftar pasangan kunci CSE yang diinstal untuk pengguna. |
nextPageToken |
Token penomoran halaman yang akan diteruskan ke panggilan keypairs.list berikutnya untuk mengambil halaman pasangan kunci berikutnya. Jika nilai ini tidak ditampilkan, tidak ada halaman lebih lanjut. |
Cakupan otorisasi
Memerlukan salah satu cakupan OAuth berikut:
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
Untuk mengetahui informasi selengkapnya, lihat Panduan otorisasi.