สร้างชื่อแทนผู้ใช้
ชื่อแทนของผู้ใช้คืออีเมลอื่นที่ใช้กล่องจดหมายเดียวกับที่ผู้ใช้ อีเมลหลัก ชื่อแทนของผู้ใช้สามารถเชื่อมโยงกับโดเมนบัญชีอื่นที่ไม่ใช่โดเมนบัญชีนั้นได้ โดเมนที่ที่อยู่อีเมลหลักของผู้ใช้ใช้ ผู้ใช้จะเริ่มภายใน 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