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.



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

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) 


3557
3558
3559
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3557

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) 


3563
3564
3565
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3563

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) 


3569
3570
3571
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3569

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) 


3576
3577
3578
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3576

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) 


3582
3583
3584
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3582

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) 


3589
3590
3591
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3589

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) 


3596
3597
3598
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3596

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) 


3601
3602
3603
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3601

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) 


3607
3608
3609
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3607

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) 


3616
3617
3618
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3616

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) 


3622
3623
3624
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3622

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) 


3627
3628
3629
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3627

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) 


3632
3633
3634
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3632

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) 


3637
3638
3639
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3637

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:



3643
3644
3645
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3643

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) 


3651
3652
3653
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3651

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) 


3657
3658
3659
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3657

def password_updated_at
  @password_updated_at
end

#phone_number ⇒ String

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

Returns:

  • (String) 


3662
3663
3664
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3662

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) 


3668
3669
3670
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3668

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:



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

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) 


3681
3682
3683
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3681

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) 


3688
3689
3690
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3688

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) 


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

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) 


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

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) 


3706
3707
3708
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3706

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) 


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

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) 


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

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3725

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