class Google::Auth::UserRefreshCredentials
cf [Application Default Credentials](cloud.google.com/docs/authentication/production)
location
’gcloud auth login’ saves a file with these contents in well known
This the end of the result of a 3LO flow. E.g, the end result of
This class allows authorizing requests from user refresh tokens.
Authenticates requests using User Refresh credentials.
def self.make_creds options = {} # rubocop:disable Metrics/MethodLength
-
scope(string|array|nil) -- the scope(s) to access -
json_key_io(IO) -- An IO object containing the JSON key
def self.make_creds options = {} # rubocop:disable Metrics/MethodLength json_key_io, scope = options.values_at :json_key_io, :scope user_creds = if json_key_io json_key = JSON.parse json_key_io.read if json_key.key? "type" json_key_io.rewind else # Defaults to class credential 'type' if missing. json_key["type"] = CREDENTIAL_TYPE_NAME json_key_io = StringIO.new JSON.generate(json_key) end CredentialsLoader.load_and_verify_json_key_type json_key_io, CREDENTIAL_TYPE_NAME read_json_key json_key_io else { "client_id" => ENV[CredentialsLoader::CLIENT_ID_VAR], "client_secret" => ENV[CredentialsLoader::CLIENT_SECRET_VAR], "refresh_token" => ENV[CredentialsLoader::REFRESH_TOKEN_VAR], "project_id" => ENV[CredentialsLoader::PROJECT_ID_VAR], "quota_project_id" => nil, "universe_domain" => nil } end new(token_credential_uri: TOKEN_CRED_URI, client_id: user_creds["client_id"], client_secret: user_creds["client_secret"], refresh_token: user_creds["refresh_token"], project_id: user_creds["project_id"], quota_project_id: user_creds["quota_project_id"], scope: scope, universe_domain: user_creds["universe_domain"] || "googleapis.com") .configure_connection(options) end
def self.read_json_key json_key_io
-
(Google::Auth::InitializationError)- If the JSON is missing required fields
Returns:
-
(Hash)- The parsed JSON key
Parameters:
-
json_key_io(IO) -- An IO object containing the JSON key
def self.read_json_key json_key_io json_key = JSON.parse json_key_io.read wanted = ["client_id", "client_secret", "refresh_token"] wanted.each do |key| raise InitializationError, "the json is missing the #{key} field" unless json_key.key? key end json_key end
def duplicate options = {}
-
options(Hash) -- Overrides for the credentials parameters.
def duplicate options = {} options = deep_hash_normalize options super( { project_id: @project_id, quota_project_id: @quota_project_id }.merge(options) ) end
def includes_scope? required_scope
-
(Boolean)-
Parameters:
-
required_scope(Array) --, String
def includes_scope? required_scope missing_scope = Google::Auth::ScopeUtil.normalize(required_scope) - Google::Auth::ScopeUtil.normalize(scope) missing_scope.empty? end
def initialize options = {}
def initialize options = {} options ||= {} options[:token_credential_uri] ||= TOKEN_CRED_URI options[:authorization_uri] ||= AUTHORIZATION_URI @project_id = options[:project_id] @project_id ||= CredentialsLoader.load_gcloud_project_id @quota_project_id = options[:quota_project_id] super options end
def principal
-
(String, Symbol)- the client ID or :user_refresh if not available
Other tags:
- Private: -
def principal @client_id || :user_refresh end
def revoke! options = {}
-
(Google::Auth::AuthorizationError)- If the revocation request fails
Options Hash:
(**options)-
:connection(Faraday::Connection) -- The connection to use
Parameters:
-
options(Hash) -- Options for revoking the credential
def revoke! options = {} c = options[:connection] || Faraday.default_connection retry_with_error do resp = c.post(REVOKE_TOKEN_URI, token: refresh_token || access_token) case resp.status when 200 self.access_token = nil self.refresh_token = nil self.expires_at = 0 else raise AuthorizationError.with_details( "Unexpected error code #{resp.status}", credential_type_name: self.class.name, principal: principal ) end resp.body end end
def update! options = {}
-
(Google::Auth::UserRefreshCredentials)-
Parameters:
-
options(Hash) -- Overrides for the credentials parameters.
def update! options = {} # Normalize all keys to symbols to allow indifferent access. options = deep_hash_normalize options @project_id = options[:project_id] if options.key? :project_id @quota_project_id = options[:quota_project_id] if options.key? :quota_project_id super(options) self end