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 primer pengguna. Dalam waktu 24 jam (sering kali lebih cepat), pengguna akan mulai menerima email yang dikirim ke alamat ini. API ini mengharuskan kepemilikan domain dikonfirmasi sebelum Anda dapat membuat alias pengguna.

Untuk membuat alias pengguna, gunakan permintaan POST berikut dan sertakan otorisasi yang dijelaskan dalam Permintaan otorisasi. userKey dapat berupa alamat email utama pengguna, id pengguna, atau email alias pengguna apa pun. 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
Isi permintaan memiliki informasi alias baru:
{  
 "alias": "chica@example.com"
}

Respons yang berhasil akan menampilkan kode status HTTP 201. Bersama dengan kode status, responsnya 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 Permintaan otorisasi. userKey dapat berupa alamat email utama pengguna, id pengguna, atau email alias pengguna apa pun. Untuk properti permintaan dan respons, lihat Referensi API:

GET https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
Misalnya, URI permintaan ini menampilkan semua alias untuk userKey, liz@example.com:
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 atau penomoran halaman maxResults yang digunakan untuk respons 'Ambil semua alias'.

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 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 di Permintaan otorisasi. Diperlukan waktu hingga 24 jam untuk menghapus alias. userKey dapat berupa alamat email utama pengguna, id pengguna, atau email alias pengguna apa pun. 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
Misalnya, permintaan DELETE ini akan menghapus alias chica@example.com untuk userKey, liz@example.com:
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.