ภาพรวมของ Admin Settings API

Admin Settings API ช่วยให้ผู้ดูแลระบบโดเมน Google Workspace ดึงข้อมูลและเปลี่ยนแปลงการตั้งค่าโดเมนในรูปแบบฟีด Google Data API ได้

การตั้งค่าโดเมนเหล่านี้ประกอบด้วยฟีเจอร์มากมายที่มีอยู่ในคอนโซลผู้ดูแลระบบ Google Workspace ตัวอย่างการใช้ API นี้ ได้แก่ การสร้างแผงควบคุมที่กำหนดเองหรือการผสานรวมโดเมน Google Workspace เข้ากับสภาพแวดล้อมเดิมที่มีอยู่

Admin Settings API ใช้โปรโตคอล Google Data API Google Data API เป็นไปตามรูปแบบการเผยแพร่และการแก้ไขของ Atom Publishing Protocol (AtomPub) คำขอ HTTP ของ AtomPub ใช้แนวทางการออกแบบ Representational Set Transfer (RESTful) สำหรับเว็บเซอร์วิส ดูข้อมูลเพิ่มเติมได้ที่คู่มือนักพัฒนาซอฟต์แวร์ Google Data

ผู้ชม

เอกสารนี้มีไว้สำหรับนักพัฒนาแอปที่ต้องการเขียนแอปพลิเคชันไคลเอ็นต์ที่แก้ไขและเรียกข้อมูลเกี่ยวกับโดเมน Google Workspace ได้ ซึ่งแสดงตัวอย่างการโต้ตอบพื้นฐานของ Admin Settings API โดยใช้ XML ดิบและ HTTP

เอกสารนี้ถือว่าคุณเข้าใจแนวคิดทั่วไปที่อยู่เบื้องหลังโปรโตคอล Google Data API และคุณคุ้นเคยกับคอนโซลผู้ดูแลระบบ Google Workspace ดูข้อมูลเพิ่มเติมเกี่ยวกับคอนโซลผู้ดูแลระบบได้ที่หัวข้อใช้คอนโซลผู้ดูแลระบบ

เริ่มต้นใช้งาน

การสร้างบัญชี

Admin Settings API เปิดใช้สำหรับบัญชี Google Workspace ลงชื่อสมัครใช้บัญชี Google Workspace เพื่อวัตถุประสงค์ในการทดสอบ บริการการตั้งค่าผู้ดูแลระบบใช้บัญชี Google ดังนั้นหากคุณมีบัญชีในโดเมน Google Workspace อยู่แล้ว ก็พร้อมใช้งาน

เกี่ยวกับประเภทฟีด Admin Settings API

Admin Settings API ช่วยให้คุณจัดการการตั้งค่าโดเมนในหมวดหมู่ต่อไปนี้ได้

การตั้งค่าการลงชื่อเพียงครั้งเดียว

การลงชื่อเพียงครั้งเดียว (SSO) ที่ใช้ SAML ช่วยให้ผู้ใช้ใช้ข้อมูลเข้าสู่ระบบและรหัสผ่านเดียวกันสำหรับทั้งบริการที่โฮสต์ใน Google Workspace และบริการอื่นๆ ที่คุณอาจโฮสต์ภายในองค์กรได้ โดยเฉพาะอย่างยิ่งเมื่อใช้ SSO เว็บแอปพลิเคชันที่โฮสต์ เช่น Google Workspace จะเปลี่ยนเส้นทางผู้ใช้ไปยังผู้ให้บริการข้อมูลประจำตัวขององค์กรเพื่อตรวจสอบสิทธิ์ผู้ใช้เมื่อเข้าสู่ระบบ ดูข้อมูลโดยละเอียดได้ที่การทำความเข้าใจ SSO ที่ใช้ SAML สำหรับ Google Workspace

การกำหนดค่า SSO เกี่ยวข้องกับการป้อนข้อมูลที่จำเป็นสำหรับบริการ Google Workspace เพื่อสื่อสารกับผู้ให้บริการข้อมูลประจำตัวที่จัดเก็บข้อมูลเข้าสู่ระบบของผู้ใช้ รวมถึงการตั้งค่าลิงก์ที่ควรส่งให้ผู้ใช้เพื่อเข้าสู่ระบบ ออกจากระบบ และเปลี่ยนรหัสผ่าน Admin Settings API ช่วยให้คุณอัปเดตและดึงข้อมูลการตั้งค่าเหล่านี้แบบเป็นโปรแกรมได้ Google จะใช้คีย์สาธารณะที่คุณสร้างขึ้นเพื่อยืนยันคําขอ SSO นี้กับผู้ให้บริการข้อมูลประจําตัว และยืนยันว่าไม่มีการแก้ไขการตอบกลับ SAML ของคีย์ส่วนตัวระหว่างการรับส่งข้อมูลทางเครือข่าย

