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.



1854
1855
1856
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1854

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) 


1761
1762
1763
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1761

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) 


1767
1768
1769
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1767

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:



1774
1775
1776
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1774

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) 


1781
1782
1783
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1781

def disable_auth
  @disable_auth
end

#display_name ⇒ String

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

Returns:

  • (String) 


1787
1788
1789
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1787

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:



1794
1795
1796
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1794

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) 


1799
1800
1801
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1799

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) 


1805
1806
1807
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1805

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:



1812
1813
1814
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1812

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:



1817
1818
1819
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1817

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:



1822
1823
1824
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1822

def mfa_config
  @mfa_config
end

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

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

Returns:



1827
1828
1829
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1827

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) 


1833
1834
1835
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1833

def name
  @name
end

#recaptcha_config ⇒ Google::Apis::IdentitytoolkitV2::GoogleCloudIdentitytoolkitAdminV2RecaptchaConfig

The reCAPTCHA Enterprise integration config. Corresponds to the JSON property recaptchaConfig

Returns:



1838
1839
1840
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1838

def recaptcha_config
  @recaptcha_config
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:



1845
1846
1847
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1845

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


1852
1853
1854
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1852

def test_phone_numbers
  @test_phone_numbers
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
 
# File 'lib/google/apis/identitytoolkit_v2/classes.rb', line 1859

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)
  @recaptcha_config = args[:recaptcha_config] if args.key?(:recaptcha_config)
  @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