Class: Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithPasswordResponse

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

Response message for SignInWithPassword.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1SignInWithPasswordResponse

Returns a new instance of GoogleCloudIdentitytoolkitV1SignInWithPasswordResponse.



3091
3092
3093
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3091

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

Instance Attribute Details

#display_name ⇒ String

The user's display name stored in the account's attributes. Corresponds to the JSON property displayName

Returns:

  • (String) 


3015
3016
3017
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3015

def display_name
  @display_name
end

#email ⇒ String

The email of the authenticated user. Always present in the response. Corresponds to the JSON property email

Returns:

  • (String) 


3020
3021
3022
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3020

def email
  @email
end

#expires_in ⇒ Fixnum

The number of seconds until the Identity Platform ID token expires. Corresponds to the JSON property expiresIn

Returns:

  • (Fixnum) 


3025
3026
3027
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3025

def expires_in
  @expires_in
end

#id_token ⇒ String

An Identity Platform ID token for the authenticated user. Corresponds to the JSON property idToken

Returns:

  • (String) 


3030
3031
3032
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3030

def id_token
  @id_token
end

#kind ⇒ String

Corresponds to the JSON property kind

Returns:

  • (String) 


3035
3036
3037
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3035

def kind
  @kind
end

#local_id ⇒ String

The ID of the authenticated user. Always present in the response. Corresponds to the JSON property localId

Returns:

  • (String) 


3040
3041
3042
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3040

def local_id
  @local_id
end

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

Info on which multi-factor authentication providers are enabled for the account. Present if the user needs to complete the sign-in using multi-factor authentication. Corresponds to the JSON property mfaInfo

Returns:



3047
3048
3049
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3047

def mfa_info
  @mfa_info
end

#mfa_pending_credential ⇒ String

An opaque string that functions as proof that the user has successfully passed the first factor authentication. Corresponds to the JSON property mfaPendingCredential

Returns:

  • (String) 


3053
3054
3055
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3053

def mfa_pending_credential
  @mfa_pending_credential
end

#oauth_access_token ⇒ String

The OAuth2 access token. Corresponds to the JSON property oauthAccessToken

Returns:

  • (String) 


3058
3059
3060
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3058

def oauth_access_token
  @oauth_access_token
end

#oauth_authorization_code ⇒ String

Corresponds to the JSON property oauthAuthorizationCode

Returns:

  • (String) 


3063
3064
3065
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3063

def oauth_authorization_code
  @oauth_authorization_code
end

#oauth_expire_in ⇒ Fixnum

The access token expiration time in seconds. Corresponds to the JSON property oauthExpireIn

Returns:

  • (Fixnum) 


3068
3069
3070
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3068

def oauth_expire_in
  @oauth_expire_in
end

#profile_picture ⇒ String

The user's profile picture stored in the account's attributes. Corresponds to the JSON property profilePicture

Returns:

  • (String) 


3073
3074
3075
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3073

def profile_picture
  @profile_picture
end

#refresh_token ⇒ String

An Identity Platform refresh token for the authenticated user. Corresponds to the JSON property refreshToken

Returns:

  • (String) 


3078
3079
3080
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3078

def refresh_token
  @refresh_token
end

#registered ⇒ Boolean Also known as: registered?

Whether the email is for an existing account. Always true. Corresponds to the JSON property registered

Returns:

  • (Boolean) 


3083
3084
3085
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3083

def registered
  @registered
end

#user_notifications ⇒ Array<Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1UserNotification>

Warning notifications for the user. Corresponds to the JSON property userNotifications

Returns:



3089
3090
3091
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3089

def user_notifications
  @user_notifications
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3096

def update!(**args)
  @display_name = args[:display_name] if args.key?(:display_name)
  @email = args[:email] if args.key?(:email)
  @expires_in = args[:expires_in] if args.key?(:expires_in)
  @id_token = args[:id_token] if args.key?(:id_token)
  @kind = args[:kind] if args.key?(:kind)
  @local_id = args[:local_id] if args.key?(:local_id)
  @mfa_info = args[:mfa_info] if args.key?(:mfa_info)
  @mfa_pending_credential = args[:mfa_pending_credential] if args.key?(:mfa_pending_credential)
  @oauth_access_token = args[:oauth_access_token] if args.key?(:oauth_access_token)
  @oauth_authorization_code = args[:oauth_authorization_code] if args.key?(:oauth_authorization_code)
  @oauth_expire_in = args[:oauth_expire_in] if args.key?(:oauth_expire_in)
  @profile_picture = args[:profile_picture] if args.key?(:profile_picture)
  @refresh_token = args[:refresh_token] if args.key?(:refresh_token)
  @registered = args[:registered] if args.key?(:registered)
  @user_notifications = args[:user_notifications] if args.key?(:user_notifications)
end