Tài liệu tham khảo này mô tả API Thư viện JavaScript cho phép của Google bên thứ ba mà bạn có thể sử dụng để tải mã uỷ quyền hoặc mã truy cập từ Google.
Phương pháp: google.accounts.OAuth2.initCodeClient
Phương thức initCodeClient
khởi chạy và trả về một ứng dụng mã, với các cấu hình trong tham số.
google.accounts.oauth2.initCodeClient(config: CodeClientConfig)
Loại dữ liệu: CodeClientConfig
Bảng sau đây liệt kê các thuộc tính của kiểu dữ liệu CodeClientConfig
.
Thuộc tính | |
---|---|
client_id
|
Bắt buộc. Mã ứng dụng khách của ứng dụng. Bạn có thể tìm thấy giá trị này trong Bảng điều khiển API. |
scope
|
Bắt buộc. Danh sách các phạm vi được phân tách bằng dấu cách giúp xác định những tài nguyên mà ứng dụng của bạn có thể thay mặt người dùng truy cập. Các giá trị này thông báo cho màn hình xin phép mà Google cho người dùng thấy. |
include_granted_scopes |
Không bắt buộc, giá trị mặc định là true . Cho phép ứng dụng sử dụng quyền uỷ quyền gia tăng để yêu cầu quyền truy cập vào các phạm vi khác theo bối cảnh. Nếu bạn đặt giá trị của thông số này thành false và yêu cầu uỷ quyền được cấp, thì mã truy cập mới sẽ chỉ bao gồm mọi phạm vi mà scope đã yêu cầu trong CodeClientConfig này.
|
redirect_uri
|
Bắt buộc đối với trải nghiệm người dùng chuyển hướng. Xác định nơi máy chủ API chuyển hướng người dùng sau khi người dùng hoàn tất quy trình uỷ quyền. Giá trị này phải khớp chính xác với một trong các URI chuyển hướng được uỷ quyền cho ứng dụng OAuth 2.0 mà bạn đã định cấu hình trong Bảng điều khiển API và phải tuân theo Quy tắc xác thực URI chuyển hướng của chúng tôi. Trải nghiệm người dùng bật lên sẽ bỏ qua thuộc tính này. |
callback |
Bắt buộc đối với trải nghiệm người dùng bật lên. Hàm JavaScript xử lý phản hồi mã được trả về. Trải nghiệm người dùng chuyển hướng sẽ bỏ qua thuộc tính này. |
state |
Không bắt buộc. Được đề xuất cho trải nghiệm người dùng của chuyển hướng. Chỉ định bất kỳ giá trị chuỗi nào mà ứng dụng của bạn sử dụng để duy trì trạng thái giữa yêu cầu uỷ quyền và phản hồi của máy chủ uỷ quyền. |
enable_granular_consent |
Không bắt buộc, giá trị mặc định là true . Nếu bạn đặt thành false , thì các quyền chi tiết hơn đối với Tài khoản Google
sẽ bị tắt đối với các mã ứng dụng OAuth được tạo trước năm 2019. Nếu bạn đặt cả enable_granular_consent và enable_serial_consent , thì chỉ giá trị enable_granular_consent mới có hiệu lực và giá trị enable_serial_consent sẽ bị bỏ qua.Không ảnh hưởng đến mã ứng dụng OAuth mới hơn, vì các quyền chi tiết hơn luôn được cấp cho các mã ứng dụng này. |
enable_serial_consent |
Không dùng nữa, bạn nên sử dụng enable_granular_consent . Cách này có tác dụng tương tự như enable_granular_consent . Các ứng dụng hiện có sử dụng enable_serial_consent có thể tiếp tục làm như vậy, nhưng bạn nên cập nhật mã của mình để sử dụng enable_granular_consent trong bản cập nhật ứng dụng tiếp theo.
|
login_hint |
Không bắt buộc. Nếu biết người dùng nào nên cho phép yêu cầu, thì ứng dụng có thể sử dụng thuộc tính này để cung cấp gợi ý đăng nhập cho Google. Khi thành công, lựa chọn tài khoản sẽ được bỏ qua. Giá trị của trường địa chỉ email hoặc mã thông báo giá trị nhận dạng phụ của người dùng mục tiêu.
Để biết thêm thông tin, hãy xem trường login_hint trong tài liệu về OpenID Connect.
|
hd |
Không bắt buộc. Nếu ứng dụng của bạn biết miền Workspace mà người dùng thuộc về, hãy sử dụng miền này để cung cấp gợi ý cho Google. Khi thành công, tài khoản người dùng được giới hạn hoặc được chọn trước cho miền được cung cấp.
Để biết thêm thông tin, hãy xem trường hd trong tài liệu về OpenID Connect.
|
ux_mode |
Không bắt buộc. Chế độ trải nghiệm người dùng để sử dụng cho quy trình uỷ quyền. Theo mặc định, thao tác này sẽ mở quy trình đồng ý trong một cửa sổ bật lên. Các giá trị hợp lệ là popup và redirect .
|
select_account |
Không bắt buộc, giá trị mặc định là 'false'. Giá trị Boolean để nhắc người dùng chọn tài khoản. |
error_callback |
Không bắt buộc. Hàm JavaScript xử lý một số lỗi không phải OAuth (chẳng hạn như không mở được cửa sổ bật lên) hoặc đóng trước khi phản hồi OAuth được trả về.
Trường "type" của tham số đầu vào sẽ cho biết lý do chi tiết.
|
Loại dữ liệu: CodeClient
Lớp này chỉ có một phương thức công khai requestCode, phương thức này sẽ bắt đầu quy trình trải nghiệm người dùng của mã OAuth 2.0.
interface CodeClient {
requestCode(): void;
}
Loại dữ liệu: CodeResponse
Đối tượng JavaScript CodeResponse
sẽ được chuyển đến phương thức callback
trong trải nghiệm người dùng bật lên. Trong trải nghiệm người dùng chuyển hướng, CodeResponse
sẽ được chuyển dưới dạng tham số URL.
Bảng sau đây liệt kê các thuộc tính của kiểu dữ liệu CodeResponse
.
Thuộc tính | |
---|---|
code |
Mã uỷ quyền của phản hồi mã thông báo thành công. |
scope |
Danh sách các phạm vi được phân tách bằng dấu cách được người dùng phê duyệt. |
state |
Giá trị chuỗi mà ứng dụng của bạn dùng để duy trì trạng thái giữa yêu cầu uỷ quyền và phản hồi. |
error |
Một mã lỗi ASCII duy nhất. |
error_description |
Văn bản ASCII mà con người có thể đọc được, cung cấp thông tin bổ sung, dùng để hỗ trợ nhà phát triển khách hàng hiểu được lỗi đã xảy ra. |
error_uri |
URI xác định trang web mà con người có thể đọc được cùng với thông tin về lỗi, được dùng để cung cấp cho nhà phát triển ứng dụng thông tin bổ sung về lỗi. |
Phương thức: google.accounts.OAuth2.initTokenClient
Phương thức initTokenClient
khởi chạy và trả về một ứng dụng mã thông báo, với các cấu hình trong tham số.
google.accounts.oauth2.initTokenClient(config: TokenClientConfig)
Loại dữ liệu: TokenClientConfig
Bảng sau đây liệt kê các thuộc tính của kiểu dữ liệu TokenClientConfig
.
Thuộc tính | |
---|---|
client_id |
Bắt buộc. Mã ứng dụng khách của ứng dụng. Bạn có thể tìm thấy giá trị này trong Bảng điều khiển API. |
callback |
Bắt buộc. Hàm JavaScript xử lý phản hồi của mã thông báo được trả về. |
scope |
Bắt buộc. Danh sách các phạm vi được phân tách bằng dấu cách giúp xác định những tài nguyên mà ứng dụng của bạn có thể thay mặt người dùng truy cập. Các giá trị này thông báo cho màn hình xin phép mà Google cho người dùng thấy. |
include_granted_scopes |
Không bắt buộc, giá trị mặc định là true . Cho phép ứng dụng sử dụng quyền uỷ quyền gia tăng để yêu cầu quyền truy cập vào các phạm vi khác theo bối cảnh. Nếu bạn đặt giá trị của thông số này thành false và yêu cầu uỷ quyền được cấp, thì mã truy cập mới sẽ chỉ bao gồm mọi phạm vi mà scope đã yêu cầu trong TokenClientConfig này.
|
prompt |
Không bắt buộc, giá trị mặc định là 'select_account'. Danh sách các lời nhắc được phân tách bằng dấu cách và có phân biệt chữ hoa chữ thường để hiển thị cho người dùng. Các giá trị có thể sử dụng là:
|
enable_granular_consent |
Không bắt buộc, giá trị mặc định là true . Nếu bạn đặt thành false , thì các quyền chi tiết hơn đối với Tài khoản Google
sẽ bị tắt đối với các mã ứng dụng OAuth được tạo trước năm 2019. Nếu bạn đặt cả enable_granular_consent và enable_serial_consent , thì chỉ giá trị enable_granular_consent mới có hiệu lực và giá trị enable_serial_consent sẽ bị bỏ qua.Không ảnh hưởng đến mã ứng dụng OAuth mới hơn, vì các quyền chi tiết hơn luôn được cấp cho các mã ứng dụng này. |
enable_serial_consent |
Không dùng nữa, bạn nên sử dụng enable_granular_consent . Cách này có tác dụng tương tự như enable_granular_consent . Các ứng dụng hiện có sử dụng enable_serial_consent có thể tiếp tục làm như vậy, nhưng bạn nên cập nhật mã của mình để sử dụng enable_granular_consent trong bản cập nhật ứng dụng tiếp theo.
|
login_hint |
Không bắt buộc. Nếu biết người dùng nào nên cho phép yêu cầu, thì ứng dụng có thể sử dụng thuộc tính này để cung cấp gợi ý đăng nhập cho Google. Khi thành công, lựa chọn tài khoản sẽ được bỏ qua. Giá trị của trường địa chỉ email hoặc mã thông báo giá trị nhận dạng phụ của người dùng mục tiêu.
Để biết thêm thông tin, hãy xem trường login_hint trong tài liệu về OpenID Connect.
|
hd |
Không bắt buộc. Nếu ứng dụng của bạn biết miền Workspace mà người dùng thuộc về, hãy sử dụng miền này để cung cấp gợi ý cho Google. Khi thành công, tài khoản người dùng được giới hạn hoặc được chọn trước cho miền được cung cấp.
Để biết thêm thông tin, hãy xem trường hd trong tài liệu về OpenID Connect.
|
state |
Không bắt buộc. Không nên. Chỉ định bất kỳ giá trị chuỗi nào mà ứng dụng của bạn sử dụng để duy trì trạng thái giữa yêu cầu uỷ quyền và phản hồi của máy chủ uỷ quyền. |
error_callback |
Không bắt buộc. Hàm JavaScript xử lý một số lỗi không phải OAuth (chẳng hạn như không mở được cửa sổ bật lên) hoặc đóng trước khi phản hồi OAuth được trả về.
Trường "type" của tham số đầu vào sẽ cho biết lý do chi tiết.
|
Loại dữ liệu: TokenClient
Lớp này chỉ có một phương thức công khai requestAccessToken
, phương thức này sẽ bắt đầu quy trình Trải nghiệm người dùng mã thông báo OAuth 2.0.
interface TokenClient {
requestAccessToken(overrideConfig?: OverridableTokenClientConfig): void;
}
Đối số | ||
---|---|---|
overrideConfig |
OverridableTokenClientConfig | Không bắt buộc. Các cấu hình sẽ được ghi đè trong phương thức này. |
Loại dữ liệu: OverridableTokenClientConfig
Bảng sau đây liệt kê các thuộc tính của kiểu dữ liệu OverridableTokenClientConfig
.
Thuộc tính | |
---|---|
scope |
Không bắt buộc. Danh sách các phạm vi được phân tách bằng dấu cách giúp xác định những tài nguyên mà ứng dụng của bạn có thể thay mặt người dùng truy cập. Các giá trị này thông báo cho màn hình xin phép mà Google hiển thị cho người dùng. |
include_granted_scopes |
Không bắt buộc, giá trị mặc định là true . Cho phép ứng dụng sử dụng quyền uỷ quyền gia tăng để yêu cầu quyền truy cập vào các phạm vi khác theo bối cảnh. Nếu bạn đặt giá trị của thông số này thành false và yêu cầu uỷ quyền được cấp, thì mã truy cập mới sẽ chỉ bao gồm mọi phạm vi mà scope đã yêu cầu trong OverridableTokenClientConfig này.
|
prompt |
Không bắt buộc. Danh sách các lời nhắc được phân tách bằng dấu cách và có phân biệt chữ hoa chữ thường để hiển thị cho người dùng. |
enable_granular_consent |
Không bắt buộc, giá trị mặc định là true . Nếu bạn đặt thành false , thì các quyền chi tiết hơn đối với Tài khoản Google
sẽ bị tắt đối với mã ứng dụng khách OAuth được tạo trước năm 2019.Nếu bạn đặt cả enable_granular_consent và enable_serial_consent , thì chỉ giá trị enable_granular_consent
mới có hiệu lực và giá trị enable_serial_consent sẽ bị bỏ qua.Không ảnh hưởng đến mã ứng dụng OAuth mới hơn, vì các quyền chi tiết hơn luôn được cấp cho các mã ứng dụng này. |
enable_serial_consent |
Không dùng nữa, bạn nên sử dụng enable_granular_consent . Cách này có tác dụng tương tự như enable_granular_consent . Các ứng dụng hiện có sử dụng enable_serial_consent có thể tiếp tục làm như vậy, nhưng bạn nên cập nhật mã của mình để sử dụng enable_granular_consent trong bản cập nhật ứng dụng tiếp theo.
|
login_hint |
Không bắt buộc. Nếu biết người dùng nào nên cho phép yêu cầu, thì ứng dụng có thể sử dụng thuộc tính này để cung cấp gợi ý đăng nhập cho Google. Khi thành công, lựa chọn tài khoản sẽ được bỏ qua. Giá trị của trường địa chỉ email hoặc mã thông báo giá trị nhận dạng phụ của người dùng mục tiêu.
Để biết thêm thông tin, hãy xem trường login_hint trong tài liệu về OpenID Connect.
|
state |
Không bắt buộc. Không nên. Chỉ định bất kỳ giá trị chuỗi nào mà ứng dụng của bạn sử dụng để duy trì trạng thái giữa yêu cầu uỷ quyền và phản hồi của máy chủ uỷ quyền. |
Loại dữ liệu: TokenResponse
Đối tượng JavaScript TokenResponse
sẽ được chuyển đến phương thức gọi lại của bạn trong trải nghiệm người dùng bật lên.
Bảng sau đây liệt kê các thuộc tính của kiểu dữ liệu TokenResponse
.
Thuộc tính | |
---|---|
access_token |
Mã truy cập của phản hồi mã thông báo thành công. |
expires_in |
Thời gian tồn tại tính bằng giây của mã truy cập. |
hd |
Miền được lưu trữ mà người dùng đã đăng nhập thuộc về. |
prompt |
Giá trị lời nhắc được sử dụng trong danh sách các giá trị có thể có được chỉ định bởi TokenClientConfig hoặc OverridableTokenClientConfig. |
token_type |
Loại mã thông báo được phát hành. |
scope |
Danh sách các phạm vi được phân tách bằng dấu cách được người dùng phê duyệt. |
state |
Giá trị chuỗi mà ứng dụng của bạn dùng để duy trì trạng thái giữa yêu cầu uỷ quyền và phản hồi. |
error |
Một mã lỗi ASCII duy nhất. |
error_description |
Văn bản ASCII mà con người có thể đọc được, cung cấp thông tin bổ sung, dùng để hỗ trợ nhà phát triển khách hàng hiểu được lỗi đã xảy ra. |
error_uri |
URI xác định trang web mà con người có thể đọc được cùng với thông tin về lỗi, được dùng để cung cấp cho nhà phát triển ứng dụng thông tin bổ sung về lỗi. |
Phương pháp: google.accounts.OAuth2.hasGrantedAllScopes
Kiểm tra xem người dùng đã cấp tất cả phạm vi hoặc phạm vi được chỉ định hay chưa.
google.accounts.oauth2.hasGrantedAllScopes(
tokenResponse: TokenResponse,
firstScope: string, ...restScopes: string[]
): boolean;
Đối số | ||
---|---|---|
tokenResponse |
TokenResponse
|
Bắt buộc. Đối tượng TokenResponse .
|
firstScope |
string | Bắt buộc. Phạm vi cần kiểm tra. |
restScopes |
string[] | Không bắt buộc. Các phạm vi khác cần kiểm tra. |
Trả bóng | |
---|---|
boolean | Đúng nếu đã cấp tất cả các phạm vi. |
Phương thức: google.accounts.OAuth2.hasGrantedAnyScope
Kiểm tra xem người dùng có cấp bất kỳ phạm vi hoặc phạm vi nào được chỉ định hay không.
google.accounts.oauth2.hasGrantedAnyScope(
tokenResponse: TokenResponse,
firstScope: string, ...restScopes: string[]
): boolean;
Đối số | ||
---|---|---|
tokenResponse |
TokenResponse
|
Bắt buộc. Đối tượng TokenResponse .
|
firstScope |
string | Bắt buộc. Phạm vi cần kiểm tra. |
restScopes |
string[] | Không bắt buộc. Các phạm vi khác cần kiểm tra. |
Trả bóng | |
---|---|
boolean | Đúng nếu có bất kỳ phạm vi nào được cấp. |
Phương thức: google.accounts.OAuth2.revoke
Phương thức revoke
thu hồi tất cả phạm vi mà người dùng đã cấp cho ứng dụng. Cần có mã truy cập hợp lệ để thu hồi quyền.
google.accounts.oauth2.revoke(accessToken: string, done: () => void): void;
Đối số | ||
---|---|---|
accessToken |
string | Bắt buộc. Mã truy cập hợp lệ. |
callback |
hàm | Không bắt buộc. Trình xử lý RevocationResponse. |
Loại dữ liệu: RevocationResponse
Đối tượng JavaScript RevocationResponse
sẽ được truyền đến phương pháp gọi lại của bạn.
Bảng sau đây liệt kê các thuộc tính của kiểu dữ liệu RevocationResponse
.
Thuộc tính | |
---|---|
successful |
Boolean. true thành công, false khi không thành công. |
error |
Chuỗi. Không xác định về thành công. Một mã lỗi ASCII duy nhất. Mã này bao gồm nhưng không giới hạn ở các mã lỗi OAuth 2.0 tiêu chuẩn. Các lỗi thường gặp đối với phương thức revoke :
|
error_description |
Chuỗi. Không xác định về thành công. Văn bản ASCII mà con người có thể đọc được cung cấp thêm thông tin về thuộc tính error . Các nhà phát triển có thể sử dụng báo cáo này để hiểu rõ hơn về lỗi đã xảy ra. Chuỗi error_description chỉ có bằng tiếng Anh.
Đối với các lỗi thường gặp nêu trong error , error_description tương ứng:
|