Class: Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1GetOobCodeRequest

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1GetOobCodeRequest

Returns a new instance of GoogleCloudIdentitytoolkitV1GetOobCodeRequest.



954
955
956
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 954

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

Instance Attribute Details

#android_install_app ⇒ Boolean Also known as: android_install_app?

If an associated android app can handle the OOB code, whether or not to install the android app on the device where the link is opened if the app is not already installed. Corresponds to the JSON property androidInstallApp

Returns:

  • (Boolean) 


819
820
821
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 819

def android_install_app
  @android_install_app
end

#android_minimum_version ⇒ String

If an associated android app can handle the OOB code, the minimum version of the app. If the version on the device is lower than this version then the user is taken to Google Play Store to upgrade the app. Corresponds to the JSON property androidMinimumVersion

Returns:

  • (String) 


827
828
829
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 827

def android_minimum_version
  @android_minimum_version
end

#android_package_name ⇒ String

If an associated android app can handle the OOB code, the Android package name of the android app that will handle the callback when this OOB code is used. This will allow the correct app to open if it is already installed, or allow Google Play Store to open to the correct app if it is not yet installed. Corresponds to the JSON property androidPackageName

Returns:

  • (String) 


835
836
837
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 835

def android_package_name
  @android_package_name
end

#can_handle_code_in_app ⇒ Boolean Also known as: can_handle_code_in_app?

When set to true, the OOB code link will be be sent as a Universal Link or an Android App Link and will be opened by the corresponding app if installed. If not set, or set to false, the OOB code will be sent to the web widget first and then on continue will redirect to the app if installed. Corresponds to the JSON property canHandleCodeInApp

Returns:

  • (Boolean) 


843
844
845
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 843

def can_handle_code_in_app
  @can_handle_code_in_app
end

#captcha_resp ⇒ String

For a PASSWORD_RESET request, a reCaptcha response is required when the system detects possible abuse activity. In those cases, this is the response from the reCaptcha challenge used to verify the caller. Corresponds to the JSON property captchaResp

Returns:

  • (String) 


851
852
853
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 851

def captcha_resp
  @captcha_resp
end

#challenge ⇒ String

Corresponds to the JSON property challenge

Returns:

  • (String) 


856
857
858
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 856

def challenge
  @challenge
end

#client_type ⇒ String

The client type: web, Android or iOS. Required when reCAPTCHA Enterprise protection is enabled. Corresponds to the JSON property clientType

Returns:

  • (String) 


862
863
864
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 862

def client_type
  @client_type
end

#continue_url ⇒ String

The Url to continue after user clicks the link sent in email. This is the url that will allow the web widget to handle the OOB code. Corresponds to the JSON property continueUrl

Returns:

  • (String) 


868
869
870
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 868

def continue_url
  @continue_url
end

#dynamic_link_domain ⇒ String

In order to ensure that the url used can be easily opened up in iOS or android, we create a Firebase Dynamic Link. Most Identity Platform projects will only have one Dynamic Link domain enabled, and can leave this field blank. This field contains a specified Dynamic Link domain for projects that have multiple enabled. Corresponds to the JSON property dynamicLinkDomain

Returns:

  • (String) 


877
878
879
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 877

def dynamic_link_domain
  @dynamic_link_domain
end

#email ⇒ String

The account's email address to send the OOB code to, and generally the email address of the account that needs to be updated. Required for PASSWORD_RESET, EMAIL_SIGNIN, and VERIFY_EMAIL. Only required for VERIFY_AND_CHANGE_EMAIL requests when return_oob_link is set to true. In this case, it is the original email of the user. Corresponds to the JSON property email

Returns:

  • (String) 


886
887
888
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 886

def email
  @email
end

#i_os_app_store_id ⇒ String

If an associated iOS app can handle the OOB code, the App Store id of this app. This will allow App Store to open to the correct app if the app is not yet installed. Corresponds to the JSON property iOSAppStoreId

Returns:

  • (String) 


893
894
895
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 893

def i_os_app_store_id
  @i_os_app_store_id
end

#i_os_bundle_id ⇒ String

