Google 帳戶授權 JavaScript API 參考資料

本參考資料說明 Google 帳戶授權 JavaScript API，可用於從 Google 取得授權碼或存取權杖。

方法：google.accounts.oauth2.initCodeClient

initCodeClient 方法會初始化並傳回程式碼用戶端，並使用參數中的設定。

google.accounts.oauth2.initCodeClient(config: CodeClientConfig)

資料類型：CodeClientConfig

下表列出 CodeClientConfig 資料類型的屬性。

資料類型：CodeClient

這個類別只有一個公開方法 requestCode，可啟動 OAuth 2.0 程式碼 UX 流程。

interface CodeClient {
  requestCode(): void;
}

資料類型：CodeResponse

系統會在彈出式視窗 UX 中，將 CodeResponse JavaScript 物件傳遞至 callback 方法。在重新導向 UX 中，CodeResponse 會以網址參數的形式傳遞。

下表列出 CodeResponse 資料類型的屬性。

方法：google.accounts.oauth2.initTokenClient

initTokenClient 方法會初始化並傳回權杖用戶端，並使用參數中的設定。

google.accounts.oauth2.initTokenClient(config: TokenClientConfig)

資料類型：TokenClientConfig

下表列出 TokenClientConfig 資料類型的屬性。

資料類型：TokenClient

這個類別只有一個公開方法 requestAccessToken，可啟動 OAuth 2.0 權杖 UX 流程。

interface TokenClient {
  requestAccessToken(overrideConfig?: OverridableTokenClientConfig): void;
}

資料類型：OverridableTokenClientConfig

下表列出 OverridableTokenClientConfig 資料類型的屬性。

資料類型：TokenResponse

系統會在彈出式視窗 UX 中，將 TokenResponse JavaScript 物件傳遞至回呼方法。

下表列出 TokenResponse 資料類型的屬性。

方法：google.accounts.oauth2.hasGrantedAllScopes

檢查使用者是否已授予所有指定的範圍。

google.accounts.oauth2.hasGrantedAllScopes(
                                            tokenResponse: TokenResponse,
                                            firstScope: string, ...restScopes: string[]
                                          ): boolean;

方法：google.accounts.oauth2.hasGrantedAnyScope

檢查使用者是否已授予任何指定的範圍。

google.accounts.oauth2.hasGrantedAnyScope(
                                           tokenResponse: TokenResponse,
                                           firstScope: string, ...restScopes: string[]
                                         ): boolean;

方法：google.accounts.oauth2.revoke

revoke 方法會撤銷使用者授予應用程式的所有範圍。 撤銷權限時，必須提供有效的存取權杖。

google.accounts.oauth2.revoke(accessToken: string, done: () => void): void;

資料類型：RevocationResponse

系統會將 RevocationResponse JavaScript 物件傳遞至回呼方法。

下表列出 RevocationResponse 資料類型的屬性。