Class: Google::Apis::IdentitytoolkitV3::UserInfo

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/identitytoolkit_v3/classes.rb,
generated/google/apis/identitytoolkit_v3/representations.rb,
generated/google/apis/identitytoolkit_v3/representations.rb

Overview

Template for an individual account info.

Defined Under Namespace

Classes: ProviderUserInfo

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ UserInfo

Returns a new instance of UserInfo



2006
2007
2008
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2006

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

Instance Attribute Details

#created_at ⇒ Fixnum

User creation timestamp. Corresponds to the JSON property createdAt

Returns:

  • (Fixnum) 


1909
1910
1911
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1909

def created_at
  @created_at
end

#custom_attributes ⇒ String

The custom attributes to be set in the user's id token. Corresponds to the JSON property customAttributes

Returns:

  • (String) 


1914
1915
1916
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1914

def custom_attributes
  @custom_attributes
end

#custom_auth ⇒ Boolean Also known as: custom_auth?

Whether the user is authenticated by the developer. Corresponds to the JSON property customAuth

Returns:

  • (Boolean) 


1919
1920
1921
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1919

def custom_auth
  @custom_auth
end

#disabled ⇒ Boolean Also known as: disabled?

Whether the user is disabled. Corresponds to the JSON property disabled

Returns:

  • (Boolean) 


1925
1926
1927
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1925

def disabled
  @disabled
end

#display_name ⇒ String

The name of the user. Corresponds to the JSON property displayName

Returns:

  • (String) 


1931
1932
1933
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1931

def display_name
  @display_name
end

#email ⇒ String

The email of the user. Corresponds to the JSON property email

Returns:

  • (String) 


1936
1937
1938
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1936

def email
  @email
end

#email_verified ⇒ Boolean Also known as: email_verified?

Whether the email has been verified. Corresponds to the JSON property emailVerified

Returns:

  • (Boolean) 


1941
1942
1943
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1941

def email_verified
  @email_verified
end

#last_login_at ⇒ Fixnum

last login timestamp. Corresponds to the JSON property lastLoginAt

Returns:

  • (Fixnum) 


1947
1948
1949
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1947

def 
  @last_login_at
end

#local_id ⇒ String

The local ID of the user. Corresponds to the JSON property localId

Returns:

  • (String) 


1952
1953
1954
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1952

def local_id
  @local_id
end

#password_hash ⇒ String

The user's hashed password. Corresponds to the JSON property passwordHash NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


1958
1959
1960
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1958

def password_hash
  @password_hash
end

#password_updated_at ⇒ Float

The timestamp when the password was last updated. Corresponds to the JSON property passwordUpdatedAt

Returns:

  • (Float) 


1963
1964
1965
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1963

def password_updated_at
  @password_updated_at
end

#phone_number ⇒ String

User's phone number. Corresponds to the JSON property phoneNumber

Returns:

  • (String) 


1968
1969
1970
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1968

def phone_number
  @phone_number
end

#photo_url ⇒ String

The URL of the user profile photo. Corresponds to the JSON property photoUrl

Returns:

  • (String) 


1973
1974
1975
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1973

def photo_url
  @photo_url
end

#provider_user_info ⇒ Array<Google::Apis::IdentitytoolkitV3::UserInfo::ProviderUserInfo>

The IDP of the user. Corresponds to the JSON property providerUserInfo

Returns:



1978
1979
1980
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1978

def 
  @provider_user_info
end

#raw_password ⇒ String

The user's plain text password. Corresponds to the JSON property rawPassword

Returns:

  • (String) 


1983
1984
1985
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1983

def raw_password
  @raw_password
end

#salt ⇒ String

The user's password salt. Corresponds to the JSON property salt NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


1989
1990
1991
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1989

def salt
  @salt
end

#screen_name ⇒ String

User's screen name at Twitter or login name at Github. Corresponds to the JSON property screenName

Returns:

  • (String) 


1994
1995
1996
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1994

def screen_name
  @screen_name
end

#valid_since ⇒ Fixnum

Timestamp in seconds for valid login token. Corresponds to the JSON property validSince

Returns:

  • (Fixnum) 


1999
2000
2001
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1999

def valid_since
  @valid_since
end

#version ⇒ Fixnum

Version of the user's password. Corresponds to the JSON property version

Returns:

  • (Fixnum) 


2004
2005
2006
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2004

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2011

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)
  @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_verified = args[:email_verified] if args.key?(:email_verified)
  @last_login_at = args[:last_login_at] if args.key?(:last_login_at)
  @local_id = args[:local_id] if args.key?(:local_id)
  @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)
  @valid_since = args[:valid_since] if args.key?(:valid_since)
  @version = args[:version] if args.key?(:version)
end