ดูสรุปสั้นๆ เกี่ยวกับการใช้การตั้งค่า SSO สำหรับ API เฉพาะได้ที่ใบรับรองคีย์สาธารณะจากผู้ให้บริการข้อมูลประจําตัว ลงทะเบียนคีย์สาธารณะกับ Google และตั้งค่าการค้นหา SSO ตามข้อกําหนด SAML โปรดดูข้อความแสดงข้อผิดพลาดที่หัวข้อการแก้ปัญหาเกี่ยวกับ SSO

  • สร้างคีย์ - สร้างชุดคีย์สาธารณะและส่วนตัวโดยใช้อัลกอริทึม DSA หรือ RSA กับผู้ให้บริการข้อมูลประจำตัว คีย์สาธารณะอยู่ในใบรับรองรูปแบบ X.509 ดูข้อมูลเพิ่มเติมเกี่ยวกับคีย์การลงนามสำหรับการลงชื่อเพียงครั้งเดียวด้วย SAML ได้ที่หัวข้อการสร้างคีย์และใบรับรองสำหรับบริการการลงชื่อเพียงครั้งเดียวของ Google Workspace
  • ลงทะเบียนกับ Google - ใช้การตั้งค่าการลงชื่อเพียงครั้งเดียวของ Admin Settings API เพื่อลงทะเบียนใบรับรองคีย์สาธารณะกับ Google
  • ตั้งค่า SSO - ใช้การตั้งค่าการลงชื่อเพียงครั้งเดียวของ Admin Settings API เพื่อกําหนดการตั้งค่าที่ใช้สื่อสารกับเซิร์ฟเวอร์ของผู้ให้บริการข้อมูลประจําตัวของโดเมน

การตั้งค่าเกตเวย์และการกำหนดเส้นทาง

ฟีดนี้ช่วยให้ผู้ดูแลระบบโดเมนควบคุมการกำหนดเส้นทางอีเมลสำหรับโดเมนของตนได้

การดำเนินการกำหนดเส้นทางอีเมลช่วยให้ผู้ดูแลระบบระบุการตั้งค่าการกำหนดเส้นทางอีเมลระดับโดเมนได้ ซึ่งคล้ายกับฟังก์ชันการกำหนดเส้นทางอีเมลของการตั้งค่า Gmail ในคอนโซลผู้ดูแลระบบ ดูข้อมูลเพิ่มเติมได้ที่การกำหนดเส้นทางอีเมลและการกำหนดค่าการนำส่งแบบคู่ของฟีเจอร์การกำหนดเส้นทางอีเมล

ตัวอย่างคำขอและคำตอบ XML ของ Admin Settings API

เอกสารนี้แสดงตัวอย่างโค้ดของคำขอและคำตอบ Admin Settings API พื้นฐานโดยใช้ XML ดิบและ HTTP ตัวอย่างภาษาเริ่มต้นของโดเมนนี้แสดงไวยากรณ์ XML และ HTTP แบบเต็มสำหรับเนื้อหาของคำขอและรายการการตอบกลับ ซึ่งใช้ร่วมกันในการดำเนินการแต่ละรายการ

หากต้องการเปลี่ยนการตั้งค่าเกตเวย์อีเมลขาออกของโดเมน ให้ส่ง HTTP PUT ไปยัง URL ฟีดเกตเวย์ ดังนี้

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

XML PUT คำขอ AtomPub entry ภาษาเริ่มต้นของโดเมนคือ

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom'
  xmlns:apps='http://schemas.google.com/apps/2006'>
  <apps:property name='smartHost' value='smtp.out.domain.com' />
  <apps:property name='smtpMode' value='SMTP' />
</atom:entry>

