Class: Google::Apis::Oauth2V1::Oauth2Service

Inherits:
Core::BaseService show all
Defined in:
generated/google/apis/oauth2_v1/service.rb

Overview

Google OAuth2 API

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

Examples:

require 'google/apis/oauth2_v1'

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

See Also:

Instance Attribute Summary collapse

Attributes inherited from Core::BaseService

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

Instance Method Summary collapse

Methods inherited from Core::BaseService

#batch, #batch_upload, #fetch_all, #http

Methods included from Core::Logging

#logger

Constructor Details

#initializeOauth2Service


49
50
51
52
# File 'generated/google/apis/oauth2_v1/service.rb', line 49

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

Instance Attribute Details

#keyString


38
39
40
# File 'generated/google/apis/oauth2_v1/service.rb', line 38

def key
  @key
end

#quota_userString


43
44
45
# File 'generated/google/apis/oauth2_v1/service.rb', line 43

def quota_user
  @quota_user
end

#user_ipString


47
48
49
# File 'generated/google/apis/oauth2_v1/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| ... } ⇒ Hash<String,String>

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (Hash<String,String>)

    parsed result object

  • err (StandardError)

    error object if request failed

Raises:


74
75
76
77
78
79
80
81
82
# File 'generated/google/apis/oauth2_v1/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/v1/certs', options)
  command.response_representation = Hash<String,String>::Representation
  command.response_class = Hash<String,String>
  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_cert_for_open_id_connect_raw(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Oauth2V1::Raw

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


104
105
106
107
108
109
110
111
112
# File 'generated/google/apis/oauth2_v1/service.rb', line 104

def get_cert_for_open_id_connect_raw(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'oauth2/v1/raw_public_keys', options)
  command.response_representation = Google::Apis::Oauth2V1::Raw::Representation
  command.response_class = Google::Apis::Oauth2V1::Raw
  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_robot_jwk(robot_email, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Oauth2V1::Jwk

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


136
137
138
139
140
141
142
143
144
145
# File 'generated/google/apis/oauth2_v1/service.rb', line 136

def get_robot_jwk(robot_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'service_accounts/v1/jwk/{robotEmail}', options)
  command.response_representation = Google::Apis::Oauth2V1::Jwk::Representation
  command.response_class = Google::Apis::Oauth2V1::Jwk
  command.params['robotEmail'] = robot_email unless robot_email.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

#get_robot_metadata_raw(robot_email, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Oauth2V1::Raw

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


169
170
171
172
173
174
175
176
177
178
# File 'generated/google/apis/oauth2_v1/service.rb', line 169

def (robot_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'service_accounts/v1/metadata/raw/{robotEmail}', options)
  command.response_representation = Google::Apis::Oauth2V1::Raw::Representation
  command.response_class = Google::Apis::Oauth2V1::Raw
  command.params['robotEmail'] = robot_email unless robot_email.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

#get_robot_metadata_x509(robot_email, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Hash<String,String>

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

  • result (Hash<String,String>)

    parsed result object

  • err (StandardError)

    error object if request failed

Raises:


202
203
204
205
206
207
208
209
210
211
# File 'generated/google/apis/oauth2_v1/service.rb', line 202

def (robot_email, fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'service_accounts/v1/metadata/x509/{robotEmail}', options)
  command.response_representation = Hash<String,String>::Representation
  command.response_class = Hash<String,String>
  command.params['robotEmail'] = robot_email unless robot_email.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

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

Get user info

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


269
270
271
272
273
274
275
276
277
# File 'generated/google/apis/oauth2_v1/service.rb', line 269

def get_userinfo(fields: nil, quota_user: nil, user_ip: nil, options: nil, &block)
  command =  make_simple_command(:get, 'oauth2/v1/userinfo', options)
  command.response_representation = Google::Apis::Oauth2V1::Userinfoplus::Representation
  command.response_class = Google::Apis::Oauth2V1::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_me(fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Oauth2V1::Userinfoplus

Get user info

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


299
300
301
302
303
304
305
306
307
# File 'generated/google/apis/oauth2_v1/service.rb', line 299

def get_userinfo_v2_me(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::Oauth2V1::Userinfoplus::Representation
  command.response_class = Google::Apis::Oauth2V1::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, fields: nil, quota_user: nil, user_ip: nil, options: nil) {|result, err| ... } ⇒ Google::Apis::Oauth2V1::Tokeninfo

Get token info

Yields:

  • (result, err)

    Result & error if block supplied

Yield Parameters:

Raises:


237
238
239
240
241
242
243
244
245
246
247
# File 'generated/google/apis/oauth2_v1/service.rb', line 237

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/v1/tokeninfo', options)
  command.response_representation = Google::Apis::Oauth2V1::Tokeninfo::Representation
  command.response_class = Google::Apis::Oauth2V1::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