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.



1279
1280
1281
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1279

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) 


1242
1243
1244
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1242

def captcha_resp
  @captcha_resp
end

#challenge ⇒ String

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

Returns:

  • (String) 


1247
1248
1249
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1247

def challenge
  @challenge
end

#email ⇒ String

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

Returns:

  • (String) 


1252
1253
1254
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1252

def email
  @email
end

#id_token ⇒ String

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

Returns:

  • (String) 


1257
1258
1259
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1257

def id_token
  @id_token
end

#kind ⇒ String

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

Returns:

  • (String) 


1262
1263
1264
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1262

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) 


1267
1268
1269
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1267

def new_email
  @new_email
end

#request_type ⇒ String

The request type. Corresponds to the JSON property requestType

Returns:

  • (String) 


1272
1273
1274
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1272

def request_type
  @request_type
end

#user_ip ⇒ String

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

Returns:

  • (String) 


1277
1278
1279
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1277

def user_ip
  @user_ip
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1284

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