ยกเว้นพร็อพเพอร์ตี้และค่าเฉพาะการดำเนินการ องค์ประกอบ atom:property จะแสดงคู่คีย์-ค่าเดียวที่มีข้อมูลเกี่ยวกับพร็อพเพอร์ตี้ที่คุณต้องการดึงข้อมูลหรืออัปเดต ซึ่งจะดำเนินการแบบนี้ในทุกเนื้อหาคำขอของ Admin Settings API

องค์ประกอบ entry ของการตอบกลับภาษาเริ่มต้นของโดเมนจะแสดงพร็อพเพอร์ตี้ smartHost และ smtpMode พร้อมกับไวยากรณ์ XML ที่ใช้ร่วมกันกับเนื้อหาการตอบกลับของ Admin Settings API ทั้งหมด ดังนี้

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<id>https://apps-apis.google.com/a/feeds/domain/2.0/domainName/email/gateway</id>
<updated>2008-12-17T23:59:23.887Z</updated>
<link rel='self' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/domain/
  2.0/domainName/email/gateway'/>
<link rel='edit' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/domain/
  2.0/domainName/email/gateway'/>
<apps:property name='smartHost' value='smtp.out.domain.com' />
<apps:property name='smtpMode' value='SMTP' />
</entry>

การจัดการการตั้งค่าการลงชื่อเพียงครั้งเดียว

ฟีเจอร์การลงชื่อเพียงครั้งเดียว (SSO) ของ Google Workspace ช่วยให้ผู้ใช้เข้าสู่ระบบบริการหลายรายการได้โดยไม่ต้องป้อนข้อมูลเข้าสู่ระบบและรหัสผ่านซ้ำ รหัสผ่านนี้จะจัดเก็บโดยผู้ให้บริการข้อมูลประจำตัวของโดเมน ไม่ใช่ Google Workspace ดูข้อมูลเพิ่มเติมได้ที่หน้า SSO ของศูนย์ช่วยเหลือ ส่วนต่อไปนี้แสดงรูปแบบ XML ที่ใช้สำหรับการตั้งค่าการลงชื่อเพียงครั้งเดียว

กำลังเรียกข้อมูลการตั้งค่าการลงชื่อเพียงครั้งเดียว

หากต้องการเรียกข้อมูลการตั้งค่าการลงชื่อเพียงครั้งเดียว ให้ส่ง HTTP GET ไปยัง URL ของฟีดทั่วไปของ SSO และใส่ส่วนหัว Authorization ตามที่อธิบายไว้ในการตรวจสอบสิทธิ์กับบริการการตั้งค่าผู้ดูแลระบบ และดูข้อความแสดงข้อผิดพลาดได้ที่การแก้ปัญหาเกี่ยวกับ SSO

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/general

การดำเนินการนี้ไม่มีพารามิเตอร์ในเนื้อหาคำขอ

การตอบกลับที่สำเร็จจะแสดงรหัสสถานะ HTTP 200 OK พร้อมกับฟีด AtomPub ที่มีการตั้งค่า SSO ของโดเมน

XML ของคำตอบ GET จะแสดงผลพร็อพเพอร์ตี้ samlSignonUri, samlLogoutUri, changePasswordUri, enableSSO, ssoWhitelist และ useDomainSpecificIssuer ดังนี้

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon'/>
...
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout'/>
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword'/>
<apps:property name='enableSSO' value='true'/>
<apps:property name='ssoWhitelist' value='CIDR formatted IP address'/>
<apps:property name='useDomainSpecificIssuer' value='false'/>
</entry>

พร็อพเพอร์ตี้ดังกล่าวมีดังนี้

