Directory API: Bí danh của người dùng

Tạo email đại diện của người dùng

Email đại diện của người dùng là địa chỉ email thay thế sử dụng chính hộp thư mà địa chỉ email chính của người dùng sử dụng. Bí danh của người dùng có thể được liên kết với một miền tài khoản khác với miền mà địa chỉ email chính của người dùng sử dụng. Trong vòng 24 giờ (thường là sớm hơn), người dùng bắt đầu nhận được email được gửi đến địa chỉ này. API này yêu cầu bạn phải xác nhận quyền sở hữu miền thì mới có thể tạo bí danh người dùng.

Để tạo email đại diện của người dùng, hãy sử dụng yêu cầu POST sau đây và thêm quyền uỷ quyền được mô tả trong phần Uỷ quyền cho yêu cầu. userKey có thể là địa chỉ email chính của người dùng, người dùng id hoặc bất kỳ email đại diện nào của người dùng. Để biết các thuộc tính yêu cầu và phản hồi, hãy xem Tài liệu tham khảo API: 

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

Yêu cầu JSON

Yêu cầu JSON sau đây cho thấy một yêu cầu mẫu để tạo email đại diện của người dùng. Người dùng là liz@example.com và bí danh là Chica@example.com: 

POST https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases
Nội dung yêu cầu có thông tin đại diện mới: 
{  
 "alias": "chica@example.com"
}

Phản hồi thành công sẽ trả về mã trạng thái HTTP 201. Cùng với mã trạng thái, phản hồi sẽ trả về các thuộc tính cho bí danh người dùng mới.

Truy xuất tất cả bí danh của người dùng

Để truy xuất tất cả email đại diện của một người dùng trên tất cả các miền, hãy sử dụng yêu cầu GET sau đây và thêm uỷ quyền được mô tả trong phần Uỷ quyền yêu cầu. userKey có thể là địa chỉ email chính của người dùng, người dùng id hoặc bất kỳ email đại diện nào của người dùng. Để biết các thuộc tính yêu cầu và phản hồi, hãy xem Tài liệu tham khảo API: 

GET https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
Ví dụ: URI yêu cầu này trả về tất cả tên đại diện cho khoá người dùng, liz@example.com: 
GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases

Tất cả email đại diện của người dùng đều được trả về theo thứ tự bảng chữ cái. Không có kích thước trang nào, chẳng hạn như chuỗi truy vấn maxResults hoặc cách phân trang dùng cho phản hồi "Truy xuất tất cả biệt hiệu".

Nội dung phản hồi JSON

Phản hồi thành công sẽ trả về mã trạng thái HTTP 200. Cùng với mã trạng thái, câu trả lời sẽ trả về email đại diện của người dùng theo thứ tự bảng chữ cái. Các miền bí danh này là miền chính và nhiều miền khác trong tài khoản: 

{
"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"
 }
]
}

Xoá email đại diện của người dùng

Để xoá một email đại diện của người dùng, hãy sử dụng yêu cầu DELETE sau đây và đưa vào quyền được mô tả trong phần Yêu cầu cho phép. Quá trình xoá bí danh có thể mất đến 24 giờ. userKey có thể là địa chỉ email chính của người dùng, người dùng id hoặc bất kỳ email đại diện nào của người dùng. Và aliasId là địa chỉ email của bí danh sẽ bị xoá. Để biết các thuộc tính yêu cầu và phản hồi, hãy xem Tài liệu tham khảo API. 

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasId
Ví dụ: yêu cầu DELETE này sẽ xoá bí danh Chica@example.com của userKey, liz@example.com: 
DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com

Phản hồi thành công sẽ trả về mã trạng thái HTTP 200.