If an associated iOS app can handle the OOB code, the iOS bundle id of this app. This will allow the correct app to open if it is already installed. Corresponds to the JSON property iOSBundleId

Returns:

  • (String) 


899
900
901
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 899

def i_os_bundle_id
  @i_os_bundle_id
end

#id_token ⇒ String

An ID token for the account. It is required for VERIFY_AND_CHANGE_EMAIL and VERIFY_EMAIL requests unless return_oob_link is set to true. Corresponds to the JSON property idToken

Returns:

  • (String) 


905
906
907
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 905

def id_token
  @id_token
end

#new_email ⇒ String

The email address the account is being updated to. Required only for VERIFY_AND_CHANGE_EMAIL requests. Corresponds to the JSON property newEmail

Returns:

  • (String) 


911
912
913
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 911

def new_email
  @new_email
end

#recaptcha_version ⇒ String

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

Returns:

  • (String) 


916
917
918
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 916

def recaptcha_version
  @recaptcha_version
end

#request_type ⇒ String

Required. The type of out-of-band (OOB) code to send. Depending on this value, other fields in this request will be required and/or have different meanings. There are 4 different OOB codes that can be sent: * PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL Corresponds to the JSON property requestType

Returns:

  • (String) 


924
925
926
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 924

def request_type
  @request_type
end

#return_oob_link ⇒ Boolean Also known as: return_oob_link?

Whether the confirmation link containing the OOB code should be returned in the response (no email is sent). Used when a developer wants to construct the email template and send it on their own. By default this is false; to specify this field, and to set it to true, it requires a Google OAuth 2.0 credential with proper permissions Corresponds to the JSON property returnOobLink

Returns:

  • (Boolean) 


934
935
936
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 934

def return_oob_link
  @return_oob_link
end

#target_project_id ⇒ String

The Project ID of the Identity Platform project which the account belongs to. To specify this field, it requires a Google OAuth 2.0 credential with proper permissions. Corresponds to the JSON property targetProjectId

Returns:

  • (String) 


942
943
944
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 942

def target_project_id
  @target_project_id
end

#tenant_id ⇒ String

The tenant ID of the Identity Platform tenant the account belongs to. Corresponds to the JSON property tenantId

Returns:

  • (String) 


947
948
949
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 947

def tenant_id
  @tenant_id
end

#user_ip ⇒ String

The IP address of the caller. Required only for PASSWORD_RESET requests. Corresponds to the JSON property userIp

Returns:

  • (String) 


952
953
954
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 952

def user_ip
  @user_ip
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 959

def update!(**args)
  @android_install_app = args[:android_install_app] if args.key?(:android_install_app)
  @android_minimum_version = args[:android_minimum_version] if args.key?(:android_minimum_version)
  @android_package_name = args[:android_package_name] if args.key?(:android_package_name)
  @can_handle_code_in_app = args[:can_handle_code_in_app] if args.key?(:can_handle_code_in_app)
  @captcha_resp = args[:captcha_resp] if args.key?(:captcha_resp)
  @challenge = args[:challenge] if args.key?(:challenge)
  @client_type = args[:client_type] if args.key?(:client_type)
  @continue_url = args[:continue_url] if args.key?(:continue_url)
  @dynamic_link_domain = args[:dynamic_link_domain] if args.key?(:dynamic_link_domain)
  @email = args[:email] if args.key?(:email)
  @i_os_app_store_id = args[:i_os_app_store_id] if args.key?(:i_os_app_store_id)
  @i_os_bundle_id = args[:i_os_bundle_id] if args.key?(:i_os_bundle_id)
  @id_token = args[:id_token] if args.key?(:id_token)
  @new_email = args[:new_email] if args.key?(:new_email)
  @recaptcha_version = args[:recaptcha_version] if args.key?(:recaptcha_version)
  @request_type = args[:request_type] if args.key?(:request_type)
  @return_oob_link = args[:return_oob_link] if args.key?(:return_oob_link)
  @target_project_id = args[:target_project_id] if args.key?(:target_project_id)
  @tenant_id = args[:tenant_id] if args.key?(:tenant_id)
  @user_ip = args[:user_ip] if args.key?(:user_ip)
end