samlSignonUri
URL ของผู้ให้บริการข้อมูลประจำตัวที่ Google Workspace ส่งคำขอ SAML เพื่อตรวจสอบสิทธิ์ผู้ใช้
samlLogoutUri
ที่อยู่ที่จะส่งผู้ใช้เมื่อออกจากระบบเว็บแอปพลิเคชัน
changePasswordUri
ที่อยู่ที่จะส่งผู้ใช้ไปเมื่อต้องการเปลี่ยนรหัสผ่าน SSO สำหรับเว็บแอปพลิเคชัน
enableSSO
เปิดใช้ SSO ที่ใช้ SAML สำหรับโดเมนนี้ หากคุณเคยกําหนดการตั้งค่า SSO ไว้ก่อนหน้านี้ และต่อมาได้ตั้งค่า enableSSO เป็น enableSSO=false ระบบจะยังคงบันทึกการตั้งค่าที่คุณป้อนไว้ก่อนหน้านี้
ssoWhitelist
ssoWhitelist คือที่อยู่ IP ของเน็ตเวิร์กมาสก์ในรูปแบบ Classless Inter-Domain Routing (CIDR) ssoWhitelist จะกำหนดผู้ใช้ที่เข้าสู่ระบบโดยใช้ SSO และผู้ใช้ที่เข้าสู่ระบบโดยใช้หน้าการตรวจสอบสิทธิ์บัญชี Google Workspace หากไม่ได้ระบุมาสก์ไว้ ผู้ใช้ทุกคนจะเข้าสู่ระบบโดยใช้ SSO ดูข้อมูลเพิ่มเติมได้ที่มาสก์เครือข่ายทํางานอย่างไร
useDomainSpecificIssuer
ใช้ผู้ให้บริการเฉพาะของโดเมนได้ในคําขอ SAML ที่ส่งไปยังผู้ให้บริการข้อมูลประจําตัว แม้ว่าจะไม่จำเป็นต้องใช้กับการใช้งาน SSO ส่วนใหญ่ แต่ฟีเจอร์นี้มีประโยชน์ในบริษัทขนาดใหญ่ที่ใช้ผู้ให้บริการข้อมูลประจำตัวรายเดียวเพื่อตรวจสอบสิทธิ์ทั้งองค์กรที่มีโดเมนย่อยหลายรายการ การให้ข้อมูลผู้ให้บริการโดเมนที่เฉพาะเจาะจงจะเป็นตัวกำหนดว่าควรเชื่อมโยงโดเมนย่อยใดกับคำขอ ดูข้อมูลเพิ่มเติมได้ที่องค์ประกอบ Issuer ในคำขอ SAML ทํางานอย่างไร

หากคำขอไม่สำเร็จเนื่องจากเหตุผลใดก็ตาม ระบบจะแสดงรหัสสถานะอื่น ดูข้อมูลเพิ่มเติมเกี่ยวกับรหัสสถานะของ Google Data API ได้ที่รหัสสถานะ HTTP

อัปเดตการตั้งค่าการลงชื่อเพียงครั้งเดียว

หากต้องการอัปเดตการตั้งค่า SSO ของโดเมน ให้ดึงข้อมูลการตั้งค่า SSO โดยใช้การดำเนินการการดึงข้อมูลการตั้งค่าการลงชื่อเพียงครั้งเดียว จากนั้นแก้ไข แล้วส่งคําขอ PUT ไปยัง URL ฟีด SSO ตรวจสอบว่าค่า <id> ในรายการที่อัปเดตตรงกับ <id> ของรายการที่มีอยู่ทุกประการ ใส่ส่วนหัว Authorization ตามที่อธิบายไว้ในการตรวจสอบสิทธิ์กับบริการ Admin Settings API และดูข้อความแสดงข้อผิดพลาดได้ที่การแก้ปัญหา SSO

เมื่ออัปเดตการตั้งค่าการลงชื่อเพียงครั้งเดียว ให้ส่ง HTTP PUT ไปยัง URL ของฟีดทั่วไป SSO โดยทำดังนี้

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/general

เนื้อความ XML ของคำขอ PUT คือ

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
<apps:property name='enableSSO' value='false' />
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon' />
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout' />
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword' />
<apps:property name='ssoWhitelist' value='127.0.0.1/32' />
<apps:property name='useDomainSpecificIssuer' value='false'/>
</atom:entry>

การตอบกลับที่สำเร็จจะแสดงรหัสสถานะ HTTP 200 OK พร้อมกับฟีด AtomPub ที่มีการตั้งค่า SSO

XML การตอบกลับ PUT คือ

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='samlSignonUri' value='http://www.example.com/sso/signon'/>
<apps:property name='samlLogoutUri' value='http://www.example.com/sso/logout'/>
<apps:property name='changePasswordUri' value='http://www.example.com/sso/changepassword'/>
<apps:property name='enableSSO' value='false'/>
<apps:property name='ssoWhitelist' value='127.0.0.1/32'/>
<apps:property name='useDomainSpecificIssuer' value='false'/>
</entry>

