Class: Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberRequest

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

Request message for SignInWithPhoneNumber.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberRequest

Returns a new instance of GoogleCloudIdentitytoolkitV1SignInWithPhoneNumberRequest.



3175
3176
3177
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3175

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

Instance Attribute Details

#code ⇒ String

User-entered verification code from an SMS sent to the user's phone. Corresponds to the JSON property code

Returns:

  • (String) 


3126
3127
3128
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3126

def code
  @code
end

#id_token ⇒ String

A valid ID token for an Identity Platform account. If passed, this request will link the phone number to the user represented by this ID token if the phone number is not in use, or will reauthenticate the user if the phone number is already linked to the user. Corresponds to the JSON property idToken

Returns:

  • (String) 


3134
3135
3136
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3134

def id_token
  @id_token
end

#operation ⇒ String

Corresponds to the JSON property operation

Returns:

  • (String) 


3139
3140
3141
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3139

def operation
  @operation
end

#phone_number ⇒ String

The user's phone number to sign in with. This is necessary in the case of uing a temporary proof, in which case it must match the phone number that was authenticated in the request that generated the temporary proof. This field is ignored if a session info is passed. Corresponds to the JSON property phoneNumber

Returns:

  • (String) 


3147
3148
3149
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3147

def phone_number
  @phone_number
end

#session_info ⇒ String

Encrypted session information from the response of sendVerificationCode. In the case of authenticating with an SMS code this must be specified, but in the case of using a temporary proof it can be unspecified. Corresponds to the JSON property sessionInfo

Returns:

  • (String) 


3154
3155
3156
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3154

def session_info
  @session_info
end

#temporary_proof ⇒ String

A proof of the phone number verification, provided from a previous signInWithPhoneNumber request. If this is passed, the caller must also pass in the phone_number field the phone number that was verified in the previous request. Corresponds to the JSON property temporaryProof

Returns:

  • (String) 


3162
3163
3164
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3162

def temporary_proof
  @temporary_proof
end

#tenant_id ⇒ String

The ID of the Identity Platform tenant the user is signing in to. If not set, the user will sign in to the default Identity Platform project. Corresponds to the JSON property tenantId

Returns:

  • (String) 


3168
3169
3170
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3168

def tenant_id
  @tenant_id
end

#verification_proof ⇒ String

Do not use. Corresponds to the JSON property verificationProof

Returns:

  • (String) 


3173
3174
3175
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3173

def verification_proof
  @verification_proof
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3180

def update!(**args)
  @code = args[:code] if args.key?(:code)
  @id_token = args[:id_token] if args.key?(:id_token)
  @operation = args[:operation] if args.key?(:operation)
  @phone_number = args[:phone_number] if args.key?(:phone_number)
  @session_info = args[:session_info] if args.key?(:session_info)
  @temporary_proof = args[:temporary_proof] if args.key?(:temporary_proof)
  @tenant_id = args[:tenant_id] if args.key?(:tenant_id)
  @verification_proof = args[:verification_proof] if args.key?(:verification_proof)
end