Class: Google::Apis::Oauth2V2::Oauth2Service

Inherits:

Core::BaseService

• Object
• Core::BaseService
• Google::Apis::Oauth2V2::Oauth2Service

Defined in:

generated/google/apis/oauth2_v2/service.rb

Overview

Google OAuth2 API

Obtains end-user authorization grants for use with other Google APIs.

Examples:

require 'google/apis/oauth2_v2'

Oauth2 = Google::Apis::Oauth2V2 # Alias the module
service = Oauth2::Oauth2Service.new

See Also:

• https://developers.google.com/accounts/docs/OAuth2

Instance Attribute Summary

• #key ⇒ String

  API key.

• #quota_user ⇒ String

  An opaque string that represents a user for quota purposes.

• #user_ip ⇒ String

  Deprecated.

Attributes inherited from Core::BaseService

#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path

Instance Method Summary

• #get_cert_for_open_id_connect(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Oauth2V2::Jwk
• #get_userinfo(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Oauth2V2::Userinfoplus
• #get_userinfo_v2(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Oauth2V2::Userinfoplus
• #initialize ⇒ Oauth2Service constructor

  A new instance of Oauth2Service.

• #tokeninfo(access_token: nil, id_token: nil, token_handle: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Oauth2V2::Tokeninfo

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initialize ⇒ Oauth2Service

Returns a new instance of Oauth2Service

# File 'generated/google/apis/oauth2_v2/service.rb', line 49

def initialize
  super('https://www.googleapis.com/', '')
  @batch_path = 'batch/oauth2/v2'
end

Instance Attribute Details

#key ⇒ String

Returns API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Returns:

• (String) —

  API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

# File 'generated/google/apis/oauth2_v2/service.rb', line 38

def key
  @key
end

#quota_user ⇒ String

Returns An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Returns:

• (String) —

  An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

# File 'generated/google/apis/oauth2_v2/service.rb', line 43

def quota_user
  @quota_user
end

#user_ip ⇒ String

Returns Deprecated. Please use quotaUser instead.

Returns:

• (String) —

  Deprecated. Please use quotaUser instead.

# File 'generated/google/apis/oauth2_v2/service.rb', line 47

def user_ip
  @user_ip
end

Instance Method Details

#get_cert_for_open_id_connect(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Oauth2V2::Jwk

Parameters:

• fields (String) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) —

  An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

• user_ip (String) —

  Deprecated. Please use quotaUser instead.

• options (Google::Apis::RequestOptions) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::Oauth2V2::Jwk) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::Oauth2V2::Jwk)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'generated/google/apis/oauth2_v2/service.rb', line 74

def get_cert_for_open_id_connect(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'oauth2/v2/certs', options)
  command.response_representation = Google::Apis::Oauth2V2::Jwk::Representation
  command.response_class = Google::Apis::Oauth2V2::Jwk
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_userinfo(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Oauth2V2::Userinfoplus

Parameters:

• fields (String) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) —

  An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

• user_ip (String) —

  Deprecated. Please use quotaUser instead.

• options (Google::Apis::RequestOptions) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::Oauth2V2::Userinfoplus) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::Oauth2V2::Userinfoplus)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'generated/google/apis/oauth2_v2/service.rb', line 140

def get_userinfo(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'oauth2/v2/userinfo', options)
  command.response_representation = Google::Apis::Oauth2V2::Userinfoplus::Representation
  command.response_class = Google::Apis::Oauth2V2::Userinfoplus
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#get_userinfo_v2(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Oauth2V2::Userinfoplus

Parameters:

• fields (String) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) —

  An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

• user_ip (String) —

  Deprecated. Please use quotaUser instead.

• options (Google::Apis::RequestOptions) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::Oauth2V2::Userinfoplus) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::Oauth2V2::Userinfoplus)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'generated/google/apis/oauth2_v2/service.rb', line 170

def get_userinfo_v2(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'userinfo/v2/me', options)
  command.response_representation = Google::Apis::Oauth2V2::Userinfoplus::Representation
  command.response_class = Google::Apis::Oauth2V2::Userinfoplus
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end

#tokeninfo(access_token: nil, id_token: nil, token_handle: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Oauth2V2::Tokeninfo

Parameters:

• access_token (String)
• id_token (String)
• token_handle (String)
• fields (String) —

  Selector specifying which fields to include in a partial response.

• quota_user (String) —

  An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

• user_ip (String) —

  Deprecated. Please use quotaUser instead.

• options (Google::Apis::RequestOptions) —

  Request-specific options

Yields:

• (result, err) —

  Result & error if block supplied

Yield Parameters:

• result (Google::Apis::Oauth2V2::Tokeninfo) —

  parsed result object

• err (StandardError) —

  error object if request failed

Returns:

• (Google::Apis::Oauth2V2::Tokeninfo)

Raises:

• (Google::Apis::ServerError) —

  An error occurred on the server and the request can be retried

• (Google::Apis::ClientError) —

  The request is invalid and should not be retried without modification

• (Google::Apis::AuthorizationError) —

  Authorization is required

# File 'generated/google/apis/oauth2_v2/service.rb', line 107

def tokeninfo(access_token: nil, id_token: nil, token_handle: nil, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:post, 'oauth2/v2/tokeninfo', options)
  command.response_representation = Google::Apis::Oauth2V2::Tokeninfo::Representation
  command.response_class = Google::Apis::Oauth2V2::Tokeninfo
  command.query['access_token'] = access_token unless access_token.nil?
  command.query['id_token'] = id_token unless id_token.nil?
  command.query['token_handle'] = token_handle unless token_handle.nil?
  command.query['fields'] = fields unless fields.nil?
  command.query['quotaUser'] = quota_user unless quota_user.nil?
  command.query['userIp'] = user_ip unless user_ip.nil?
  execute_or_queue_command(command, &block)
end