Class: Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithEmailLinkRequest

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

Overview

Request message for SignInWithEmailLink

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1SignInWithEmailLinkRequest

Returns a new instance of GoogleCloudIdentitytoolkitV1SignInWithEmailLinkRequest.



2250
2251
2252
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2250

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

Instance Attribute Details

#email ⇒ String

Required. The email address the sign-in link was sent to. The length of email should be less than 256 characters and in the format of name@domain.tld. The email should also match the RFC 822 addr- spec production. Corresponds to the JSON property email

Returns:

  • (String) 


2230
2231
2232
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2230

def email
  @email
end

#id_token ⇒ String

A valid ID token for an Identity Platform account. If passed, this request will link the email address to the user represented by this ID token and enable sign-in with email link on the account for the future. Corresponds to the JSON property idToken

Returns:

  • (String) 


2237
2238
2239
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2237

def id_token
  @id_token
end

#oob_code ⇒ String

Required. The out-of-band code from the email link. Corresponds to the JSON property oobCode

Returns:

  • (String) 


2242
2243
2244
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2242

def oob_code
  @oob_code
end

#tenant_id ⇒ String

The ID of the Identity Platform tenant the user is signing in to. If not set, the user will sign in to the default Identity Platform project. Corresponds to the JSON property tenantId

Returns:

  • (String) 


2248
2249
2250
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2248

def tenant_id
  @tenant_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2255
2256
2257
2258
2259
2260
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2255

def update!(**args)
  @email = args[:email] if args.key?(:email)
  @id_token = args[:id_token] if args.key?(:id_token)
  @oob_code = args[:oob_code] if args.key?(:oob_code)
  @tenant_id = args[:tenant_id] if args.key?(:tenant_id)
end