Directory API: Alias Pengguna

Membuat alias pengguna

Alias pengguna adalah alamat email alternatif yang menggunakan kotak surat yang sama dengan yang digunakan alamat email utama Anda. Alias pengguna dapat dikaitkan dengan domain akun yang berbeda dengan yang domain yang digunakan oleh alamat email utama pengguna. Dalam waktu 24 jam (seringnya lebih cepat), pengguna memulai menerima email yang dikirim ke alamat ini. API mengharuskan kepemilikan domain telah dikonfirmasi sebelum Anda dapat membuat alias pengguna.

Untuk membuat alias pengguna, gunakan permintaan POST berikut dan sertakan otorisasi yang dijelaskan dalam Otorisasi permintaan. userKey dapat berupa alamat email utama pengguna, pengguna id, atau alias pengguna mana pun. email. Untuk properti permintaan dan respons, lihat Referensi API:

POST https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases

Permintaan JSON

Permintaan JSON berikut menampilkan contoh permintaan untuk membuat alias pengguna. Penggunanya adalah liz@example.com dan aliasnya adalah cewek@example.com:

POST https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases

{  
 "alias": "chica@example.com"
}

Respons yang berhasil akan menampilkan kode status HTTP 201. Bersama dengan kode status, respons akan menampilkan properti untuk alias pengguna baru.

Ambil semua alias pengguna

Untuk mengambil semua alias pengguna di semua domain, gunakan permintaan GET berikut dan sertakan otorisasi yang dijelaskan dalam Otorisasi permintaan. userKey dapat berupa alamat email utama pengguna, pengguna id, atau alias pengguna mana pun. email. Untuk properti permintaan dan respons, lihat Referensi API:

GET https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases

GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases

Semua alias pengguna ditampilkan dalam urutan abjad. Tidak ada ukuran halaman seperti string kueri maxResults atau penomoran halaman yang digunakan untuk 'Ambil semua alias' yang dihasilkan.

Respons JSON

Respons yang berhasil akan menampilkan kode status HTTP 200. Selain kode status, respons akan menampilkan alias pengguna dalam urutan abjad. Domain alias berikut adalah domain primer dan beberapa domain lainnya di akun:

{
"kind": "directory#user#aliases",
"aliases": [
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "liz@example.com",
  "alias": "chica@example.com"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "liz@example.com",
  "alias": "support@example.com"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "liz@example.com",
  "alias": "help@hr.example.com"
 },
 {
  "kind": "directory#user#alias",
  "id": "the unique user id",
  "primary_email": "liz@example.com",
  "alias": "tickets@jumboinc.com"
 }
]
}

Menghapus alias pengguna

Untuk menghapus alias pengguna, gunakan permintaan DELETE berikut dan sertakan otorisasi yang dijelaskan dalam Mengizinkan permintaan. Dapat memerlukan hingga 24 jam agar alias dihapus. Tujuan userKey dapat berupa alamat email utama pengguna, pengguna id, atau salah satu dari alias pengguna' email. Dan aliasId adalah aliasnya alamat email yang digunakan dihapus. Untuk properti permintaan dan respons, lihat Referensi API.

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasId

DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com

Respons yang berhasil akan menampilkan kode status HTTP 200.