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