Class: Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithEmailLinkResponse

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 SignInWithEmailLink.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1SignInWithEmailLinkResponse

Returns a new instance of GoogleCloudIdentitytoolkitV1SignInWithEmailLinkResponse.



2342
2343
2344
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2342

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

Instance Attribute Details

#emailString

The email the user signed in with. Always present in the response. Corresponds to the JSON property email

Returns:

  • (String)


2297
2298
2299
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2297

def email
  @email
end

#expires_inFixnum

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

Returns:

  • (Fixnum)


2302
2303
2304
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2302

def expires_in
  @expires_in
end

#id_tokenString

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

Returns:

  • (String)


2307
2308
2309
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2307

def id_token
  @id_token
end

#is_new_userBoolean Also known as: is_new_user?

Whether the authenticated user was created by this request. Corresponds to the JSON property isNewUser

Returns:

  • (Boolean)


2312
2313
2314
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2312

def is_new_user
  @is_new_user
end

#kindString

Corresponds to the JSON property kind

Returns:

  • (String)


2318
2319
2320
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2318

def kind
  @kind
end

#local_idString

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

Returns:

  • (String)


2323
2324
2325
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2323

def local_id
  @local_id
end

#mfa_infoArray<Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1MfaEnrollment>

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



2329
2330
2331
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2329

def mfa_info
  @mfa_info
end

#mfa_pending_credentialString

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

Returns:

  • (String)


2335
2336
2337
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2335

def mfa_pending_credential
  @mfa_pending_credential
end

#refresh_tokenString

Refresh token for the authenticated user. Corresponds to the JSON property refreshToken

Returns:

  • (String)


2340
2341
2342
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2340

def refresh_token
  @refresh_token
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2347

def update!(**args)
  @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)
  @is_new_user = args[:is_new_user] if args.key?(:is_new_user)
  @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)
  @refresh_token = args[:refresh_token] if args.key?(:refresh_token)
end