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

#initialize ⇒ Oauth2Service

Returns a new instance of Oauth2Service



51
52
53
54
 
# File 'generated/google/apis/oauth2_v1/service.rb', line 51

def initialize
  super('https://www.googleapis.com/', '')
  @batch_path = 'batch/oauth2/v1'
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.



38
39
40
 
# File 'generated/google/apis/oauth2_v1/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.

Returns:

  • (String) —

    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_v1/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.

Returns:

  • (String) —

    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_v1/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| ... } ⇒ Hash<String,String>

Parameters:

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (Hash<String,String>) —

    parsed result object

  • err (StandardError) —

    error object if request failed

Returns:

  • (Hash<String,String>)

Raises:



78
79
80
81
82
83
84
85
86
 
# File 'generated/google/apis/oauth2_v1/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/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

Parameters:

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



110
111
112
113
114
115
116
117
118
 
# File 'generated/google/apis/oauth2_v1/service.rb', line 110

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

Parameters:

  • robot_email (String) —

    The email of robot account.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



144
145
146
147
148
149
150
151
152
153
 
# File 'generated/google/apis/oauth2_v1/service.rb', line 144

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

Parameters:

  • robot_email (String) —

    The email of robot account.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



179
180
181
182
183
184
185
186
187
188
 
# File 'generated/google/apis/oauth2_v1/service.rb', line 179

def get_robot_metadata_raw(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>

Parameters:

  • robot_email (String) —

    The email of robot account.

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

  • result (Hash<String,String>) —

    parsed result object

  • err (StandardError) —

    error object if request failed

Returns:

  • (Hash<String,String>)

Raises:



214
215
216
217
218
219
220
221
222
223
 
# File 'generated/google/apis/oauth2_v1/service.rb', line 214

def get_robot_metadata_x509(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

Parameters:

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



285
286
287
288
289
290
291
292
293
 
# File 'generated/google/apis/oauth2_v1/service.rb', line 285

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

Parameters:

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



317
318
319
320
321
322
323
324
325
 
# File 'generated/google/apis/oauth2_v1/service.rb', line 317

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

Parameters:

  • access_token (String) —

    The oauth2 access token

  • id_token (String) —

    The ID token

  • fields (String) —

    Selector specifying which fields to include in a partial response.

  • quota_user (String) —

    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.

  • user_ip (String) —

    IP address of the site where the request originates. Use this if you want to enforce per-user limits.

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

    Request-specific options

Yields:

  • (result, err) —

    Result & error if block supplied

Yield Parameters:

Returns:

Raises:



251
252
253
254
255
256
257
258
259
260
261
 
# File 'generated/google/apis/oauth2_v1/service.rb', line 251

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