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

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

Bí danh của người dùng là địa chỉ email thay thế sử dụng cùng một hộp thư được địa chỉ email chính. Email đại diện 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 đó tên miền được sử dụng bởi địa chỉ email chính của người dùng. Trong vòng 24 giờ (thường sớm hơn), người dùng bắt đầu nhận email gửi đến địa chỉ này. API yêu cầu rằng quyền sở hữu miền được xác nhận trước khi có thể tạo email đại diện của người dùng.

Để tạo một email đại diện của người dùng, hãy sử dụng yêu cầu POST sau đây và bao gồm việc 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, id của người dùng hoặc bất kỳ bí danh 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à email đại diện là hota@example.com:

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

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

Khi phản hồi thành công, hệ thống sẽ trả về mã trạng thái HTTP 201. Cùng với mã trạng thái, phản hồi 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 thông tin 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, id của người dùng hoặc bất kỳ bí danh 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

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

Tất cả bí danh của người dùng đượ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 phân trang được dùng cho thao tác "Truy xuất tất cả bí danh" của bạn.

Nội dung phản hồi JSON

Khi phản hồi thành công, hệ thống sẽ trả về mã trạng thái HTTP 200. Cùng với mã trạng thái, phản hồi trả về bí danh 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á email đại diện của người dùng, hãy sử dụng yêu cầu DELETE sau đây và thêm uỷ quyền được mô tả trong Uỷ quyền cho các yêu cầu. Quá trình này có thể mất đến 24 giờ để xóa bí danh. Chiến lược phát hành đĩa đơn 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ỳ bí danh người dùng . Và aliasId là bí danh' đang được đã 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

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

Khi phản hồi thành công, hệ thống sẽ trả về mã trạng thái HTTP 200.