Class: Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SetAccountInfoRequest

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1SetAccountInfoRequest

Returns a new instance of GoogleCloudIdentitytoolkitV1SetAccountInfoRequest.



2000
2001
2002
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2000

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

Instance Attribute Details

#captcha_challenge ⇒ String

Corresponds to the JSON property captchaChallenge

Returns:

  • (String) 


1838
1839
1840
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1838

def captcha_challenge
  @captcha_challenge
end

#captcha_response ⇒ String

The response from reCaptcha challenge. This is required when the system detects possible abuse activities. Corresponds to the JSON property captchaResponse

Returns:

  • (String) 


1844
1845
1846
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1844

def captcha_response
  @captcha_response
end

#created_at ⇒ Fixnum

The timestamp in milliseconds when the account was created. Corresponds to the JSON property createdAt

Returns:

  • (Fixnum) 


1849
1850
1851
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1849

def created_at
  @created_at
end

#custom_attributes ⇒ String

JSON formatted custom attributes to be stored in the Identity Platform ID token. Specifying this field requires a Google OAuth 2.0 credential with proper permissions. Corresponds to the JSON property customAttributes

Returns:

  • (String) 


1857
1858
1859
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1857

def custom_attributes
  @custom_attributes
end

#delegated_project_number ⇒ Fixnum

Corresponds to the JSON property delegatedProjectNumber

Returns:

  • (Fixnum) 


1862
1863
1864
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1862

def delegated_project_number
  @delegated_project_number
end

#delete_attribute ⇒ Array<String>

The account's attributes to be deleted. Corresponds to the JSON property deleteAttribute

Returns:

  • (Array<String>) 


1867
1868
1869
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1867

def delete_attribute
  @delete_attribute
end

#delete_provider ⇒ Array<String>

The Identity Providers to unlink from the user's account. Corresponds to the JSON property deleteProvider

Returns:

  • (Array<String>) 


1872
1873
1874
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1872

def delete_provider
  @delete_provider
end

#disable_user ⇒ Boolean Also known as: disable_user?

If true, marks the account as disabled, meaning the user will no longer be able to sign-in. Corresponds to the JSON property disableUser

Returns:

  • (Boolean) 


1878
1879
1880
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1878

def disable_user
  @disable_user
end

#display_name ⇒ String

The user's new display name to be updated in the account's attributes. The length of the display name must be less than or equal to 256 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


1885
1886
1887
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1885

def display_name
  @display_name
end

#email ⇒ String

The user's new email to be updated in the account's attributes. 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) 


1893
1894
1895
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1893

def email
  @email
end

#email_verified ⇒ Boolean Also known as: email_verified?

Whether the user's email has been verified. Specifying this field requires a Google OAuth 2.0 credential with proper permissions. Corresponds to the JSON property emailVerified

Returns:

  • (Boolean) 


1900
1901
1902
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1900

def email_verified
  @email_verified
end

#id_token ⇒ String

A valid Identity Platform ID token. Required when attempting to change user- related information. Corresponds to the JSON property idToken

Returns:

  • (String) 


1907
1908
1909
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1907

def id_token
  @id_token
end

#instance_id ⇒ String

Corresponds to the JSON property instanceId

Returns:

  • (String) 


1912
1913
1914
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1912

def instance_id
  @instance_id
end

#last_login_at ⇒ Fixnum

The timestamp in milliseconds when the account last logged in. Corresponds to the JSON property lastLoginAt

Returns:

  • (Fixnum) 


1917
1918
1919
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1917

def 
  @last_login_at
end

#link_provider_user_info ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1ProviderUserInfo

Information about the user as provided by various Identity Providers. Corresponds to the JSON property linkProviderUserInfo

Returns:



1922
1923
1924
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1922

def 
  @link_provider_user_info
end

#local_id ⇒ String

The ID of the user. Specifying this field requires a Google OAuth 2.0 credential with proper permissions. For requests from end-users, an ID token should be passed instead. Corresponds to the JSON property localId

Returns:

  • (String) 


1930
1931
1932
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1930

def local_id
  @local_id
end

#mfa ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1MfaInfo

Multi-factor authentication related information. Corresponds to the JSON property mfa

Returns:



1935
1936
1937
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1935

def mfa
  @mfa
end

#oob_code ⇒ String

The out-of-band code to be applied on the user's account. The following out-of- band code types are supported: * VERIFY_EMAIL * RECOVER_EMAIL * REVERT_SECOND_FACTOR_ADDITION * VERIFY_AND_CHANGE_EMAIL Corresponds to the JSON property oobCode

Returns:

  • (String) 


