Class: Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithPasswordRequest

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1SignInWithPasswordRequest

Returns a new instance of GoogleCloudIdentitytoolkitV1SignInWithPasswordRequest.



2993
2994
2995
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2993

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

Instance Attribute Details

#captcha_challenge ⇒ String

Corresponds to the JSON property captchaChallenge

Returns:

  • (String) 


2928
2929
2930
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2928

def captcha_challenge
  @captcha_challenge
end

#captcha_response ⇒ String

The reCAPTCHA token provided by the reCAPTCHA client-side integration. reCAPTCHA Enterprise uses it for risk assessment. Required when reCAPTCHA Enterprise is enabled. Corresponds to the JSON property captchaResponse

Returns:

  • (String) 


2935
2936
2937
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2935

def captcha_response
  @captcha_response
end

#client_type ⇒ String

The client type, web, android or ios. Required when reCAPTCHA Enterprise is enabled. Corresponds to the JSON property clientType

Returns:

  • (String) 


2941
2942
2943
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2941

def client_type
  @client_type
end

#delegated_project_number ⇒ Fixnum

Corresponds to the JSON property delegatedProjectNumber

Returns:

  • (Fixnum) 


2946
2947
2948
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2946

def delegated_project_number
  @delegated_project_number
end

#email ⇒ String

Required. The email the user is signing in with. The length of email should be less than 256 characters and in the format of [email protected]. The email should also match the RFC 822 addr-spec production. Corresponds to the JSON property email

Returns:

  • (String) 


2954
2955
2956
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2954

def email
  @email
end

#id_token ⇒ String

Corresponds to the JSON property idToken

Returns:

  • (String) 


2959
2960
2961
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2959

def id_token
  @id_token
end

#instance_id ⇒ String

Corresponds to the JSON property instanceId

Returns:

  • (String) 


2964
2965
2966
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2964

def instance_id
  @instance_id
end

#password ⇒ String

Required. The password the user provides to sign in to the account. Corresponds to the JSON property password

Returns:

  • (String) 


2969
2970
2971
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2969

def password
  @password
end

#pending_id_token ⇒ String

Corresponds to the JSON property pendingIdToken

Returns:

  • (String) 


2974
2975
2976
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2974

def pending_id_token
  @pending_id_token
end

#recaptcha_version ⇒ String

The reCAPTCHA version of the reCAPTCHA token in the captcha_response. Corresponds to the JSON property recaptchaVersion

Returns:

  • (String) 


2979
2980
2981
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2979

def recaptcha_version
  @recaptcha_version
end

#return_secure_token ⇒ Boolean Also known as: return_secure_token?

Should always be true. Corresponds to the JSON property returnSecureToken

Returns:

  • (Boolean) 


2984
2985
2986
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2984

def return_secure_token
  @return_secure_token
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 instance in the project. Corresponds to the JSON property tenantId

Returns:

  • (String) 


2991
2992
2993
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2991

def tenant_id
  @tenant_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2998

def update!(**args)
  @captcha_challenge = args[:captcha_challenge] if args.key?(:captcha_challenge)
  @captcha_response = args[:captcha_response] if args.key?(:captcha_response)
  @client_type = args[:client_type] if args.key?(:client_type)
  @delegated_project_number = args[:delegated_project_number] if args.key?(:delegated_project_number)
  @email = args[:email] if args.key?(:email)
  @id_token = args[:id_token] if args.key?(:id_token)
  @instance_id = args[:instance_id] if args.key?(:instance_id)
  @password = args[:password] if args.key?(:password)
  @pending_id_token = args[:pending_id_token] if args.key?(:pending_id_token)
  @recaptcha_version = args[:recaptcha_version] if args.key?(:recaptcha_version)
  @return_secure_token = args[:return_secure_token] if args.key?(:return_secure_token)
  @tenant_id = args[:tenant_id] if args.key?(:tenant_id)
end