Class: Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberResponse

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberResponse

Returns a new instance of GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberResponse.



3248
3249
3250
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3248

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

Instance Attribute Details

#expires_in ⇒ Fixnum

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

Returns:

  • (Fixnum) 


3195
3196
3197
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3195

def expires_in
  @expires_in
end

#id_token ⇒ String

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

Returns:

  • (String) 


3200
3201
3202
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3200

def id_token
  @id_token
end

#is_new_user ⇒ Boolean Also known as: is_new_user?

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

Returns:

  • (Boolean) 


3205
3206
3207
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3205

def is_new_user
  @is_new_user
end

#local_id ⇒ String

The id of the authenticated user. Present in the case of a successful authentication. In the case when the phone could be verified but the account operation could not be performed, a temporary proof will be returned instead. Corresponds to the JSON property localId

Returns:

  • (String) 


3213
3214
3215
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3213

def local_id
  @local_id
end

#phone_number ⇒ String

Phone number of the authenticated user. Always present in the response. Corresponds to the JSON property phoneNumber

Returns:

  • (String) 


3218
3219
3220
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3218

def phone_number
  @phone_number
end

#refresh_token ⇒ String

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

Returns:

  • (String) 


3223
3224
3225
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3223

def refresh_token
  @refresh_token
end

#temporary_proof ⇒ String

A proof of the phone number verification, provided if a phone authentication is successful but the user operation fails. This happens when the request tries to link a phone number to a user with an ID token or reauthenticate with an ID token but the phone number is linked to a different user. Corresponds to the JSON property temporaryProof

Returns:

  • (String) 


3231
3232
3233
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3231

def temporary_proof
  @temporary_proof
end

#temporary_proof_expires_in ⇒ Fixnum

The number of seconds until the temporary proof expires. Corresponds to the JSON property temporaryProofExpiresIn

Returns:

  • (Fixnum) 


3236
3237
3238
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3236

def temporary_proof_expires_in
  @temporary_proof_expires_in
end

#verification_proof ⇒ String

Do not use. Corresponds to the JSON property verificationProof

Returns:

  • (String) 


3241
3242
3243
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3241

def verification_proof
  @verification_proof
end

#verification_proof_expires_in ⇒ Fixnum

Do not use. Corresponds to the JSON property verificationProofExpiresIn

Returns:

  • (Fixnum) 


3246
3247
3248
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3246

def verification_proof_expires_in
  @verification_proof_expires_in
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3253

def update!(**args)
  @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)
  @local_id = args[:local_id] if args.key?(:local_id)
  @phone_number = args[:phone_number] if args.key?(:phone_number)
  @refresh_token = args[:refresh_token] if args.key?(:refresh_token)
  @temporary_proof = args[:temporary_proof] if args.key?(:temporary_proof)
  @temporary_proof_expires_in = args[:temporary_proof_expires_in] if args.key?(:temporary_proof_expires_in)
  @verification_proof = args[:verification_proof] if args.key?(:verification_proof)
  @verification_proof_expires_in = args[:verification_proof_expires_in] if args.key?(:verification_proof_expires_in)
end