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.



1741
1742
1743
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1741

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) 


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

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) 


1659
1660
1661
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1659

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:



1666
1667
1668
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1666

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) 


1673
1674
1675
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1673

def disable_auth
  @disable_auth
end

#display_name ⇒ String

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

Returns:

  • (String) 


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

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:



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

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) 


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

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) 


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

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:



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

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:



1709
1710
1711
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1709

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:



1714
1715
1716
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1714

def mfa_config
  @mfa_config
end

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

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

Returns:



1719
1720
1721
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1719

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) 


1725
1726
1727
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1725

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:



1732
1733
1734
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1732

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>) 


1739
1740
1741
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1739

def test_phone_numbers
  @test_phone_numbers
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1746

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