ข้อมูลอ้างอิงนี้อธิบายเกี่ยวกับ Google 3P Authorization JavaScript Library API ซึ่งคุณสามารถใช้เพื่อโหลดรหัสการให้สิทธิ์หรือเข้าถึงโทเค็นจาก Google ได้
เมธอด: google.accounts.oauth2.initCodeClient
เมธอด initCodeClient
จะเริ่มต้นและแสดงผลไคลเอ็นต์โค้ด โดยมีการกําหนดค่าในพารามิเตอร์
google.accounts.oauth2.initCodeClient(config: CodeClientConfig)
ประเภทข้อมูล: CodeClientConfig
ตารางต่อไปนี้แสดงพร็อพเพอร์ตี้ของประเภทข้อมูล CodeClientConfig
พร็อพเพอร์ตี้ | |
---|---|
client_id
|
ต้องระบุ รหัสไคลเอ็นต์สำหรับแอปพลิเคชันของคุณ คุณจะพบค่านี้ในคอนโซล API |
scope
|
ต้องระบุ รายการขอบเขตที่คั่นด้วยช่องว่างซึ่งระบุทรัพยากรที่แอปพลิเคชันของคุณเข้าถึงได้ในนามของผู้ใช้ ค่าเหล่านี้จะแจ้งหน้าจอขอความยินยอมที่ Google แสดงต่อผู้ใช้ |
include_granted_scopes |
ไม่บังคับ ค่าเริ่มต้นคือ true เปิดให้แอปพลิเคชันใช้การให้สิทธิ์เพิ่มเติมเพื่อขอสิทธิ์เข้าถึงขอบเขตเพิ่มเติมในบริบท หากคุณตั้งค่าของพารามิเตอร์นี้เป็น false และอนุมัติคำขอการให้สิทธิ์แล้ว โทเค็นเพื่อการเข้าถึงใหม่จะครอบคลุมเฉพาะขอบเขตที่ scope ขอใน CodeClientConfig นี้
|
redirect_uri
|
จำเป็นสำหรับการเปลี่ยนเส้นทาง UX กำหนดตำแหน่งที่เซิร์ฟเวอร์ API เปลี่ยนเส้นทางผู้ใช้หลังจากที่ผู้ใช้ดำเนินการตามกระบวนการให้สิทธิ์แล้ว ค่าต้องตรงกับ URI การเปลี่ยนเส้นทางที่ได้รับอนุญาตสำหรับไคลเอ็นต์ OAuth 2.0 ซึ่งคุณกำหนดค่าไว้ในคอนโซล API และต้องสอดคล้องกับกฎการตรวจสอบการเปลี่ยนเส้นทาง URI UX แบบป๊อปอัปจะไม่สนใจพร็อพเพอร์ตี้ |
callback |
ต้องระบุสำหรับ UX แบบป๊อปอัป ฟังก์ชัน JavaScript ที่จัดการการตอบสนองโค้ดที่ส่งคืน UX การเปลี่ยนเส้นทางจะไม่สนใจพร็อพเพอร์ตี้ |
state |
ไม่บังคับ แนะนำสำหรับ UX การเปลี่ยนเส้นทาง ระบุค่าสตริงที่แอปพลิเคชันจะใช้เพื่อรักษาสถานะระหว่างคำขอการให้สิทธิ์และการตอบกลับของเซิร์ฟเวอร์การให้สิทธิ์ |
enable_granular_consent |
ไม่บังคับ ค่าเริ่มต้นคือ true หากตั้งค่าเป็น false ระบบจะปิดใช้สิทธิ์สำหรับบัญชี Google ที่ละเอียดยิ่งขึ้นสำหรับรหัสไคลเอ็นต์ OAuth ที่สร้างขึ้นก่อนปี 2019 หากตั้งค่าทั้ง enable_granular_consent และ enable_serial_consent จะมีเฉพาะค่า enable_granular_consent เท่านั้นที่จะมีผล และระบบจะไม่สนใจค่า enable_serial_consent ไม่ส่งผลกระทบต่อรหัสไคลเอ็นต์ OAuth ที่ใหม่กว่า เนื่องจากระบบจะเปิดใช้สิทธิ์ที่ละเอียดยิ่งขึ้นให้กับรหัสไคลเอ็นต์เหล่านั้นเสมอ |
enable_serial_consent |
เลิกใช้งานไปแล้ว คุณควรใช้ enable_granular_consent แทน ซึ่งให้ผลเหมือนกับ enable_granular_consent แอปพลิเคชันที่มีอยู่ซึ่งใช้ enable_serial_consent จะยังใช้ต่อไปได้ แต่เราขอแนะนำให้อัปเดตรหัสเพื่อใช้ enable_granular_consent ในการอัปเดตแอปพลิเคชันครั้งถัดไป
|
login_hint |
ไม่บังคับ หากแอปพลิเคชันทราบว่าผู้ใช้รายใดควรให้สิทธิ์คำขอ ก็สามารถใช้พร็อพเพอร์ตี้นี้เพื่อให้คำแนะนำในการเข้าสู่ระบบแก่ Google เมื่อเรียบร้อยแล้ว ระบบจะข้ามการเลือกบัญชี ค่าในช่องย่อยของอีเมลหรือรหัสโทเค็นรหัสสำหรับผู้ใช้เป้าหมาย
โปรดดูข้อมูลเพิ่มเติมที่ช่อง login_hint ในเอกสารประกอบของ OpenID Connect
|
hd |
ไม่บังคับ หากแอปพลิเคชันของคุณทราบโดเมน Workspace ของผู้ใช้ ให้ใช้โดเมนนี้เพื่อให้คำแนะนำแก่ Google เมื่อดำเนินการสำเร็จ บัญชีผู้ใช้จะถูกจํากัดไว้หรือได้เลือกไว้ล่วงหน้าสําหรับโดเมนที่ให้ไว้
โปรดดูข้อมูลเพิ่มเติมที่ช่อง hd ในเอกสารประกอบของ OpenID Connect
|
ux_mode |
ไม่บังคับ โหมด UX ที่จะใช้สำหรับขั้นตอนการให้สิทธิ์ โดยค่าเริ่มต้น ระบบจะเปิดขั้นตอนการขอความยินยอมในป๊อปอัป ค่าที่ถูกต้องคือ popup และ redirect
|
select_account |
ไม่บังคับ มีค่าเริ่มต้นเป็น 'false' ค่าบูลีนที่แจ้งให้ผู้ใช้เลือกบัญชี |
error_callback |
ไม่บังคับ ฟังก์ชัน JavaScript ที่จัดการข้อผิดพลาดบางอย่างที่ไม่ใช่ของ OAuth เช่น เปิดหน้าต่างป๊อปอัปไม่สำเร็จ หรือปิดก่อนที่จะแสดงผลการตอบกลับ OAuth
ช่อง "type" ของพารามิเตอร์อินพุตจะให้เหตุผลโดยละเอียด
|
ประเภทข้อมูล: CodeClient
คลาสนี้มี requestCode สำหรับวิธีสาธารณะเพียงรายการเดียว ซึ่งเริ่มโฟลว์ UX ของ OAuth 2.0
interface CodeClient {
requestCode(): void;
}
ประเภทข้อมูล: CodeResponse
ระบบจะส่งออบเจ็กต์ JavaScript CodeResponse
ไปยังเมธอด callback
ใน UX แบบป๊อปอัป ใน UX การเปลี่ยนเส้นทาง ระบบจะส่ง CodeResponse
เป็นพารามิเตอร์ของ URL
ตารางต่อไปนี้แสดงพร็อพเพอร์ตี้ของประเภทข้อมูล CodeResponse
พร็อพเพอร์ตี้ | |
---|---|
code |
รหัสการให้สิทธิ์ของการตอบกลับโทเค็นที่สำเร็จ |
scope |
รายการขอบเขตที่คั่นด้วยช่องว่างที่ผู้ใช้อนุมัติ |
state |
ค่าสตริงที่แอปพลิเคชันของคุณใช้เพื่อรักษาสถานะระหว่างคำขอการให้สิทธิ์และการตอบกลับ |
error |
รหัสข้อผิดพลาด ASCII เดียว |
error_description |
ข้อความ ASCII ที่มนุษย์อ่านได้ซึ่งให้ข้อมูลเพิ่มเติม ซึ่งใช้เพื่อช่วยให้นักพัฒนาซอฟต์แวร์ไคลเอ็นต์เข้าใจข้อผิดพลาดที่เกิดขึ้น |
error_uri |
URI ที่ระบุหน้าเว็บที่มนุษย์อ่านได้พร้อมด้วยข้อมูลเกี่ยวกับข้อผิดพลาด ซึ่งใช้เพื่อให้ข้อมูลเพิ่มเติมเกี่ยวกับข้อผิดพลาดนั้นแก่นักพัฒนาซอฟต์แวร์ไคลเอ็นต์ |
เมธอด: google.accounts.oauth2.initTokenClient
เมธอด initTokenClient
จะเริ่มต้นและแสดงผลไคลเอ็นต์โทเค็น พร้อมกับการกำหนดค่าในพารามิเตอร์
google.accounts.oauth2.initTokenClient(config: TokenClientConfig)
ประเภทข้อมูล: TokenClientConfig
ตารางต่อไปนี้แสดงพร็อพเพอร์ตี้ของประเภทข้อมูล TokenClientConfig
พร็อพเพอร์ตี้ | |
---|---|
client_id |
ต้องระบุ รหัสไคลเอ็นต์สำหรับแอปพลิเคชันของคุณ คุณจะพบค่านี้ในคอนโซล API |
callback |
ต้องระบุ ฟังก์ชัน JavaScript ที่จัดการการตอบสนองโทเค็นที่ส่งกลับ |
scope |
ต้องระบุ รายการขอบเขตที่คั่นด้วยช่องว่างซึ่งระบุทรัพยากรที่แอปพลิเคชันของคุณเข้าถึงได้ในนามของผู้ใช้ ค่าเหล่านี้จะแจ้งหน้าจอขอความยินยอมที่ Google แสดงต่อผู้ใช้ |
include_granted_scopes |
ไม่บังคับ ค่าเริ่มต้นคือ true เปิดให้แอปพลิเคชันใช้การให้สิทธิ์เพิ่มเติมเพื่อขอสิทธิ์เข้าถึงขอบเขตเพิ่มเติมในบริบท หากคุณตั้งค่าของพารามิเตอร์นี้เป็น false และอนุมัติคำขอการให้สิทธิ์แล้ว โทเค็นเพื่อการเข้าถึงใหม่จะครอบคลุมเฉพาะขอบเขตที่ scope ขอใน TokenClientConfig นี้
|
prompt |
ไม่บังคับ มีค่าเริ่มต้นเป็น 'select_account' รายการพรอมต์ที่คั่นด้วยการเว้นวรรคและคำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่เพื่อนำเสนอผู้ใช้ ค่าที่เป็นไปได้มีดังนี้
|
enable_granular_consent |
ไม่บังคับ ค่าเริ่มต้นคือ true หากตั้งค่าเป็น false ระบบจะปิดใช้สิทธิ์สำหรับบัญชี Google ที่ละเอียดยิ่งขึ้นสำหรับรหัสไคลเอ็นต์ OAuth ที่สร้างขึ้นก่อนปี 2019 หากตั้งค่าทั้ง enable_granular_consent และ enable_serial_consent จะมีเฉพาะค่า enable_granular_consent เท่านั้นที่จะมีผล และระบบจะไม่สนใจค่า enable_serial_consent ไม่ส่งผลกระทบต่อรหัสไคลเอ็นต์ OAuth ที่ใหม่กว่า เนื่องจากระบบจะเปิดใช้สิทธิ์ที่ละเอียดยิ่งขึ้นให้กับรหัสไคลเอ็นต์เหล่านั้นเสมอ |
enable_serial_consent |
เลิกใช้งานไปแล้ว คุณควรใช้ enable_granular_consent แทน ซึ่งให้ผลเหมือนกับ enable_granular_consent แอปพลิเคชันที่มีอยู่ซึ่งใช้ enable_serial_consent จะยังใช้ต่อไปได้ แต่เราขอแนะนำให้อัปเดตรหัสเพื่อใช้ enable_granular_consent ในการอัปเดตแอปพลิเคชันครั้งถัดไป
|
login_hint |
ไม่บังคับ หากแอปพลิเคชันทราบว่าผู้ใช้รายใดควรให้สิทธิ์คำขอ ก็สามารถใช้พร็อพเพอร์ตี้นี้เพื่อให้คำแนะนำในการเข้าสู่ระบบแก่ Google เมื่อเรียบร้อยแล้ว ระบบจะข้ามการเลือกบัญชี ค่าในช่องย่อยของอีเมลหรือรหัสโทเค็นรหัสสำหรับผู้ใช้เป้าหมาย
โปรดดูข้อมูลเพิ่มเติมที่ช่อง login_hint ในเอกสารประกอบของ OpenID Connect
|
hd |
ไม่บังคับ หากแอปพลิเคชันของคุณทราบโดเมน Workspace ของผู้ใช้ ให้ใช้โดเมนนี้เพื่อให้คำแนะนำแก่ Google เมื่อดำเนินการสำเร็จ บัญชีผู้ใช้จะถูกจํากัดไว้หรือได้เลือกไว้ล่วงหน้าสําหรับโดเมนที่ให้ไว้
โปรดดูข้อมูลเพิ่มเติมที่ช่อง hd ในเอกสารประกอบของ OpenID Connect
|
state |
ไม่บังคับ ไม่แนะนำ ระบุค่าสตริงที่แอปพลิเคชันจะใช้เพื่อรักษาสถานะระหว่างคำขอการให้สิทธิ์และการตอบกลับของเซิร์ฟเวอร์การให้สิทธิ์ |
error_callback |
ไม่บังคับ ฟังก์ชัน JavaScript ที่จัดการข้อผิดพลาดบางอย่างที่ไม่ใช่ของ OAuth เช่น เปิดหน้าต่างป๊อปอัปไม่สำเร็จ หรือปิดก่อนที่จะแสดงผลการตอบกลับ OAuth
ช่อง "type" ของพารามิเตอร์อินพุตจะให้เหตุผลโดยละเอียด
|
ประเภทข้อมูล: TokenClient
คลาสนี้มีเมธอด requestAccessToken
แบบสาธารณะเพียง 1 รายการ ซึ่งจะเริ่มโฟลว์ UX โทเค็น OAuth 2.0
interface TokenClient {
requestAccessToken(overrideConfig?: OverridableTokenClientConfig): void;
}
อาร์กิวเมนต์ | ||
---|---|---|
overrideConfig |
OverridableTokenClientConfig | ไม่บังคับ การกําหนดค่าที่จะถูกลบล้างในวิธีนี้ |
ประเภทข้อมูล: OverridableTokenClientConfig
ตารางต่อไปนี้แสดงพร็อพเพอร์ตี้ของประเภทข้อมูล OverridableTokenClientConfig
พร็อพเพอร์ตี้ | |
---|---|
scope |
ไม่บังคับ รายการขอบเขตที่คั่นด้วยช่องว่างซึ่งระบุทรัพยากรที่แอปพลิเคชันของคุณเข้าถึงได้ในนามของผู้ใช้ ค่าเหล่านี้จะแจ้งหน้าจอคำยินยอมที่ Google แสดงต่อผู้ใช้ |
include_granted_scopes |
ไม่บังคับ ค่าเริ่มต้นคือ true เปิดให้แอปพลิเคชันใช้การให้สิทธิ์เพิ่มเติมเพื่อขอสิทธิ์เข้าถึงขอบเขตเพิ่มเติมในบริบท หากคุณตั้งค่าของพารามิเตอร์นี้เป็น false และอนุมัติคำขอการให้สิทธิ์แล้ว โทเค็นเพื่อการเข้าถึงใหม่จะครอบคลุมเฉพาะขอบเขตที่ scope ขอใน OverridableTokenClientConfig นี้
|
prompt |
ไม่บังคับ รายการพรอมต์ที่คั่นด้วยช่องว่างและตรงตามตัวพิมพ์ใหญ่-เล็กของข้อความแจ้งเพื่อนำเสนอผู้ใช้ |
enable_granular_consent |
ไม่บังคับ ค่าเริ่มต้นคือ true หากตั้งค่าเป็น false ระบบจะปิดใช้สิทธิ์ของบัญชี Google ที่ละเอียดยิ่งขึ้นสำหรับรหัสไคลเอ็นต์ OAuth ที่สร้างขึ้นก่อนปี 2019 หากตั้งค่าทั้ง enable_granular_consent และ enable_serial_consent ไว้ จะมีเพียงค่า enable_granular_consent เท่านั้นที่ได้รับผลกระทบและระบบจะไม่สนใจค่า enable_serial_consent ไม่ส่งผลกระทบต่อรหัสไคลเอ็นต์ OAuth ที่ใหม่กว่า เนื่องจากระบบจะเปิดใช้สิทธิ์ที่ละเอียดยิ่งขึ้นให้กับรหัสไคลเอ็นต์เหล่านั้นเสมอ |
enable_serial_consent |
เลิกใช้งานไปแล้ว คุณควรใช้ enable_granular_consent แทน ซึ่งให้ผลเหมือนกับ enable_granular_consent แอปพลิเคชันที่มีอยู่ซึ่งใช้ enable_serial_consent จะยังใช้ต่อไปได้ แต่เราขอแนะนำให้อัปเดตรหัสเพื่อใช้ enable_granular_consent ในการอัปเดตแอปพลิเคชันครั้งถัดไป
|
login_hint |
ไม่บังคับ หากแอปพลิเคชันทราบว่าผู้ใช้รายใดควรให้สิทธิ์คำขอ ก็สามารถใช้พร็อพเพอร์ตี้นี้เพื่อให้คำแนะนำในการเข้าสู่ระบบแก่ Google เมื่อเรียบร้อยแล้ว ระบบจะข้ามการเลือกบัญชี ค่าในช่องย่อยของอีเมลหรือรหัสโทเค็นรหัสสำหรับผู้ใช้เป้าหมาย
โปรดดูข้อมูลเพิ่มเติมที่ช่อง login_hint ในเอกสารประกอบของ OpenID Connect
|
state |
ไม่บังคับ ไม่แนะนำ ระบุค่าสตริงที่แอปพลิเคชันจะใช้เพื่อรักษาสถานะระหว่างคำขอการให้สิทธิ์และการตอบกลับของเซิร์ฟเวอร์การให้สิทธิ์ |
ประเภทข้อมูล: TokenResponse
ระบบจะส่งออบเจ็กต์ JavaScript TokenResponse
ไปยังเมธอดโค้ดเรียกกลับใน UX แบบป๊อปอัป
ตารางต่อไปนี้แสดงพร็อพเพอร์ตี้ของประเภทข้อมูล TokenResponse
พร็อพเพอร์ตี้ | |
---|---|
access_token |
โทเค็นเพื่อการเข้าถึงของการตอบกลับโทเค็นที่สำเร็จ |
expires_in |
อายุการใช้งานเป็นวินาทีของโทเค็นเพื่อการเข้าถึง |
hd |
โดเมนที่โฮสต์ซึ่งผู้ใช้ที่ลงชื่อเข้าใช้อยู่ |
prompt |
ค่าของข้อความแจ้งที่ใช้จากรายการค่าที่เป็นไปได้ซึ่ง TokenClientConfig หรือ OverridableTokenClientConfig |
token_type |
ประเภทโทเค็นที่ออก |
scope |
รายการขอบเขตที่คั่นด้วยช่องว่างที่ผู้ใช้อนุมัติ |
state |
ค่าสตริงที่แอปพลิเคชันของคุณใช้เพื่อรักษาสถานะระหว่างคำขอการให้สิทธิ์และการตอบกลับ |
error |
รหัสข้อผิดพลาด ASCII เดียว |
error_description |
ข้อความ ASCII ที่มนุษย์อ่านได้ซึ่งให้ข้อมูลเพิ่มเติม ซึ่งใช้เพื่อช่วยให้นักพัฒนาซอฟต์แวร์ไคลเอ็นต์เข้าใจข้อผิดพลาดที่เกิดขึ้น |
error_uri |
URI ที่ระบุหน้าเว็บที่มนุษย์อ่านได้พร้อมด้วยข้อมูลเกี่ยวกับข้อผิดพลาด ซึ่งใช้เพื่อให้ข้อมูลเพิ่มเติมเกี่ยวกับข้อผิดพลาดนั้นแก่นักพัฒนาซอฟต์แวร์ไคลเอ็นต์ |
เมธอด: google.accounts.oauth2.hasGrantedAllScopes
ตรวจสอบว่าผู้ใช้ให้สิทธิ์ขอบเขตที่ระบุทั้งหมดหรือไม่
google.accounts.oauth2.hasGrantedAllScopes(
tokenResponse: TokenResponse,
firstScope: string, ...restScopes: string[]
): boolean;
อาร์กิวเมนต์ | ||
---|---|---|
tokenResponse |
TokenResponse
|
ต้องระบุ ออบเจ็กต์ TokenResponse
|
firstScope |
สตริง | ต้องระบุ ขอบเขตที่จะต้องตรวจสอบ |
restScopes |
สตริง[] | ไม่บังคับ ขอบเขตอื่นๆ ที่ต้องตรวจสอบ |
คิกรีเทิร์น | |
---|---|
boolean | เป็นจริงหากให้สิทธิ์ขอบเขตทั้งหมด |
เมธอด: google.accounts.oauth2.hasGrantedAnyScope
ตรวจสอบว่าผู้ใช้ให้สิทธิ์ขอบเขตที่ระบุไว้หรือไม่
google.accounts.oauth2.hasGrantedAnyScope(
tokenResponse: TokenResponse,
firstScope: string, ...restScopes: string[]
): boolean;
อาร์กิวเมนต์ | ||
---|---|---|
tokenResponse |
TokenResponse
|
ต้องระบุ ออบเจ็กต์ TokenResponse
|
firstScope |
สตริง | ต้องระบุ ขอบเขตที่จะต้องตรวจสอบ |
restScopes |
สตริง[] | ไม่บังคับ ขอบเขตอื่นๆ ที่ต้องตรวจสอบ |
คิกรีเทิร์น | |
---|---|
boolean | เป็นจริงหากมีการให้สิทธิ์ขอบเขตใดก็ตาม |
เมธอด: google.accounts.oauth2.revoke
เมธอด revoke
จะเพิกถอนขอบเขตทั้งหมดที่ผู้ใช้มอบให้แก่แอป
จำเป็นต้องมีโทเค็นเพื่อการเข้าถึงที่ถูกต้องเพื่อเพิกถอนสิทธิ์
google.accounts.oauth2.revoke(accessToken: string, done: () => void): void;
อาร์กิวเมนต์ | ||
---|---|---|
accessToken |
สตริง | ต้องระบุ โทเค็นเพื่อการเข้าถึงที่ถูกต้อง |
callback |
function | ไม่บังคับ เครื่องจัดการ RevocationResponse |
ประเภทข้อมูล: RevocationResponse
ระบบจะส่งออบเจ็กต์ JavaScript RevocationResponse
ไปยังเมธอดโค้ดเรียกกลับของคุณ
ตารางต่อไปนี้แสดงพร็อพเพอร์ตี้ของประเภทข้อมูล RevocationResponse
พร็อพเพอร์ตี้ | |
---|---|
successful |
บูลีน สำเร็จ true เมื่อล้มเหลว false รายการ |
error |
สตริง ไม่มีคำจำกัดความเกี่ยวกับความสำเร็จ รหัสข้อผิดพลาด ASCII เดียว ซึ่งรวมถึงแต่ไม่จำกัดเพียงรหัสข้อผิดพลาด OAuth 2.0 มาตรฐาน ข้อผิดพลาดที่พบบ่อยสำหรับเมธอด revoke :
|
error_description |
สตริง ไม่มีคำจำกัดความเกี่ยวกับความสำเร็จ ข้อความ ASCII ที่มนุษย์อ่านได้จะให้ข้อมูลเพิ่มเติมเกี่ยวกับพร็อพเพอร์ตี้ error นักพัฒนาแอปสามารถใช้ข้อมูลดังกล่าวเพื่อทำความเข้าใจข้อผิดพลาดที่เกิดขึ้นให้ดียิ่งขึ้น สตริง error_description เป็นภาษาอังกฤษเท่านั้น
สำหรับข้อผิดพลาดที่พบบ่อยซึ่งแสดงใน error ให้error_description ที่เกี่ยวข้องดังนี้
|