googleauth - Class Signet::OAuth2::Client (v1.15.0)

Reference documentation and code samples for the googleauth class Signet::OAuth2::Client.

Signet::OAuth2::Client creates an OAuth2 client

This reopens Client to add #apply and #apply! methods which update a hash with the fetched authentication token.

Inherits

  • Object

Methods

#build_default_connection

  def 
  
 build_default_connection 
 () 
 

#configure_connection

  def 
  
 configure_connection 
 ( 
 options 
 ) 
 

#duplicate

  def 
  
 duplicate 
 ( 
 options 
  
 = 
  
 {}) 
 

Creates a duplicate of these credentials without the Signet::OAuth2::Client-specific transient state (e.g. cached tokens)

Parameter
  • options(Hash) — Overrides for the credentials parameters.

#fetch_access_token!

  def 
  
 fetch_access_token! 
 ( 
 options 
  
 = 
  
 {}) 
 

#generate_access_token_request

  def 
  
 generate_access_token_request 
 ( 
 options 
  
 = 
  
 {}) 
 

#googleauth_orig_generate_access_token_request

  def 
  
 googleauth_orig_generate_access_token_request 
 () 
 

#orig_fetch_access_token!

  def 
  
 orig_fetch_access_token! 
 () 
 

#retry_with_error

  def 
  
 retry_with_error 
 ( 
 max_retry_count 
  
 = 
  
 5 
 ) 
  
 - 
>  
 Object 
 

Retries the provided block with exponential backoff, handling and wrapping errors.

Parameter
  • max_retry_count(Integer) — The maximum number of retries before giving up
Yields
  • — The block to execute and potentially retry
Returns
  • (Object) — The result of the block if successful
Raises

#token_type

  def 
  
 token_type 
 () 
 

The token type as symbol, either :id_token or :access_token

#universe_domain

  def 
  
 universe_domain 
 () 
 

Set the universe domain

#universe_domain=

  def 
  
 universe_domain= 
 ( 
 value 
 ) 
 

Set the universe domain

#update!

  def 
  
 update! 
 ( 
 options 
  
 = 
  
 {}) 
 

#update_signet_base

  def 
  
 update_signet_base 
 () 
 

#update_token!

  def 
  
 update_token! 
 ( 
 options 
  
 = 
  
 {}) 
 

#update_token_signet_base

  def 
  
 update_token_signet_base 
 () 
 
Create a Mobile Website
View Site in Mobile | Classic
Share by: