Библиотека JavaScript авторизации Google 3P для веб-сайтов – справочник по API

В этом справочнике описан API библиотеки JavaScript авторизации Google 3P, который можно использовать для загрузки кодов авторизации или токенов доступа от Google.

Метод: google.accounts.oauth2.initCodeClient

Метод initCodeClient инициализирует и возвращает клиентский код с конфигурациями в параметре.

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

Тип данных: Кодеклиентконфиг.

В следующей таблице перечислены свойства типа данных CodeClientConfig .

Тип данных: КодКлиент

Класс имеет только один общедоступный метод requestCode, который запускает поток пользовательского интерфейса кода OAuth 2.0.

interface CodeClient {
  requestCode(): void;
}

Тип данных: КодОтвет

Объект CodeResponse JavaScript будет передан вашему методу callback во всплывающем окне пользовательского интерфейса. В интерфейсе перенаправления CodeResponse будет передан в качестве параметров URL.

В следующей таблице перечислены свойства типа данных CodeResponse .

Метод: google.accounts.oauth2.initTokenClient

Метод initTokenClient инициализирует и возвращает клиент токена с конфигурациями, указанными в параметре.

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

Тип данных: ТокенКлиентКонфиг.

В следующей таблице перечислены свойства типа данных TokenClientConfig .

Тип данных: ТокенКлиент

Класс имеет только один общедоступный метод requestAccessToken , который запускает поток пользовательского интерфейса токена OAuth 2.0.

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

Тип данных: Оверридаблетокенклиентконфиг.

В следующей таблице перечислены свойства типа данных OverridableTokenClientConfig .

Тип данных: TokenResponse

Объект JavaScript TokenResponse будет передан вашему методу обратного вызова во всплывающем окне пользовательского интерфейса.

В следующей таблице перечислены свойства типа данных 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;

Тип данных: отзывответ

В ваш метод обратного вызова будет передан объект JavaScript RevocationResponse .

В следующей таблице перечислены свойства типа данных RevocationResponse .