ภาพรวมของ 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 APIs

กลุ่มเป้าหมาย

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

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

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

หากต้องการเริ่มใช้ Admin Settings API ให้ตั้งค่าบัญชีก่อน

สร้างบัญชี

ระบบได้เปิดใช้ 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 ของคีย์ส่วนตัวไม่ได้ รับการแก้ไขระหว่างการส่งผ่านเครือข่าย

หากต้องการข้อมูลสรุป API แบบย่อเกี่ยวกับการใช้การตั้งค่า SSO ให้รับใบรับรองคีย์สาธารณะจากผู้ให้บริการข้อมูลประจำตัว ลงทะเบียนคีย์สาธารณะกับ 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

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

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

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

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

<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 elements จะแสดงคู่คีย์-ค่ารายการเดียวที่มีข้อมูลเกี่ยวกับพร็อพเพอร์ตี้ที่คุณต้องการดึงข้อมูลหรืออัปเดต ซึ่งเป็นเรื่องปกติสำหรับคำขอทั้งหมดของ 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 ไปยังฟีดทั่วไปของ SSO URL และใส่ส่วนหัว 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: A ssoWhitelist คือที่อยู่ IP ของเน็ตเวิร์กมาสก์ในรูปแบบ Classless Inter-Domain Routing (CIDR) ssoWhitelist จะกำหนดว่าผู้ใช้รายใด ลงชื่อเข้าใช้โดยใช้ SSO และผู้ใช้รายใดลงชื่อเข้าใช้โดยใช้หน้าการตรวจสอบสิทธิ์บัญชี Google Workspace หากไม่ได้ระบุมาสก์ไว้ ผู้ใช้ทั้งหมดจะลงชื่อเข้าใช้โดยใช้ SSO ดูข้อมูลเพิ่มเติมได้ที่วิธีการทำงานของมาสก์เครือข่าย
useDomainSpecificIssuer: คุณสามารถใช้ผู้ออกใบรับรองเฉพาะโดเมนในคำขอ SAML ไปยังผู้ให้บริการข้อมูลประจำตัวได้ แม้ว่าการติดตั้งใช้งาน SSO ส่วนใหญ่จะไม่จำเป็นต้องใช้ฟีเจอร์นี้ แต่ฟีเจอร์นี้มีประโยชน์ในบริษัทขนาดใหญ่ที่ใช้ผู้ให้บริการข้อมูลประจำตัวรายเดียวเพื่อตรวจสอบสิทธิ์ทั้งองค์กรที่มีโดเมนย่อยหลายโดเมน การระบุผู้ให้บริการโดเมนที่เฉพาะเจาะจงจะกำหนดโดเมนย่อยที่จะเชื่อมโยงกับคำขอ ดูข้อมูลเพิ่มเติมได้ที่องค์ประกอบผู้ออก ในคำขอ SAML ทํางานอย่างไร

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

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

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

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

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

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

<?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>

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

อัปเดตคีย์การลงนาม Single Sign-On

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

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

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>

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

ส่วนเกตเวย์อีเมลขาออกจะแสดงวิธีที่ 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>

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

หากต้องการอัปเดตการตั้งค่าเกตเวย์อีเมลขาออกของโดเมน ให้ส่งคำขอ 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 ที่มีสถานะการตั้งค่าเกตเวย์อีเมล

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

ก่อนอื่น ให้สร้างคำขอ 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@ชื่อโฮสต์ของปลายทาง) และส่งข้อความไปยังอีเมลของผู้ใช้รายนี้ในเซิร์ฟเวอร์อีเมลปลายทาง หาก 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

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

การหยุดให้บริการปลายทางในวันที่ 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