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

Tạo bí danh người dùng

Email đại diện của người dùng là một địa chỉ email thay thế sử dụng cùng một hộp thư mà địa chỉ email chính của người dùng sử dụng. Bạn có thể liên kết bí danh người dùng 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 sẽ bắt đầu nhận được email được gửi đến địa chỉ này. API 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 bí danh 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 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ỳ email nào của bí danh người dùng. Đối với 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 bí danh 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 về bí danh 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ả bí danh của 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ỳ email nào của bí danh người dùng. Đối với 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ả các bí danh cho userKey, liz@example.com: 
GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases

Tất cả bí danh 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 như chuỗi truy vấn maxResults hoặc phân trang được dùng cho phản hồi "Truy xuất tất cả bí danh".

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, phản hồi sẽ trả về các bí danh của người dùng theo thứ tự bảng chữ cái. Những 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á bí danh của người dùng

Để xoá bí danh người dùng, hãy sử dụng yêu cầu DELETE sau đây và thêm quyền uỷ quyền được mô tả trong phần Uỷ quyền yêu cầu. 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, id của người dùng hoặc bất kỳ email nào của bí danh người dùng. Còn aliasId là địa chỉ email của bí danh đang bị xoá. Đối với 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 cho 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.