Class: Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Tenant

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

A Tenant contains configuration for the tenant in a multi-tenant project.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitAdminV2Tenant

Returns a new instance of GoogleCloudIdentitytoolkitAdminV2Tenant.



1707
1708
1709
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1707

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

Instance Attribute Details

#allow_password_signup ⇒ Boolean Also known as: allow_password_signup?

Whether to allow email/password user authentication. Corresponds to the JSON property allowPasswordSignup

Returns:

  • (Boolean) 


1619
1620
1621
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1619

def 
  @allow_password_signup
end

#autodelete_anonymous_users ⇒ Boolean Also known as: autodelete_anonymous_users?

Whether anonymous users will be auto-deleted after a period of 30 days. Corresponds to the JSON property autodeleteAnonymousUsers

Returns:

  • (Boolean) 


1625
1626
1627
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1625

def autodelete_anonymous_users
  @autodelete_anonymous_users
end

#client ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2ClientPermissionConfig

Options related to how clients making requests on behalf of a tenant should be configured. Corresponds to the JSON property client

Returns:



1632
1633
1634
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1632

def client
  @client
end

#disable_auth ⇒ Boolean Also known as: disable_auth?

Whether authentication is disabled for the tenant. If true, the users under the disabled tenant are not allowed to sign-in. Admins of the disabled tenant are not able to manage its users. Corresponds to the JSON property disableAuth

Returns:

  • (Boolean) 


1639
1640
1641
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1639

def disable_auth
  @disable_auth
end

#display_name ⇒ String

Display name of the tenant. Corresponds to the JSON property displayName

Returns:

  • (String) 


1645
1646
1647
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1645

def display_name
  @display_name
end

#email_privacy_config ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2EmailPrivacyConfig

Configuration for settings related to email privacy and public visibility. Settings in this config protect against email enumeration, but may make some trade-offs in user-friendliness. Corresponds to the JSON property emailPrivacyConfig

Returns:



1652
1653
1654
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1652

def email_privacy_config
  @email_privacy_config
end

#enable_anonymous_user ⇒ Boolean Also known as: enable_anonymous_user?

Whether to enable anonymous user authentication. Corresponds to the JSON property enableAnonymousUser

Returns:

  • (Boolean) 


1657
1658
1659
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1657

def enable_anonymous_user
  @enable_anonymous_user
end

#enable_email_link_signin ⇒ Boolean Also known as: enable_email_link_signin?

Whether to enable email link user authentication. Corresponds to the JSON property enableEmailLinkSignin

Returns:

  • (Boolean) 


1663
1664
1665
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1663

def 
  @enable_email_link_signin
end

#hash_config ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2HashConfig

History information of the hash algorithm and key. Different accounts' passwords may be generated by different version. Corresponds to the JSON property hashConfig

Returns:



1670
1671
1672
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1670

def hash_config
  @hash_config
end

#inheritance ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2Inheritance

Settings that the tenants will inherit from project level. Corresponds to the JSON property inheritance

Returns:



1675
1676
1677
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1675

def inheritance
  @inheritance
end

#mfa_config ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2MultiFactorAuthConfig

Options related to MultiFactor Authentication for the project. Corresponds to the JSON property mfaConfig

Returns:



1680
1681
1682
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1680

def mfa_config
  @mfa_config
end

#monitoring ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2MonitoringConfig

Configuration related to monitoring project activity. Corresponds to the JSON property monitoring

Returns:



1685
1686
1687
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1685

def monitoring
  @monitoring
end

#name ⇒ String

Output only. Resource name of a tenant. For example: "projects/project-id/ tenants/tenant-id" Corresponds to the JSON property name

Returns:

  • (String) 


1691
1692
1693
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1691

def name
  @name
end

#sms_region_config ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2SmsRegionConfig

Configures the regions where users are allowed to send verification SMS for the project or tenant. This is based on the calling code of the destination phone number. Corresponds to the JSON property smsRegionConfig

Returns:



1698
1699
1700
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1698

def sms_region_config
  @sms_region_config
end

#test_phone_numbers ⇒ Hash<String,String>

A map of pairs that can be used for MFA. The phone number should be in E.164 format (https://www.itu.int/rec/T-REC-E.164/) and a maximum of 10 pairs can be added (error will be thrown once exceeded). Corresponds to the JSON property testPhoneNumbers

Returns:

  • (Hash<String,String>) 


1705
1706
1707
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1705

def test_phone_numbers
  @test_phone_numbers
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1712

def update!(**args)
  @allow_password_signup = args[:allow_password_signup] if args.key?(:allow_password_signup)
  @autodelete_anonymous_users = args[:autodelete_anonymous_users] if args.key?(:autodelete_anonymous_users)
  @client = args[:client] if args.key?(:client)
  @disable_auth = args[:disable_auth] if args.key?(:disable_auth)
  @display_name = args[:display_name] if args.key?(:display_name)
  @email_privacy_config = args[:email_privacy_config] if args.key?(:email_privacy_config)
  @enable_anonymous_user = args[:enable_anonymous_user] if args.key?(:enable_anonymous_user)
  @enable_email_link_signin = args[:enable_email_link_signin] if args.key?(:enable_email_link_signin)
  @hash_config = args[:hash_config] if args.key?(:hash_config)
  @inheritance = args[:inheritance] if args.key?(:inheritance)
  @mfa_config = args[:mfa_config] if args.key?(:mfa_config)
  @monitoring = args[:monitoring] if args.key?(:monitoring)
  @name = args[:name] if args.key?(:name)
  @sms_region_config = args[:sms_region_config] if args.key?(:sms_region_config)
  @test_phone_numbers = args[:test_phone_numbers] if args.key?(:test_phone_numbers)
end