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

Оптимизируйте свои подборки Сохраняйте и классифицируйте контент в соответствии со своими настройками.

В этом справочнике описывается API библиотеки Google 3P Authorization JavaScript Library, который можно использовать для загрузки кодов авторизации или токенов доступа из 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, которая обрабатывает возвращенный код ответа. Свойство будет игнорироваться пользовательским интерфейсом перенаправления.
state Необязательный. Рекомендуется для перенаправления UX. Задает любое строковое значение, которое ваше приложение использует для поддержания состояния между вашим запросом авторизации и ответом сервера авторизации.
enable_serial_consent Необязательно, по умолчанию true . Если установлено значение false , будут отключены более детальные разрешения учетной записи Google для идентификаторов клиентов OAuth, созданных до 2019 года. Не действует на более новые идентификаторы клиентов OAuth, поскольку для них всегда включены более детальные разрешения.
hint Необязательный. Если ваше приложение знает, какой пользователь должен авторизовать запрос, оно может использовать это свойство, чтобы предоставить подсказку Google. Адрес электронной почты целевого пользователя. Для получения дополнительной информации см. поле login_hint в документации OpenID Connect.
hosted_domain Необязательный. Если вашему приложению известен домен Workspace, к которому принадлежит пользователь, используйте это, чтобы дать подсказку Google. Для получения дополнительной информации см. поле hd в документах OpenID Connect.
ux_mode Необязательный. Режим UX, используемый для потока авторизации. По умолчанию поток согласия открывается во всплывающем окне. Допустимые значения: popup и redirect .
select_account Необязательно, по умолчанию «false» . Логическое значение, предлагающее пользователю выбрать учетную запись.
error_callback Необязательный. Функция JavaScript, которая обрабатывает некоторые ошибки, не связанные с OAuth, например всплывающее окно, не открывается; или закрывается до того, как будет возвращен ответ OAuth.

Поле «тип» входного параметра дает подробную причину.
  • popup_failed_to_open Не удалось открыть всплывающее окно.
  • popup_closed Всплывающее окно закрывается перед возвратом ответа OAuth.
  • unknown Заполнитель для других ошибок.

Тип данных: CodeClient

У класса есть только один общедоступный метод requestCode, который запускает поток OAuth 2.0 Code UX.

interface CodeClient {
  requestCode(): void;
}

Тип данных: CodeResponse

Объект JavaScript CodeResponse будет передан вашему методу callback во всплывающем 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' . Разделенный пробелами и чувствительный к регистру список подсказок для представления пользователя. Возможные значения:
  • пустая строка Пользователю будет предложено только в первый раз, когда ваше приложение запрашивает доступ. Нельзя указать с другими значениями.
  • 'none' Не отображать никаких экранов аутентификации или согласия. Не должно быть указано с другими значениями.
  • 'согласие' Запрашивать у пользователя согласие.
  • 'select_account' Предлагает пользователю выбрать учетную запись.
enable_serial_consent Необязательно, по умолчанию true . Если установлено значение false , будут отключены более детальные разрешения учетной записи Google для идентификаторов клиентов OAuth, созданных до 2019 года. Не действует на более новые идентификаторы клиентов OAuth, поскольку для них всегда включены более детальные разрешения.
hint Необязательный. Если ваше приложение знает, какой пользователь должен авторизовать запрос, оно может использовать это свойство, чтобы предоставить подсказку Google. Адрес электронной почты целевого пользователя. Для получения дополнительной информации см. поле login_hint в документации OpenID Connect.
hosted_domain Необязательный. Если вашему приложению известен домен Workspace, к которому принадлежит пользователь, используйте это, чтобы дать подсказку Google. Для получения дополнительной информации см. поле hd в документах OpenID Connect.
state Необязательный. Не рекомендуется. Задает любое строковое значение, которое ваше приложение использует для поддержания состояния между вашим запросом авторизации и ответом сервера авторизации.
error_callback Необязательный. Функция JavaScript, которая обрабатывает некоторые ошибки, не связанные с OAuth, например всплывающее окно, не открывается; или закрывается до того, как будет возвращен ответ OAuth.

Поле «тип» входного параметра дает подробную причину.
  • popup_failed_to_open Не удалось открыть всплывающее окно.
  • popup_closed Всплывающее окно закрывается перед возвратом ответа OAuth.
  • unknown Заполнитель для других ошибок.

Тип данных: TokenClient

У класса есть только один общедоступный метод requestAccessToken , который запускает 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_serial_consent Необязательно, по умолчанию true . Если установлено значение false , будут отключены более детальные разрешения учетной записи Google для идентификаторов клиентов OAuth, созданных до 2019 года. Не действует на более новые идентификаторы клиентов OAuth, поскольку для них всегда включены более детальные разрешения.
hint Необязательный. Если ваше приложение знает, какой пользователь должен авторизовать запрос, оно может использовать это свойство, чтобы предоставить подсказку Google. Адрес электронной почты целевого пользователя. Для получения дополнительной информации см. поле login_hint в документации OpenID Connect.
state Необязательный. Не рекомендуется. Задает любое строковое значение, которое ваше приложение использует для поддержания состояния между вашим запросом авторизации и ответом сервера авторизации.

