Directory API: Alias Pengguna

Membuat alias pengguna

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

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

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

Permintaan JSON

Permintaan JSON berikut menunjukkan contoh permintaan untuk membuat alias pengguna. Penggunanya adalah liz@example.com dan aliasnya adalah chica@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.

Mengambil semua alias pengguna

Untuk mengambil semua alias pengguna di semua domain, gunakan permintaan GET berikut dan sertakan otorisasi yang dijelaskan dalam Meminta otorisasi. userKey dapat berupa alamat email utama pengguna, id pengguna, atau email alias pengguna. 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 respons 'Retrieve all aliases'.

Respons JSON

Respons yang berhasil akan menampilkan kode status HTTP 200. Bersama dengan kode status, respons akan menampilkan alias pengguna dalam urutan abjad. Domain alias ini adalah domain primer dan beberapa domain lain 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 Meminta otorisasi. Diperlukan waktu hingga 24 jam agar alias berhasil dihapus. userKey dapat berupa alamat email utama pengguna, id pengguna, atau email alias pengguna. Dan aliasId adalah alamat email alias yang sedang 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.