หากคำขอไม่สำเร็จเนื่องจากเหตุผลใดก็ตาม ระบบจะแสดงรหัสสถานะอื่น ดูข้อมูลเพิ่มเติมเกี่ยวกับรหัสสถานะของ Google Data API ได้ที่รหัสสถานะ HTTP

ระบบไม่อนุญาตให้เปลี่ยนแปลงการตั้งค่าการลงชื่อเพียงครั้งเดียวเมื่อลูกค้าเป้าหมายเปิดใช้การอนุมัติจากผู้ที่มีสิทธิ์สําหรับการดําเนินการที่มีความละเอียดอ่อน คำขอจะดำเนินการไม่สำเร็จด้วย errorCode="1811" และ reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval"

ดึงข้อมูลคีย์การลงชื่อของ Single Sign-On

หากต้องการเรียกข้อมูลคีย์การรับรองการลงชื่อเพียงครั้งเดียว ให้ส่ง HTTP GET ไปยัง URL ฟีดคีย์การรับรองการลงชื่อ SSO และใส่ส่วนหัว Authorization ตามที่อธิบายไว้ในการตรวจสอบสิทธิ์กับบริการการตั้งค่าผู้ดูแลระบบ และดูข้อความแสดงข้อผิดพลาดได้ที่การแก้ปัญหาเกี่ยวกับ SSO

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/signingkey

การดำเนินการนี้ไม่มีพารามิเตอร์ในเนื้อหาคำขอ

การตอบกลับที่สำเร็จจะแสดงรหัสสถานะ HTTP 200 OK พร้อมกับฟีด AtomPub ที่มีคีย์การรับรอง

XML การตอบกลับ GET จะแสดงพร็อพเพอร์ตี้ signingKey ดังนี้

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='signingKey' value='yourBase64EncodedPublicKey'/>
</entry>

หากคำขอไม่สำเร็จเนื่องจากเหตุผลใดก็ตาม ระบบจะแสดงรหัสสถานะอื่น ดูข้อมูลเพิ่มเติมเกี่ยวกับรหัสสถานะของ Google Data API ได้ที่รหัสสถานะ HTTP

การอัปเดตคีย์การรับรองการลงชื่อเพียงครั้งเดียว

หากต้องการอัปเดตคีย์การรับรอง SSO ของโดเมน ให้ดึงข้อมูลคีย์การรับรองโดยใช้การดำเนินการการดึงข้อมูลคีย์การรับรองการลงชื่อเพียงครั้งเดียว จากนั้นแก้ไข แล้วส่งคำขอ PUT ไปยัง URL ฟีดคีย์การรับรอง SSO ตรวจสอบว่าค่า <id> ในรายการที่อัปเดตตรงกับ <id> ของรายการที่มีอยู่ทุกประการ ดูข้อมูลเพิ่มเติมเกี่ยวกับคีย์การลงนามสำหรับการลงชื่อเพียงครั้งเดียวด้วย SAML ได้ที่หัวข้อการสร้างคีย์และใบรับรองสำหรับบริการการลงชื่อเพียงครั้งเดียวของ Google Workspace

เมื่ออัปเดตคีย์การรับรองการลงชื่อเพียงครั้งเดียว ให้ส่ง HTTP PUT ไปยัง URL ฟีดคีย์การรับรองการลงชื่อเพียงครั้งเดียว ดังนี้

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/sso/signingkey

XML คำขอ PUT คือ

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='signingKey' value='yourBase64EncodedPublicKey'/>
</atom:entry>

ระบบไม่อนุญาตให้เปลี่ยนแปลงการตั้งค่าการลงชื่อเพียงครั้งเดียวเมื่อลูกค้าเป้าหมายเปิดใช้การอนุมัติจากผู้ที่มีสิทธิ์สําหรับการดําเนินการที่มีความละเอียดอ่อน คำขอจะดำเนินการไม่สำเร็จด้วย errorCode="1811" และ reason="LegacyInboundSsoChangeNotAllowedWithMultiPartyApproval"

การจัดการเกตเวย์และการกำหนดเส้นทางอีเมล

ส่วนเกตเวย์อีเมลขาออกจะแสดงวิธีที่ Admin Settings API รองรับการกำหนดเส้นทางอีเมลขาออกจากผู้ใช้ในโดเมนของคุณ ส่วนการกำหนดเส้นทางอีเมลจะแสดงวิธีกำหนดเส้นทางข้อความไปยังเซิร์ฟเวอร์อีเมลอื่น