Тип данных: TokenResponse

Объект TokenResponse JavaScript будет передан вашему методу обратного вызова во всплывающем 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 нить[] Необязательный. Другие области для проверки.
Возвращает
логический True, если предоставлены все области.

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

Проверяет, предоставил ли пользователь какую-либо из указанных областей или областей.

google.accounts.oauth2.hasGrantedAnyScope(
                                           tokenResponse: TokenResponse,
                                           firstScope: string, ...restScopes: string[]
                                         ): boolean;
Аргументы
tokenResponse TokenResponse Необходимый. Объект TokenResponse .
firstScope нить Необходимый. Объем для проверки.
restScopes нить[] Необязательный. Другие области для проверки.
Возвращает
логический Истинно, если предоставлена ​​какая-либо из областей.

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

Метод revoke отменяет все области, которые пользователь предоставил приложению. Для отзыва разрешения требуется действительный токен доступа.

google.accounts.oauth2.revoke(accessToken: string, done: () => void): void;
Аргументы
accessToken нить Необходимый. Действительный токен доступа.
callback функция Необязательный. Обработчик ответа на отзыв .

Тип данных: RevocationResponse

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

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

Характеристики
successful логический. true в случае успеха, false в случае неудачи.
error Нить. Не определено в случае успеха. Один код ошибки ASCII. Это включает, помимо прочего, стандартные коды ошибок OAuth 2.0 . Распространенные ошибки метода revoke :
  • invalid_token — Токен уже просрочен или отозван до вызова метода revoke . В большинстве случаев вы можете считать грант, связанный с accessToken , отозванным.
  • invalid_request — токен не подлежит отзыву. Вы должны убедиться, accessToken является действительным удостоверением Google OAuth 2.0.
error_description Нить. Не определено в случае успеха. Удобочитаемый текст ASCII предоставляет дополнительную информацию о свойстве error . Разработчики могут использовать это, чтобы лучше понять возникшую ошибку. Строка error_description только на английском языке. Для распространенных ошибок, перечисленных в error , соответствующее error_description :
  • invalid_token — Токен просрочен или отозван.
  • invalid_request — токен не подлежит отзыву.
,

В этом справочнике описывается API библиотеки Google 3P Authorization JavaScript Library, который можно использовать для загрузки кодов авторизации или токенов доступа из 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, которая обрабатывает возвращенный код ответа. Свойство будет игнорироваться пользовательским интерфейсом перенаправления.
state Необязательный. Рекомендуется для перенаправления UX. Задает любое строковое значение, которое ваше приложение использует для поддержания состояния между вашим запросом авторизации и ответом сервера авторизации.
enable_serial_consent Необязательно, по умолчанию true . Если установлено значение false , будут отключены более детальные разрешения учетной записи Google для идентификаторов клиентов OAuth, созданных до 2019 года. Не действует на более новые идентификаторы клиентов OAuth, поскольку для них всегда включены более детальные разрешения.
hint Необязательный. Если ваше приложение знает, какой пользователь должен авторизовать запрос, оно может использовать это свойство, чтобы предоставить подсказку Google. Адрес электронной почты целевого пользователя. Для получения дополнительной информации см. поле login_hint в документации OpenID Connect.
hosted_domain Необязательный. Если вашему приложению известен домен Workspace, к которому принадлежит пользователь, используйте это, чтобы дать подсказку Google. Для получения дополнительной информации см. поле hd в документах OpenID Connect.
ux_mode Необязательный. Режим UX, используемый для потока авторизации. По умолчанию поток согласия открывается во всплывающем окне. Допустимые значения: popup и redirect .
select_account Необязательно, по умолчанию «false» . Логическое значение, предлагающее пользователю выбрать учетную запись.
error_callback Необязательный. Функция JavaScript, которая обрабатывает некоторые ошибки, не связанные с OAuth, например всплывающее окно, не открывается; или закрывается до того, как будет возвращен ответ OAuth.

Поле «тип» входного параметра дает подробную причину.
  • popup_failed_to_open Не удалось открыть всплывающее окно.
  • popup_closed Всплывающее окно закрывается перед возвратом ответа OAuth.
  • unknown Заполнитель для других ошибок.

Тип данных: CodeClient

У класса есть только один общедоступный метод requestCode, который запускает поток OAuth 2.0 Code UX.

interface CodeClient {
  requestCode(): void;
}

Тип данных: CodeResponse