1942
1943
1944
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1942

def oob_code
  @oob_code
end

#password ⇒ String

The user's new password to be updated in the account's attributes. The password must be at least 6 characters long. Corresponds to the JSON property password

Returns:

  • (String) 


1948
1949
1950
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1948

def password
  @password
end

#phone_number ⇒ String

The phone number to be updated in the account's attributes. Corresponds to the JSON property phoneNumber

Returns:

  • (String) 


1953
1954
1955
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1953

def phone_number
  @phone_number
end

#photo_url ⇒ String

The user's new photo URL for the account's profile photo to be updated in the account's attributes. The length of the URL must be less than or equal to 2048 characters. Corresponds to the JSON property photoUrl

Returns:

  • (String) 


1960
1961
1962
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1960

def photo_url
  @photo_url
end

#provider ⇒ Array<String>

The Identity Providers that the account should be associated with. Corresponds to the JSON property provider

Returns:

  • (Array<String>) 


1965
1966
1967
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1965

def provider
  @provider
end

#return_secure_token ⇒ Boolean Also known as: return_secure_token?

Whether or not to return an ID and refresh token. Should always be true. Corresponds to the JSON property returnSecureToken

Returns:

  • (Boolean) 


1970
1971
1972
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1970

def return_secure_token
  @return_secure_token
end

#target_project_id ⇒ String

The project ID for the project that the account belongs to. Specifying this field requires Google OAuth 2.0 credential with proper permissions. Requests from end users should pass an Identity Platform ID token instead. Corresponds to the JSON property targetProjectId

Returns:

  • (String) 


1979
1980
1981
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1979

def target_project_id
  @target_project_id
end

#tenant_id ⇒ String

The tenant ID of the Identity Platform tenant that the account belongs to. Requests from end users should pass an Identity Platform ID token rather than setting this field. Corresponds to the JSON property tenantId

Returns:

  • (String) 


1986
1987
1988
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1986

def tenant_id
  @tenant_id
end

#upgrade_to_federated_login ⇒ Boolean Also known as: upgrade_to_federated_login?

Whether the account should be restricted to only using federated login. Corresponds to the JSON property upgradeToFederatedLogin

Returns:

  • (Boolean) 


1991
1992
1993
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1991

def 
  @upgrade_to_federated_login
end

#valid_since ⇒ Fixnum

Specifies the minimum timestamp in seconds for an Identity Platform ID token to be considered valid. Corresponds to the JSON property validSince

Returns:

  • (Fixnum) 


1998
1999
2000
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 1998

def valid_since
  @valid_since
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2005

def update!(**args)
  @captcha_challenge = args[:captcha_challenge] if args.key?(:captcha_challenge)
  @captcha_response = args[:captcha_response] if args.key?(:captcha_response)
  @created_at = args[:created_at] if args.key?(:created_at)
  @custom_attributes = args[:custom_attributes] if args.key?(:custom_attributes)
  @delegated_project_number = args[:delegated_project_number] if args.key?(:delegated_project_number)
  @delete_attribute = args[:delete_attribute] if args.key?(:delete_attribute)
  @delete_provider = args[:delete_provider] if args.key?(:delete_provider)
  @disable_user = args[:disable_user] if args.key?(:disable_user)
  @display_name = args[:display_name] if args.key?(:display_name)
  @email = args[:email] if args.key?(:email)
  @email_verified = args[:email_verified] if args.key?(:email_verified)
  @id_token = args[:id_token] if args.key?(:id_token)
  @instance_id = args[:instance_id] if args.key?(:instance_id)
  @last_login_at = args[:last_login_at] if args.key?(:last_login_at)
  @link_provider_user_info = args[:link_provider_user_info] if args.key?(:link_provider_user_info)
  @local_id = args[:local_id] if args.key?(:local_id)
  @mfa = args[:mfa] if args.key?(:mfa)
  @oob_code = args[:oob_code] if args.key?(:oob_code)
  @password = args[:password] if args.key?(:password)
  @phone_number = args[:phone_number] if args.key?(:phone_number)
  @photo_url = args[:photo_url] if args.key?(:photo_url)
  @provider = args[:provider] if args.key?(:provider)
  @return_secure_token = args[:return_secure_token] if args.key?(:return_secure_token)
  @target_project_id = args[:target_project_id] if args.key?(:target_project_id)
  @tenant_id = args[:tenant_id] if args.key?(:tenant_id)
  @upgrade_to_federated_login = args[:upgrade_to_federated_login] if args.key?(:upgrade_to_federated_login)
  @valid_since = args[:valid_since] if args.key?(:valid_since)
end