class Google::Apis::Oauth2V2::Oauth2Service
Google
OAuth2 API
Obtains end-user authorization grants for use with other Google
APIs.
@example
require 'google/apis/oauth2_v2' Oauth2 = Google::Apis::Oauth2V2 # Alias the module service = Oauth2::Oauth2Service.new
Attributes
@return [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.
@return [String]
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
@return [String]
Deprecated. Please use quotaUser instead.
Public Class Methods
# File lib/google/apis/oauth2_v2/service.rb, line 49 def initialize super('https://www.googleapis.com/', '', client_name: 'google-apis-oauth2_v2', client_version: Google::Apis::Oauth2V2::GEM_VERSION) @batch_path = 'batch/oauth2/v2' end
Public Instance Methods
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
@param [String] user_ip
Deprecated. Please use quotaUser instead.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::Oauth2V2::Userinfo] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::Oauth2V2::Userinfo]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/oauth2_v2/service.rb, line 110 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::Userinfo::Representation command.response_class = Google::Apis::Oauth2V2::Userinfo 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
@param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
@param [String] user_ip
Deprecated. Please use quotaUser instead.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::Oauth2V2::Userinfo] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::Oauth2V2::Userinfo]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/oauth2_v2/service.rb, line 140 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::Userinfo::Representation command.response_class = Google::Apis::Oauth2V2::Userinfo 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
@param [String] access_token @param [String] id_token @param [String] fields
Selector specifying which fields to include in a partial response.
@param [String] quota_user
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
@param [String] user_ip
Deprecated. Please use quotaUser instead.
@param [Google::Apis::RequestOptions] options
Request-specific options
@yield [result, err] Result & error if block supplied @yieldparam result [Google::Apis::Oauth2V2::Tokeninfo] parsed result object @yieldparam err [StandardError] error object if request failed
@return [Google::Apis::Oauth2V2::Tokeninfo]
@raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification @raise [Google::Apis::AuthorizationError] Authorization is required
# File lib/google/apis/oauth2_v2/service.rb, line 78 def tokeninfo(access_token: nil, id_token: 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['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
Protected Instance Methods
# File lib/google/apis/oauth2_v2/service.rb, line 152 def apply_command_defaults(command) command.query['key'] = key unless key.nil? command.query['quotaUser'] = quota_user unless quota_user.nil? command.query['userIp'] = user_ip unless user_ip.nil? end