กำลังเรียกข้อมูลการตั้งค่าเกตเวย์อีเมลขาออก

หากต้องการเรียกข้อมูลการตั้งค่าเกตเวย์อีเมลขาออก ให้ส่ง HTTP GET ไปยัง URL ฟีดเกตเวย์ และใส่ส่วนหัว Authorization ตามที่อธิบายไว้ในการตรวจสอบสิทธิ์กับบริการการตั้งค่าผู้ดูแลระบบ

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

การดำเนินการนี้ไม่มีพารามิเตอร์ในเนื้อหาคำขอ

การตอบกลับที่สำเร็จจะแสดงรหัสสถานะ HTTP 200 OK พร้อมกับฟีด AtomPub ที่มีข้อมูลสถานะเกตเวย์อีเมล

การตอบกลับ GET จะแสดงพร็อพเพอร์ตี้ smartHost และ smtpMode ดูข้อมูลเพิ่มเติมเกี่ยวกับพร็อพเพอร์ตี้เหล่านี้ได้ที่การอัปเดตการตั้งค่าเกตเวย์อีเมลขาออก

ตัวอย่างคำตอบที่เป็นไปได้มีดังนี้

<?xml version='1.0' encoding='UTF-8'?>
<entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'>
...
<apps:property name='smartHost' value='smtpout.domain.com'/>
<apps:property name='smtpMode' value='SMTP'/>
</entry>

หากคำขอไม่สำเร็จเนื่องจากเหตุผลใดก็ตาม ระบบจะแสดงรหัสสถานะอื่น ดูข้อมูลเพิ่มเติมเกี่ยวกับรหัสสถานะของ Google Data API ได้ที่รหัสสถานะ HTTP

การอัปเดตการตั้งค่าเกตเวย์อีเมลขาออก

หากต้องการอัปเดตการตั้งค่าเกตเวย์อีเมลขาออกของโดเมน ให้ส่งคำขอ HTTP PUT ไปยัง URL ของฟีดเกตเวย์ โดยทำดังนี้

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/email/gateway

XML คำขอ PUT คือ

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='smartHost' value='smtp.out.domain.com' />
<apps:property name='smtpMode' value='SMTP' />
</atom:entry>

พร็อพเพอร์ตี้คำขอมีดังนี้

smartHost
ที่อยู่ IP หรือชื่อโฮสต์ของเซิร์ฟเวอร์ SMTP Google Workspace จะกำหนดเส้นทางอีเมลขาออกไปยังเซิร์ฟเวอร์นี้
smtpMode
ค่าเริ่มต้นคือ SMTP ค่าอีกค่าหนึ่งคือ SMTP_TLS จะรักษาความปลอดภัยของการเชื่อมต่อด้วย TLS เมื่อนำส่งข้อความ

การตอบกลับที่สำเร็จจะแสดงรหัสสถานะ HTTP 200 OK พร้อมกับฟีด AtomPub ที่มีสถานะการตั้งค่าเกตเวย์อีเมล

หากคำขอไม่สำเร็จเนื่องจากเหตุผลใดก็ตาม ระบบจะแสดงรหัสสถานะอื่น ดูข้อมูลเพิ่มเติมเกี่ยวกับรหัสสถานะของ Google Data API ได้ที่รหัสสถานะ HTTP

การจัดการการตั้งค่าการกำหนดเส้นทางอีเมล

ก่อนอื่น ให้สร้างคําขอ XML โดยทําดังนี้

<atom:entry xmlns:atom='http://www.w3.org/2005/Atom' xmlns:apps="http://schemas.google.com/apps/2006">
<apps:property name='routeDestination' value='route-smtp.domain.com'/>
<apps:property name='routeRewriteTo' value='true'/>
<apps:property name='routeEnabled' value='true'/>
<apps:property name='bounceNotifications' value='true'/>
<apps:property name='accountHandling' value='can be either allAccounts | provisionedAccounts | unknownAccounts'/>
</atom:entry>

พร็อพเพอร์ตี้คำขอมีดังนี้

