Class: Google::Apis::IdentitytoolkitV3::VerifyAssertionResponse

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/identitytoolkit_v3/classes.rb,
generated/google/apis/identitytoolkit_v3/representations.rb,
generated/google/apis/identitytoolkit_v3/representations.rb

Overview

Response of verifying the IDP assertion.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ VerifyAssertionResponse

Returns a new instance of VerifyAssertionResponse.


1967
1968
1969
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1967

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

Instance Attribute Details

#actionString

The action code. Corresponds to the JSON property action

Returns:

  • (String)

1763
1764
1765
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1763

def action
  @action
end

#app_installation_urlString

URL for OTA app installation. Corresponds to the JSON property appInstallationUrl

Returns:

  • (String)

1768
1769
1770
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1768

def app_installation_url
  @app_installation_url
end

#app_schemeString

The custom scheme used by mobile app. Corresponds to the JSON property appScheme

Returns:

  • (String)

1773
1774
1775
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1773

def app_scheme
  @app_scheme
end

#contextString

The opaque value used by the client to maintain context info between the authentication request and the IDP callback. Corresponds to the JSON property context

Returns:

  • (String)

1779
1780
1781
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1779

def context
  @context
end

#date_of_birthString

The birth date of the IdP account. Corresponds to the JSON property dateOfBirth

Returns:

  • (String)

1784
1785
1786
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1784

def date_of_birth
  @date_of_birth
end

#display_nameString

The display name of the user. Corresponds to the JSON property displayName

Returns:

  • (String)

1789
1790
1791
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1789

def display_name
  @display_name
end

#emailString

The email returned by the IdP. NOTE: The federated login user may not own the email. Corresponds to the JSON property email

Returns:

  • (String)

1795
1796
1797
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1795

def email
  @email
end

#email_recycledBoolean Also known as: email_recycled?

It's true if the email is recycled. Corresponds to the JSON property emailRecycled

Returns:

  • (Boolean)

1800
1801
1802
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1800

def email_recycled
  @email_recycled
end

#email_verifiedBoolean Also known as: email_verified?

The value is true if the IDP is also the email provider. It means the user owns the email. Corresponds to the JSON property emailVerified

Returns:

  • (Boolean)

1807
1808
1809
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1807

def email_verified
  @email_verified
end

#error_messageString

Client error code. Corresponds to the JSON property errorMessage

Returns:

  • (String)

1813
1814
1815
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1813

def error_message
  @error_message
end

#expires_inString

If idToken is STS id token, then this field will be expiration time of STS id token in seconds. Corresponds to the JSON property expiresIn

Returns:

  • (String)

1819
1820
1821
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1819

def expires_in
  @expires_in
end

#federated_idString

The unique ID identifies the IdP account. Corresponds to the JSON property federatedId

Returns:

  • (String)

1824
1825
1826
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1824

def federated_id
  @federated_id
end

#first_nameString

The first name of the user. Corresponds to the JSON property firstName

Returns:

  • (String)

1829
1830
1831
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1829

def first_name
  @first_name
end

#full_nameString

The full name of the user. Corresponds to the JSON property fullName

Returns:

  • (String)

1834
1835
1836
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1834

def full_name
  @full_name
end

#id_tokenString

The ID token. Corresponds to the JSON property idToken

Returns:

  • (String)

1839
1840
1841
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1839

def id_token
  @id_token
end

#input_emailString

It's the identifier param in the createAuthUri request if the identifier is an email. It can be used to check whether the user input email is different from the asserted email. Corresponds to the JSON property inputEmail

Returns:

  • (String)

1846
1847
1848
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1846

def input_email
  @input_email
end

#kindString

The fixed string "identitytoolkit#VerifyAssertionResponse". Corresponds to the JSON property kind

Returns:

  • (String)

1851
1852
1853
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1851

def kind
  @kind
end

#languageString

The language preference of the user. Corresponds to the JSON property language

Returns:

  • (String)

1856
1857
1858
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1856

def language
  @language
end

#last_nameString

The last name of the user. Corresponds to the JSON property lastName

Returns:

  • (String)

1861
1862
1863
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1861

def last_name
  @last_name
end

#local_idString

The RP local ID if it's already been mapped to the IdP account identified by the federated ID. Corresponds to the JSON property localId

Returns:

  • (String)

1867
1868
1869
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1867

def local_id
  @local_id
end

#need_confirmationBoolean Also known as: need_confirmation?

Whether the assertion is from a non-trusted IDP and need account linking confirmation. Corresponds to the JSON property needConfirmation

Returns:

  • (Boolean)

1873
1874
1875
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1873

def need_confirmation
  @need_confirmation
end

#need_emailBoolean Also known as: need_email?

Whether need client to supply email to complete the federated login flow. Corresponds to the JSON property needEmail

Returns:

  • (Boolean)

1879
1880
1881
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1879

def need_email
  @need_email
end

#nick_nameString

The nick name of the user. Corresponds to the JSON property nickName

Returns:

  • (String)

1885
1886
1887
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1885

def nick_name
  @nick_name
end

#oauth_access_tokenString

The OAuth2 access token. Corresponds to the JSON property oauthAccessToken

Returns:

  • (String)

1890
1891
1892
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1890

def oauth_access_token
  @oauth_access_token
end

#oauth_authorization_codeString

The OAuth2 authorization code. Corresponds to the JSON property oauthAuthorizationCode

Returns:

  • (String)

1895
1896
1897
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1895

def oauth_authorization_code
  @oauth_authorization_code
end

#oauth_expire_inFixnum

The lifetime in seconds of the OAuth2 access token. Corresponds to the JSON property oauthExpireIn

