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.



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

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

Instance Attribute Details

#captcha_challenge ⇒ String

Corresponds to the JSON property captchaChallenge

Returns:

  • (String) 


2926
2927
2928
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2926

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) 


2933
2934
2935
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2933

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) 


2939
2940
2941
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2939

def client_type
  @client_type
end

#delegated_project_number ⇒ Fixnum

Corresponds to the JSON property delegatedProjectNumber

Returns:

  • (Fixnum) 


2944
2945
2946
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2944

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 name@domain.tld. The email should also match the RFC 822 addr-spec production. Corresponds to the JSON property email

Returns:

  • (String) 


2952
2953
2954
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2952

def email
  @email
end

#id_token ⇒ String

Corresponds to the JSON property idToken

Returns:

  • (String) 


2957
2958
2959
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2957

def id_token
  @id_token
end

#instance_id ⇒ String

Corresponds to the JSON property instanceId

Returns:

  • (String) 


2962
2963
2964
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2962

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) 


2967
2968
2969
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2967

def password
  @password
end

#pending_id_token ⇒ String

Corresponds to the JSON property pendingIdToken

Returns:

  • (String) 


2972
2973
2974
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2972

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) 


2977
2978
2979
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2977

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) 


2982
2983
2984
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2982

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) 


2989
2990
2991
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2989

def tenant_id
  @tenant_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

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