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



2123
2124
2125
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2123

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

Instance Attribute Details

#created_at ⇒ Fixnum

User creation timestamp. Corresponds to the JSON property createdAt

Returns:

  • (Fixnum) 


2026
2027
2028
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2026

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) 


2031
2032
2033
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2031

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) 


2036
2037
2038
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2036

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) 


2042
2043
2044
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2042

def disabled
  @disabled
end

#display_name ⇒ String

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

Returns:

  • (String) 


2048
2049
2050
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2048

def display_name
  @display_name
end

#email ⇒ String

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

Returns:

  • (String) 


2053
2054
2055
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2053

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) 


2058
2059
2060
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2058

def email_verified
  @email_verified
end

#last_login_at ⇒ Fixnum

last login timestamp. Corresponds to the JSON property lastLoginAt

Returns:

  • (Fixnum) 


2064
2065
2066
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2064

def 
  @last_login_at
end

#local_id ⇒ String

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

Returns:

  • (String) 


2069
2070
2071
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2069

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) 


2075
2076
2077
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2075

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) 


2080
2081
2082
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2080

def password_updated_at
  @password_updated_at
end

#phone_number ⇒ String

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

Returns:

  • (String) 


2085
2086
2087
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2085

def phone_number
  @phone_number
end

#photo_url ⇒ String

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

Returns:

  • (String) 


2090
2091
2092
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2090

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:



2095
2096
2097
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2095

def 
  @provider_user_info
end

#raw_password ⇒ String

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

Returns:

  • (String) 


2100
2101
2102
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2100

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) 


2106
2107
2108
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2106

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) 


2111
2112
2113
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2111

def screen_name
  @screen_name
end

#valid_since ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2116
2117
2118
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2116

def valid_since
  @valid_since
end

#version ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2121
2122
2123
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2121

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2128

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