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 คำขอนี้จะแสดงผลอีเมลแทนทั้งหมดสำหรับ userKey, 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