Directory API: ชื่อแทนของผู้ใช้

สร้างชื่อแทนของผู้ใช้

อีเมลแทนของผู้ใช้คืออีเมลอื่นที่ใช้กล่องจดหมายเดียวกับที่อีเมลหลักของผู้ใช้ใช้ อีเมลแทนของผู้ใช้จะเชื่อมโยงกับโดเมนบัญชีอื่นที่ไม่ใช่โดเมนที่ใช้โดยอีเมลหลักของผู้ใช้ได้ ผู้ใช้จะเริ่มได้รับอีเมลที่ส่งไปยังอีเมลนี้ภายใน 24 ชั่วโมง (แต่โดยมากจะเร็วกว่านั้น) API กำหนดให้ยืนยันการเป็นเจ้าของโดเมนก่อนจึงจะสร้างชื่อแทนผู้ใช้ได้

หากต้องการสร้างอีเมลแทนผู้ใช้ ให้ใช้คำขอ POST ต่อไปนี้และรวมการให้สิทธิ์ที่อธิบายไว้ในคำขอสิทธิ์ โดย userKey อาจเป็นอีเมลหลักของผู้ใช้ id ของผู้ใช้ หรืออีเมลของอีเมลแทนของผู้ใช้ ดูพร็อพเพอร์ตี้คำขอและการตอบกลับได้ในเอกสารอ้างอิง API 

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

คำขอ JSON

คำขอ JSON ต่อไปนี้แสดงตัวอย่างคำขอสร้างอีเมลแทนของผู้ใช้ ผู้ใช้คือ liz@example.com และอีเมลแทนคือ chica@example.com 

POST https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases
 เนื้อหาของคำขอมีข้อมูลใหม่สำหรับอีเมลแทน ดังนี้ 
{  
 "alias": "chica@example.com"
}

การตอบกลับที่สำเร็จจะแสดงรหัสสถานะ HTTP 201 นอกเหนือจากรหัสสถานะแล้ว การตอบสนองจะแสดงพร็อพเพอร์ตี้สำหรับอีเมลแทนของผู้ใช้ใหม่ด้วย

เรียกข้อมูลอีเมลแทนทั้งหมดของผู้ใช้

หากต้องการดึงข้อมูลอีเมลแทนทั้งหมดของผู้ใช้ในโดเมนทั้งหมด ให้ใช้คำขอ GET ต่อไปนี้และรวมการให้สิทธิ์ที่อธิบายไว้ในคำขอสิทธิ์ โดย userKey อาจเป็นอีเมลหลักของผู้ใช้ id ของผู้ใช้ หรืออีเมลของอีเมลแทนของผู้ใช้ ดูพร็อพเพอร์ตี้คำขอและการตอบกลับได้ในเอกสารอ้างอิง API 

GET https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
 ตัวอย่างเช่น URI คำขอนี้จะแสดงแทนทั้งหมดสำหรับคีย์ผู้ใช้ liz@example.com 
GET https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases

ระบบจะแสดงอีเมลแทนผู้ใช้ทั้งหมดตามลําดับตัวอักษร ไม่มีขนาดหน้า เช่น สตริงการค้นหา maxResults หรือการแบ่งหน้าที่ใช้สำหรับการตอบกลับ "เรียกข้อมูลแทนทั้งหมด"

การตอบสนองของ JSON

การตอบกลับที่สำเร็จจะแสดงรหัสสถานะ HTTP 200 นอกเหนือจากรหัสสถานะแล้ว การตอบกลับจะแสดงอีเมลแทนของผู้ใช้ตามลําดับตัวอักษรด้วย โดเมนแทนเหล่านี้คือโดเมนหลักและโดเมนอื่นๆ หลายรายการในบัญชี 

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

ลบอีเมลแทนของผู้ใช้

หากต้องการลบอีเมลแทนของผู้ใช้ ให้ใช้คำขอ DELETE ต่อไปนี้และรวมการให้สิทธิ์ที่อธิบายไว้ในคำขอสิทธิ์ การนำอีเมลแทนออกอาจใช้เวลานานถึง 24 ชั่วโมง userKey อาจเป็นอีเมลหลักของผู้ใช้ id ของผู้ใช้ หรืออีเมลของอีเมลแทนของผู้ใช้ และ aliasId คืออีเมลของอีเมลแทนที่จะลบ ดูพร็อพเพอร์ตี้คำขอและการตอบกลับได้ที่เอกสารอ้างอิง API 

DELETE https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases/aliasId
 ตัวอย่างเช่น คําขอ DELETE นี้จะลบอีเมลแทน chica@example.com สําหรับ userKey liz@example.com 
DELETE https://admin.googleapis.com/admin/directory/v1/users/liz@example.com/aliases/chica@example.com

การตอบกลับที่สำเร็จจะแสดงรหัสสถานะ HTTP 200