Class: Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Email

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

Overview

Configuration options related to authenticating a user by their email address.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitAdminV2Email

Returns a new instance of GoogleCloudIdentitytoolkitAdminV2Email.



492
493
494
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 492

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

Instance Attribute Details

#enabled ⇒ Boolean Also known as: enabled?

Whether email auth is enabled for the project or not. Corresponds to the JSON property enabled

Returns:

  • (Boolean) 


481
482
483
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 481

def enabled
  @enabled
end

#password_required ⇒ Boolean Also known as: password_required?

Whether a password is required for email auth or not. If true, both an email and password must be provided to sign in. If false, a user may sign in via either email/password or email link. Corresponds to the JSON property passwordRequired

Returns:

  • (Boolean) 


489
490
491
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 489

def password_required
  @password_required
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



497
498
499
500
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 497

def update!(**args)
  @enabled = args[:enabled] if args.key?(:enabled)
  @password_required = args[:password_required] if args.key?(:password_required)
end