Class: Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1UserInfo

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

An Identity Platform account's information.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1UserInfo

Returns a new instance of GoogleCloudIdentitytoolkitV1UserInfo.



3817
3818
3819
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3817

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

Instance Attribute Details

#created_at ⇒ Fixnum

The time, in milliseconds from epoch, when the account was created. Corresponds to the JSON property createdAt

Returns:

  • (Fixnum) 


3654
3655
3656
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3654

def created_at
  @created_at
end

#custom_attributes ⇒ String

Custom claims to be added to any ID tokens minted for the account. Should be at most 1,000 characters in length and in valid JSON format. Corresponds to the JSON property customAttributes

Returns:

  • (String) 


3660
3661
3662
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3660

def custom_attributes
  @custom_attributes
end

#custom_auth ⇒ Boolean Also known as: custom_auth?

Output only. Whether this account has been authenticated using SignInWithCustomToken. Corresponds to the JSON property customAuth

Returns:

  • (Boolean) 


3666
3667
3668
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3666

def custom_auth
  @custom_auth
end

#date_of_birth ⇒ String

Output only. The date of birth set for the account. This account attribute is not used by Identity Platform. It is available for informational purposes only. Corresponds to the JSON property dateOfBirth

Returns:

  • (String) 


3673
3674
3675
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3673

def date_of_birth
  @date_of_birth
end

#disabled ⇒ Boolean Also known as: disabled?

Whether the account is disabled. Disabled accounts are inaccessible except for requests bearing a Google OAuth2 credential with proper permissions. Corresponds to the JSON property disabled

Returns:

  • (Boolean) 


3679
3680
3681
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3679

def disabled
  @disabled
end

#display_name ⇒ String

The display name of the account. This account attribute is not used by Identity Platform. It is available for informational purposes only. Corresponds to the JSON property displayName

Returns:

  • (String) 


3686
3687
3688
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3686

def display_name
  @display_name
end

#email ⇒ String

The account's email address. The length of the 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. Corresponds to the JSON property email

Returns:

  • (String) 


3693
3694
3695
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3693

def email
  @email
end

#email_link_signin ⇒ Boolean Also known as: email_link_signin?

Output only. Whether the account can authenticate with email link. Corresponds to the JSON property emailLinkSignin

Returns:

  • (Boolean) 


3698
3699
3700
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3698

def 
  @email_link_signin
end

#email_verified ⇒ Boolean Also known as: email_verified?

Whether the account's email address has been verified. Corresponds to the JSON property emailVerified

Returns:

  • (Boolean) 


3704
3705
3706
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3704

def email_verified
  @email_verified
end

#initial_email ⇒ String

The first email address associated with this account. The account's initial email cannot be changed once set and is used to recover access to this account if lost via the RECOVER_EMAIL flow in GetOobCode. Should match the RFC 822 addr-spec. Corresponds to the JSON property initialEmail

Returns:

  • (String) 


3713
3714
3715
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3713

def initial_email
  @initial_email
end

#language ⇒ String

Output only. The language preference of the account. This account attribute is not used by Identity Platform. It is available for informational purposes only. Corresponds to the JSON property language

Returns:

  • (String) 


3719
3720
3721
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3719

def language
  @language
end

#last_login_at ⇒ Fixnum

The last time, in milliseconds from epoch, this account was logged into. Corresponds to the JSON property lastLoginAt

Returns:

  • (Fixnum) 


3724
3725
3726
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3724

def 
  @last_login_at
end

#last_refresh_at ⇒ String

Timestamp when an ID token was last minted for this account. Corresponds to the JSON property lastRefreshAt

Returns:

  • (String) 


3729
3730
3731
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3729

def last_refresh_at
  @last_refresh_at
end

#local_id ⇒ String

Immutable. The unique ID of the account. Corresponds to the JSON property localId

Returns:

  • (String) 


3734
3735
3736
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3734

def local_id
  @local_id
end

#mfa_info ⇒ Array<Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1MfaEnrollment>

Information on which multi-factor authentication providers are enabled for this account. Corresponds to the JSON property mfaInfo

Returns:



3740
3741
3742
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3740

def mfa_info
  @mfa_info
end

#password_hash ⇒ String

The account's hashed password. Only accessible by requests bearing a Google OAuth2 credential with proper permissions. Corresponds to the JSON property passwordHash NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


3748
3749
3750
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3748

def password_hash
  @password_hash
end

#password_updated_at ⇒ Float

The timestamp, in milliseconds from the epoch of 1970-01-01T00:00:00Z, when the account's password was last updated. Corresponds to the JSON property passwordUpdatedAt