Returns:

  • (Fixnum)

1900
1901
1902
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1900

def oauth_expire_in
  @oauth_expire_in
end

#oauth_id_tokenString

The OIDC id token. Corresponds to the JSON property oauthIdToken

Returns:

  • (String)

1905
1906
1907
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1905

def oauth_id_token
  @oauth_id_token
end

#oauth_request_tokenString

The user approved request token for the OpenID OAuth extension. Corresponds to the JSON property oauthRequestToken

Returns:

  • (String)

1910
1911
1912
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1910

def oauth_request_token
  @oauth_request_token
end

#oauth_scopeString

The scope for the OpenID OAuth extension. Corresponds to the JSON property oauthScope

Returns:

  • (String)

1915
1916
1917
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1915

def oauth_scope
  @oauth_scope
end

#oauth_token_secretString

The OAuth1 access token secret. Corresponds to the JSON property oauthTokenSecret

Returns:

  • (String)

1920
1921
1922
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1920

def oauth_token_secret
  @oauth_token_secret
end

#original_emailString

The original email stored in the mapping storage. It's returned when the federated ID is associated to a different email. Corresponds to the JSON property originalEmail

Returns:

  • (String)

1926
1927
1928
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1926

def original_email
  @original_email
end

#photo_urlString

The URI of the public accessible profiel picture. Corresponds to the JSON property photoUrl

Returns:

  • (String)

1931
1932
1933
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1931

def photo_url
  @photo_url
end

#provider_idString

The IdP ID. For white listed IdPs it's a short domain name e.g. google.com, aol.com, live.net and yahoo.com. If the "providerId" param is set to OpenID OP identifer other than the whilte listed IdPs the OP identifier is returned. If the "identifier" param is federated ID in the createAuthUri request. The domain part of the federated ID is returned. Corresponds to the JSON property providerId

Returns:

  • (String)

1940
1941
1942
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1940

def provider_id
  @provider_id
end

#raw_user_infoString

Raw IDP-returned user info. Corresponds to the JSON property rawUserInfo

Returns:

  • (String)

1945
1946
1947
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1945

def 
  @raw_user_info
end

#refresh_tokenString

If idToken is STS id token, then this field will be refresh token. Corresponds to the JSON property refreshToken

Returns:

  • (String)

1950
1951
1952
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1950

def refresh_token
  @refresh_token
end

#screen_nameString

The screen_name of a Twitter user or the login name at Github. Corresponds to the JSON property screenName

Returns:

  • (String)

1955
1956
1957
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1955

def screen_name
  @screen_name
end

#time_zoneString

The timezone of the user. Corresponds to the JSON property timeZone

Returns:

  • (String)

1960
1961
1962
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1960

def time_zone
  @time_zone
end

#verified_providerArray<String>

When action is 'map', contains the idps which can be used for confirmation. Corresponds to the JSON property verifiedProvider

Returns:

  • (Array<String>)

1965
1966
1967
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1965

def verified_provider
  @verified_provider
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1972

def update!(**args)
  @action = args[:action] if args.key?(:action)
  @app_installation_url = args[:app_installation_url] if args.key?(:app_installation_url)
  @app_scheme = args[:app_scheme] if args.key?(:app_scheme)
  @context = args[:context] if args.key?(:context)
  @date_of_birth = args[:date_of_birth] if args.key?(:date_of_birth)
  @display_name = args[:display_name] if args.key?(:display_name)
  @email = args[:email] if args.key?(:email)
  @email_recycled = args[:email_recycled] if args.key?(:email_recycled)
  @email_verified = args[:email_verified] if args.key?(:email_verified)
  @error_message = args[:error_message] if args.key?(:error_message)
  @expires_in = args[:expires_in] if args.key?(:expires_in)
  @federated_id = args[:federated_id] if args.key?(:federated_id)
  @first_name = args[:first_name] if args.key?(:first_name)
  @full_name = args[:full_name] if args.key?(:full_name)
  @id_token = args[:id_token] if args.key?(:id_token)
  @input_email = args[:input_email] if args.key?(:input_email)
  @kind = args[:kind] if args.key?(:kind)
  @language = args[:language] if args.key?(:language)
  @last_name = args[:last_name] if args.key?(:last_name)
  @local_id = args[:local_id] if args.key?(:local_id)
  @need_confirmation = args[:need_confirmation] if args.key?(:need_confirmation)
  @need_email = args[:need_email] if args.key?(:need_email)
  @nick_name = args[:nick_name] if args.key?(:nick_name)
  @oauth_access_token = args[:oauth_access_token] if args.key?(:oauth_access_token)
  @oauth_authorization_code = args[:oauth_authorization_code] if args.key?(:oauth_authorization_code)
  @oauth_expire_in = args[:oauth_expire_in] if args.key?(:oauth_expire_in)
  @oauth_id_token = args[:oauth_id_token] if args.key?(:oauth_id_token)
  @oauth_request_token = args[:oauth_request_token] if args.key?(:oauth_request_token)
  @oauth_scope = args[:oauth_scope] if args.key?(:oauth_scope)
  @oauth_token_secret = args[:oauth_token_secret] if args.key?(:oauth_token_secret)
  @original_email = args[:original_email] if args.key?(:original_email)
  @photo_url = args[:photo_url] if args.key?(:photo_url)
  @provider_id = args[:provider_id] if args.key?(:provider_id)
  @raw_user_info = args[:raw_user_info] if args.key?(:raw_user_info)
  @refresh_token = args[:refresh_token] if args.key?(:refresh_token)
  @screen_name = args[:screen_name] if args.key?(:screen_name)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
  @verified_provider = args[:verified_provider] if args.key?(:verified_provider)
end