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



2086
2087
2088
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2086

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

Instance Attribute Details

#action ⇒ String

The action code. Corresponds to the JSON property action

Returns:

  • (String) 


1876
1877
1878
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1876

def action
  @action
end

#app_installation_url ⇒ String

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

Returns:

  • (String) 


1881
1882
1883
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1881

def app_installation_url
  @app_installation_url
end

#app_scheme ⇒ String

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

Returns:

  • (String) 


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

def app_scheme
  @app_scheme
end

#context ⇒ String

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) 


1892
1893
1894
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1892

def context
  @context
end

#date_of_birth ⇒ String

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

Returns:

  • (String) 


1897
1898
1899
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1897

def date_of_birth
  @date_of_birth
end

#display_name ⇒ String

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

Returns:

  • (String) 


1902
1903
1904
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1902

def display_name
  @display_name
end

#email ⇒ String

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

Returns:

  • (String) 


1908
1909
1910
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1908

def email
  @email
end

#email_recycled ⇒ Boolean Also known as: email_recycled?

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

Returns:

  • (Boolean) 


1913
1914
1915
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1913

def email_recycled
  @email_recycled
end

#email_verified ⇒ Boolean 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) 


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

def email_verified
  @email_verified
end

#error_message ⇒ String

Client error code. Corresponds to the JSON property errorMessage

Returns:

  • (String) 


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

def error_message
  @error_message
end

#expires_in ⇒ Fixnum

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:

  • (Fixnum) 


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

def expires_in
  @expires_in
end

#federated_id ⇒ String

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

Returns:

  • (String) 


1937
1938
1939
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1937

def federated_id
  @federated_id
end

#first_name ⇒ String

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

Returns:

  • (String) 


1942
1943
1944
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1942

def first_name
  @first_name
end

#full_name ⇒ String

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

Returns:

  • (String) 


1947
1948
1949
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1947

def full_name
  @full_name
end

#id_token ⇒ String

The ID token. Corresponds to the JSON property idToken

Returns:

  • (String) 


1952
1953
1954
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1952

def id_token
  @id_token
end

#input_email ⇒ String

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) 


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

def input_email
  @input_email
end

#is_new_user ⇒ Boolean Also known as: is_new_user?

True if it's a new user sign-in, false if it's a returning user. Corresponds to the JSON property isNewUser

Returns:

  • (Boolean) 


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

def is_new_user
  @is_new_user
end

#kind ⇒ String

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

Returns:

  • (String) 


1970
1971
1972
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1970

def kind
  @kind
end

#language ⇒ String

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

Returns:

  • (String) 


1975
1976
1977
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1975

def language
  @language
end

#last_name ⇒ String

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

Returns:

  • (String) 


1980
1981
1982
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1980

def last_name
  @last_name
end

#local_id ⇒ String

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) 


1986
1987
1988
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1986

def local_id
  @local_id
end

#need_confirmation ⇒ Boolean 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) 


1992
1993
1994
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1992

def need_confirmation
  @need_confirmation
end

#need_email ⇒ Boolean 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) 


1998
1999
2000
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1998

def need_email
  @need_email
end

#nick_name ⇒ String

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

Returns:

  • (String) 


2004
2005
2006
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2004

def nick_name
  @nick_name
end

#oauth_access_token ⇒ String

The OAuth2 access token. Corresponds to the JSON property oauthAccessToken

Returns:

  • (String) 


2009
2010
2011
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2009

def oauth_access_token
  @oauth_access_token
end

#oauth_authorization_code ⇒ String

The OAuth2 authorization code. Corresponds to the JSON property oauthAuthorizationCode

Returns:

  • (String) 


2014
2015
2016
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2014

def oauth_authorization_code
  @oauth_authorization_code
end

#oauth_expire_in ⇒ Fixnum

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

Returns:

  • (Fixnum) 


2019
2020
2021
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2019

def oauth_expire_in
  @oauth_expire_in
end

#oauth_id_token ⇒ String

The OIDC id token. Corresponds to the JSON property oauthIdToken

Returns:

  • (String) 


2024
2025
2026
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2024

def oauth_id_token
  @oauth_id_token
end

#oauth_request_token ⇒ String

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

Returns:

  • (String) 


2029
2030
2031
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2029

def oauth_request_token
  @oauth_request_token
end

#oauth_scope ⇒ String

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

Returns:

  • (String) 


2034
2035
2036
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2034

def oauth_scope
  @oauth_scope
end

#oauth_token_secret ⇒ String

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

Returns:

  • (String) 


2039
2040
2041
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2039

def oauth_token_secret
  @oauth_token_secret
end

#original_email ⇒ String

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) 


2045
2046
2047
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2045

def original_email
  @original_email
end

#photo_url ⇒ String

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

Returns:

  • (String) 


2050
2051
2052
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2050

def photo_url
  @photo_url
end

#provider_id ⇒ String

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) 


2059
2060
2061
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2059

def provider_id
  @provider_id
end

#raw_user_info ⇒ String

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

Returns:

  • (String) 


2064
2065
2066
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2064

def 
  @raw_user_info
end

#refresh_token ⇒ String

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

Returns:

  • (String) 


2069
2070
2071
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2069

def refresh_token
  @refresh_token
end

#screen_name ⇒ String

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

Returns:

  • (String) 


2074
2075
2076
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2074

def screen_name
  @screen_name
end

#time_zone ⇒ String

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

Returns:

  • (String) 


2079
2080
2081
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2079

def time_zone
  @time_zone
end

#verified_provider ⇒ Array<String>

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

Returns:

  • (Array<String>) 


2084
2085
2086
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2084

def verified_provider
  @verified_provider
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2091

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)
  @is_new_user = args[:is_new_user] if args.key?(:is_new_user)
  @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