Class: Google::Apis::IdentitytoolkitV3::Relyingparty

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/identitytoolkit_v3/classes.rb,
generated/google/apis/identitytoolkit_v3/representations.rb,
generated/google/apis/identitytoolkit_v3/representations.rb

Overview

Request of getting a code for user confirmation (reset password, change email etc.)

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Relyingparty

Returns a new instance of Relyingparty



1348
1349
1350
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1348

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#captcha_resp ⇒ String

The recaptcha response from the user. Corresponds to the JSON property captchaResp

Returns:

  • (String) 


1311
1312
1313
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1311

def captcha_resp
  @captcha_resp
end

#challenge ⇒ String

The recaptcha challenge presented to the user. Corresponds to the JSON property challenge

Returns:

  • (String) 


1316
1317
1318
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1316

def challenge
  @challenge
end

#email ⇒ String

The email of the user. Corresponds to the JSON property email

Returns:

  • (String) 


1321
1322
1323
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1321

def email
  @email
end

#id_token ⇒ String

The user's Gitkit login token for email change. Corresponds to the JSON property idToken

Returns:

  • (String) 


1326
1327
1328
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1326

def id_token
  @id_token
end

#kind ⇒ String

The fixed string "identitytoolkit#relyingparty". Corresponds to the JSON property kind

Returns:

  • (String) 


1331
1332
1333
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1331

def kind
  @kind
end

#new_email ⇒ String

The new email if the code is for email change. Corresponds to the JSON property newEmail

Returns:

  • (String) 


1336
1337
1338
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1336

def new_email
  @new_email
end

#request_type ⇒ String

The request type. Corresponds to the JSON property requestType

Returns:

  • (String) 


1341
1342
1343
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1341

def request_type
  @request_type
end

#user_ip ⇒ String

The IP address of the user. Corresponds to the JSON property userIp

Returns:

  • (String) 


1346
1347
1348
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1346

def user_ip
  @user_ip
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1353

def update!(**args)
  @captcha_resp = args[:captcha_resp] if args.key?(:captcha_resp)
  @challenge = args[:challenge] if args.key?(:challenge)
  @email = args[:email] if args.key?(:email)
  @id_token = args[:id_token] if args.key?(:id_token)
  @kind = args[:kind] if args.key?(:kind)
  @new_email = args[:new_email] if args.key?(:new_email)
  @request_type = args[:request_type] if args.key?(:request_type)
  @user_ip = args[:user_ip] if args.key?(:user_ip)
end