Returns:

  • (Float) 


3754
3755
3756
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3754

def password_updated_at
  @password_updated_at
end

#phone_number ⇒ String

The account's phone number. Corresponds to the JSON property phoneNumber

Returns:

  • (String) 


3759
3760
3761
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3759

def phone_number
  @phone_number
end

#photo_url ⇒ String

The URL of the account's profile photo. This account attribute is not used by Identity Platform. It is available for informational purposes only. Corresponds to the JSON property photoUrl

Returns:

  • (String) 


3765
3766
3767
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3765

def photo_url
  @photo_url
end

#provider_user_info ⇒ Array<Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1ProviderUserInfo>

Information about the user as provided by various Identity Providers. Corresponds to the JSON property providerUserInfo

Returns:



3770
3771
3772
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3770

def 
  @provider_user_info
end

#raw_password ⇒ String

Input only. Plain text password used to update a account's password. This field is only ever used as input in a request. Identity Platform uses cryptographically secure hashing when managing passwords and will never store or transmit a user's password in plain text. Corresponds to the JSON property rawPassword

Returns:

  • (String) 


3778
3779
3780
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3778

def raw_password
  @raw_password
end

#salt ⇒ String

The account's password salt. Only accessible by requests bearing a Google OAuth2 credential with proper permissions. Corresponds to the JSON property salt NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


3785
3786
3787
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3785

def salt
  @salt
end

#screen_name ⇒ String

Output only. This account's screen name at Twitter or login name at GitHub. Corresponds to the JSON property screenName

Returns:

  • (String) 


3790
3791
3792
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3790

def screen_name
  @screen_name
end

#tenant_id ⇒ String

ID of the tenant this account belongs to. Only set if this account belongs to a tenant. Corresponds to the JSON property tenantId

Returns:

  • (String) 


3796
3797
3798
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3796

def tenant_id
  @tenant_id
end

#time_zone ⇒ String

Output only. The time zone preference of the account. This account attribute is not used by Identity Platform. It is available for informational purposes only. Corresponds to the JSON property timeZone

Returns:

  • (String) 


3803
3804
3805
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3803

def time_zone
  @time_zone
end

#valid_since ⇒ Fixnum

Oldest timestamp, in seconds since epoch, that an ID token should be considered valid. All ID tokens issued before this time are considered invalid. Corresponds to the JSON property validSince

Returns:

  • (Fixnum) 


3809
3810
3811
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3809

def valid_since
  @valid_since
end

#version ⇒ Fixnum

The version of the account's password. Only accessible by requests bearing a Google OAuth2 credential with proper permissions. Corresponds to the JSON property version

Returns:

  • (Fixnum) 


3815
3816
3817
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3815

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3822

def update!(**args)
  @created_at = args[:created_at] if args.key?(:created_at)
  @custom_attributes = args[:custom_attributes] if args.key?(:custom_attributes)
  @custom_auth = args[:custom_auth] if args.key?(:custom_auth)
  @date_of_birth = args[:date_of_birth] if args.key?(:date_of_birth)
  @disabled = args[:disabled] if args.key?(:disabled)
  @display_name = args[:display_name] if args.key?(:display_name)
  @email = args[:email] if args.key?(:email)
  @email_link_signin = args[:email_link_signin] if args.key?(:email_link_signin)
  @email_verified = args[:email_verified] if args.key?(:email_verified)
  @initial_email = args[:initial_email] if args.key?(:initial_email)
  @language = args[:language] if args.key?(:language)
  @last_login_at = args[:last_login_at] if args.key?(:last_login_at)
  @last_refresh_at = args[:last_refresh_at] if args.key?(:last_refresh_at)
  @local_id = args[:local_id] if args.key?(:local_id)
  @mfa_info = args[:mfa_info] if args.key?(:mfa_info)
  @password_hash = args[:password_hash] if args.key?(:password_hash)
  @password_updated_at = args[:password_updated_at] if args.key?(:password_updated_at)
  @phone_number = args[:phone_number] if args.key?(:phone_number)
  @photo_url = args[:photo_url] if args.key?(:photo_url)
  @provider_user_info = args[:provider_user_info] if args.key?(:provider_user_info)
  @raw_password = args[:raw_password] if args.key?(:raw_password)
  @salt = args[:salt] if args.key?(:salt)
  @screen_name = args[:screen_name] if args.key?(:screen_name)
  @tenant_id = args[:tenant_id] if args.key?(:tenant_id)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
  @valid_since = args[:valid_since] if args.key?(:valid_since)
  @version = args[:version] if args.key?(:version)
end