สร้างชื่อแทนผู้ใช้
อีเมลแทนของผู้ใช้คืออีเมลอื่นที่ใช้กล่องจดหมายเดียวกันกับที่อีเมลหลักของผู้ใช้ใช้ ชื่อแทนผู้ใช้จะเชื่อมโยงกับโดเมนบัญชีที่แตกต่างจากโดเมนที่ใช้โดยอีเมลหลักของผู้ใช้ได้ ผู้ใช้จะเริ่มได้รับอีเมลที่ส่งไปยังอีเมลนี้ภายใน 24 ชั่วโมง (แต่โดยมากจะเร็วกว่านั้น) API กำหนดให้ต้องยืนยันความเป็นเจ้าของโดเมนก่อนจึงจะสร้างชื่อแทนผู้ใช้ได้
หากต้องการสร้างชื่อแทนผู้ใช้ ให้ใช้คำขอ POST ต่อไปนี้และรวมการให้สิทธิ์ที่อธิบายไว้ในส่วนให้สิทธิ์คำขอ userKey อาจเป็นอีเมลหลักของผู้ใช้, id หรืออีเมลชื่อแทนของผู้ใช้ก็ได้ สำหรับพร็อพเพอร์ตี้คำขอและการตอบกลับ โปรดดูเอกสารอ้างอิง API ดังนี้
POST https://admin.googleapis.com/admin/directory/v1/users/userKey/aliases
คำขอ JSON
คำขอ JSON ต่อไปนี้แสดงตัวอย่างคำขอเพื่อสร้างชื่อแทนของผู้ใช้ ผู้ใช้คือ liz@example.com และชื่อแทนคือ Chicago@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