Объект JavaScript CodeResponse будет передан вашему методу callback во всплывающем 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' . Разделенный пробелами и чувствительный к регистру список подсказок для представления пользователя. Возможные значения:
  • пустая строка Пользователю будет предложено только в первый раз, когда ваше приложение запрашивает доступ. Нельзя указать с другими значениями.
  • 'none' Не отображать никаких экранов аутентификации или согласия. Не должно быть указано с другими значениями.
  • 'согласие' Запрашивать у пользователя согласие.
  • 'select_account' Предлагает пользователю выбрать учетную запись.
enable_serial_consent Необязательно, по умолчанию true . Если установлено значение false , будут отключены более детальные разрешения учетной записи Google для идентификаторов клиентов OAuth, созданных до 2019 года. Не действует на более новые идентификаторы клиентов OAuth, поскольку для них всегда включены более детальные разрешения.
hint Необязательный. Если ваше приложение знает, какой пользователь должен авторизовать запрос, оно может использовать это свойство, чтобы предоставить подсказку Google. Адрес электронной почты целевого пользователя. Для получения дополнительной информации см. поле login_hint в документации OpenID Connect.
hosted_domain Необязательный. Если вашему приложению известен домен Workspace, к которому принадлежит пользователь, используйте это, чтобы дать подсказку Google. Для получения дополнительной информации см. поле hd в документах OpenID Connect.
state Необязательный. Не рекомендуется. Задает любое строковое значение, которое ваше приложение использует для поддержания состояния между вашим запросом авторизации и ответом сервера авторизации.
error_callback Необязательный. Функция JavaScript, которая обрабатывает некоторые ошибки, не связанные с OAuth, например всплывающее окно, не открывается; или закрывается до того, как будет возвращен ответ OAuth.

Поле «тип» входного параметра дает подробную причину.
  • popup_failed_to_open Не удалось открыть всплывающее окно.
  • popup_closed Всплывающее окно закрывается перед возвратом ответа OAuth.
  • unknown Заполнитель для других ошибок.

Тип данных: TokenClient

У класса есть только один общедоступный метод requestAccessToken , который запускает 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_serial_consent Необязательно, по умолчанию true . Если установлено значение false , будут отключены более детальные разрешения учетной записи Google для идентификаторов клиентов OAuth, созданных до 2019 года. Не действует на более новые идентификаторы клиентов OAuth, поскольку для них всегда включены более детальные разрешения.
hint Необязательный. Если ваше приложение знает, какой пользователь должен авторизовать запрос, оно может использовать это свойство, чтобы предоставить подсказку Google. Адрес электронной почты целевого пользователя. Для получения дополнительной информации см. поле login_hint в документации OpenID Connect.
state Необязательный. Не рекомендуется. Задает любое строковое значение, которое ваше приложение использует для поддержания состояния между вашим запросом авторизации и ответом сервера авторизации.

Тип данных: TokenResponse

Объект TokenResponse JavaScript будет передан вашему методу обратного вызова во всплывающем 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 нить[] Необязательный. Другие области для проверки.
Возвращает
логический True, если предоставлены все области.

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

Проверяет, предоставил ли пользователь какую-либо из указанных областей или областей.

google.accounts.oauth2.hasGrantedAnyScope(
                                           tokenResponse: TokenResponse,
                                           firstScope: string, ...restScopes: string[]
                                         ): boolean;
Аргументы
tokenResponse TokenResponse Необходимый. Объект TokenResponse .
firstScope нить Необходимый. Объем для проверки.
restScopes нить[] Необязательный. Другие области для проверки.
Возвращает
логический Истинно, если предоставлена ​​какая-либо из областей.

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

Метод revoke отменяет все области, которые пользователь предоставил приложению. Для отзыва разрешения требуется действительный токен доступа.

google.accounts.oauth2.revoke(accessToken: string, done: () => void): void;
Аргументы
accessToken нить Необходимый. Действительный токен доступа.
callback функция Необязательный. Обработчик ответа на отзыв .

Тип данных: RevocationResponse

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

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

Характеристики
successful логический. true в случае успеха, false в случае неудачи.
error Нить. Не определено в случае успеха. Один код ошибки ASCII. Это включает, помимо прочего, стандартные коды ошибок OAuth 2.0 . Распространенные ошибки метода revoke :
  • invalid_token — Токен уже просрочен или отозван до вызова метода revoke . В большинстве случаев вы можете считать грант, связанный с accessToken , отозванным.
  • invalid_request — токен не подлежит отзыву. Вы должны убедиться, accessToken является действительным удостоверением Google OAuth 2.0.
error_description Нить. Не определено в случае успеха. Удобочитаемый текст ASCII предоставляет дополнительную информацию о свойстве error . Разработчики могут использовать это, чтобы лучше понять возникшую ошибку. Строка error_description только на английском языке. Для распространенных ошибок, перечисленных в error , соответствующее error_description :
  • invalid_token — Токен просрочен или отозван.
  • invalid_request — токен не подлежит отзыву.