routeDestination
ปลายทางนี้คือชื่อโฮสต์หรือที่อยู่ IP ของเซิร์ฟเวอร์อีเมล SMTP-In ที่กําลังกําหนดเส้นทางอีเมล ชื่อโฮสต์หรือที่อยู่ IP ต้องแก้ไขได้สำหรับ Google โปรดดูรายละเอียดเพิ่มเติมเกี่ยวกับการแก้ไขชื่อโฮสต์อีเมลที่หัวข้อนําร่อง Google Workspace ด้วยการกำหนดเส้นทางอีเมล
routeRewriteTo
หากเป็นจริง ระบบจะเปลี่ยนช่อง to: ของโฟลเดอร์จดหมาย SMTP ของข้อความเป็นชื่อโฮสต์ปลายทาง (ชื่อโฮสต์ของ user@destination) และส่งข้อความไปยังอีเมลของผู้ใช้นี้ในเซิร์ฟเวอร์อีเมลปลายทาง หากเป็น false ระบบจะส่งอีเมลไปยังอีเมล to: ของข้อความต้นฉบับ (user@original hostname) ในเซิร์ฟเวอร์อีเมลปลายทาง ซึ่งคล้ายกับการตั้งค่า "เปลี่ยนโฟลเดอร์จดหมาย SMTP" ของคอนโซลผู้ดูแลระบบ โปรดดูข้อมูลเพิ่มเติมที่หัวข้อการตั้งค่าโดเมนสำหรับการกำหนดเส้นทางอีเมล
routeEnabled
หากเป็น true ระบบจะเปิดใช้ฟังก์ชันการกำหนดเส้นทางอีเมล หากเป็น false แสดงว่าฟังก์ชันดังกล่าวปิดอยู่
bounceNotifications
หากเป็น true ระบบจะเปิดใช้ Google Workspace เพื่อส่งการแจ้งเตือนการตีกลับไปยังผู้ส่งเมื่อการนำส่งไม่สำเร็จ
accountHandling

การตั้งค่านี้จะกำหนดผลกระทบที่การกำหนดเส้นทางอีเมลมีต่อผู้ใช้ประเภทต่างๆ ในโดเมน ดังนี้

  • allAccounts -- ส่งอีเมลทั้งหมดไปยังปลายทางนี้
  • provisionedAccounts -- ส่งอีเมลไปยังปลายทางนี้หากผู้ใช้อยู่ใน Google Workspace
  • unknownAccounts -- ส่งอีเมลไปยังปลายทางนี้หากผู้ใช้ไม่อยู่ใน Google Workspace ซึ่งคล้ายกับการตั้งค่า "อีเมลสำหรับจัดส่ง" ของคอนโซลผู้ดูแลระบบ โปรดดูข้อมูลเพิ่มเติมเกี่ยวกับข้อกําหนดเบื้องต้นและวิธีใช้การกำหนดเส้นทางอีเมลที่หัวข้อการตั้งค่าโดเมนสําหรับการกำหนดเส้นทางอีเมล ~ หากต้องการเผยแพร่คำขอนี้ ให้ส่ง HTTP POST ไปยัง URL ของฟีดการกำหนดเส้นทางอีเมล และใส่ส่วนหัว Authorization ตามที่อธิบายไว้ในการตรวจสอบสิทธิ์กับบริการการตั้งค่าผู้ดูแลระบบ

https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/emailrouting

การตอบกลับที่สำเร็จจะแสดงรหัสสถานะ HTTP 200 OK พร้อมกับฟีด AtomPub ที่มีข้อมูลไฟล์เก็บถาวร

หากคำขอไม่สำเร็จเนื่องจากเหตุผลใดก็ตาม ระบบจะแสดงรหัสสถานะอื่น ดูข้อมูลเพิ่มเติมเกี่ยวกับรหัสสถานะของ Google Data API ได้ที่รหัสสถานะ HTTP

สิ้นสุดการให้บริการปลายทางในวันที่ 31 ต.ค. 2018

เราได้เลิกใช้งานปลายทางต่อไปนี้ตามประกาศนี้ เราได้เลิกใช้งานแล้วเมื่อวันที่ 31 ตุลาคม 2018 และจะไม่มีให้บริการอีกต่อไป

  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/defaultLanguage
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/organizationName
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/currentNumberOfUsers
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/general/maximumNumberOfUsers
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/supportPIN
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/customerPIN
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/adminSecondaryEmail
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/edition
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/creationTime
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/accountInformation/countryCode
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/appearance/customLogo
  • https://apps-apis.google.com/a/feeds/domain/2.0/{domainName}/verification/mx