googleauth - Class Google::Auth::IDTokens::Verifier (v1.13.1)

Reference documentation and code samples for the googleauth class Google::Auth::IDTokens::Verifier.

An object that can verify ID tokens.

A verifier maintains a set of default settings, including the key source and fields to verify. However, individual verification calls can override any of these settings.

Inherits

Object

Methods

#initialize

  def 
  
 initialize 
 ( 
 key_source 
 : 
  
 nil 
 , 
  
 aud 
 : 
  
 nil 
 , 
  
 azp 
 : 
  
 nil 
 , 
  
 iss 
 : 
  
 nil 
 ) 
  
 - 
>  
 Verifier

Create a verifier.

Parameters

key_source(key source) (defaults to: nil) — The default key source to use. All verification calls must have a key source, so if no default key source is provided here, then calls to #verify must provide a key source.
aud(String, nil) (defaults to: nil) — The default audience ( aud ) check, or nil for no check.
azp(String, nil) (defaults to: nil) — The default authorized party ( azp ) check, or nil for no check.
iss(String, nil) (defaults to: nil) — The default issuer ( iss ) check, or nil for no check.

Returns

( Verifier ) — a new instance of Verifier

#verify

  def 
  
 verify 
 ( 
 token 
 , 
  
 key_source 
 : 
  
 :default 
 , 
  
 aud 
 : 
  
 :default 
 , 
  
 azp 
 : 
  
 :default 
 , 
  
 iss 
 : 
  
 :default 
 ) 
  
 - 
>  
 Hash

Verify the given token.