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.
Instance Attribute Summary collapse
-
#key ⇒ String
API key.
-
#quota_user ⇒ String
Available to use for quota purposes for server-side applications.
-
#user_ip ⇒ String
IP address of the site where the request originates.
Attributes inherited from Core::BaseService
#authorization, #base_path, #batch_path, #client, #client_options, #request_options, #root_url, #upload_path
Instance Method Summary collapse
- #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
Constructor Details
#initialize ⇒ Oauth2Service
Returns a new instance of Oauth2Service
51 52 53 54 |
# File 'generated/google/apis/oauth2_v2/service.rb', line 51 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.
38 39 40 |
# File 'generated/google/apis/oauth2_v2/service.rb', line 38 def key @key end |
#quota_user ⇒ String
Returns Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.
44 45 46 |
# File 'generated/google/apis/oauth2_v2/service.rb', line 44 def quota_user @quota_user end |
#user_ip ⇒ String
Returns IP address of the site where the request originates. Use this if you want to enforce per-user limits.
49 50 51 |
# File 'generated/google/apis/oauth2_v2/service.rb', line 49 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
78 79 80 81 82 83 84 85 86 |
# File 'generated/google/apis/oauth2_v2/service.rb', line 78 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', ) 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
148 149 150 151 152 153 154 155 156 |
# File 'generated/google/apis/oauth2_v2/service.rb', line 148 def get_userinfo(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'oauth2/v2/userinfo', ) 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
180 181 182 183 184 185 186 187 188 |
# File 'generated/google/apis/oauth2_v2/service.rb', line 180 def get_userinfo_v2(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block) command = make_simple_command(:get, 'userinfo/v2/me', ) 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
113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'generated/google/apis/oauth2_v2/service.rb', line 113 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', ) 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 |