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



2337
2338
2339
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2337

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

Instance Attribute Details

#action ⇒ String

The action code. Corresponds to the JSON property action

Returns:

  • (String) 


2127
2128
2129
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2127

def action
  @action
end

#app_installation_url ⇒ String

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

Returns:

  • (String) 


2132
2133
2134
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2132

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) 


2137
2138
2139
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2137

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) 


2143
2144
2145
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2143

def context
  @context
end

#date_of_birth ⇒ String

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

Returns:

  • (String) 


2148
2149
2150
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2148

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) 


2153
2154
2155
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2153

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) 


2159
2160
2161
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2159

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) 


2164
2165
2166
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2164

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) 


2171
2172
2173
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2171

def email_verified
  @email_verified
end

#error_message ⇒ String

Client error code. Corresponds to the JSON property errorMessage

Returns:

  • (String) 


2177
2178
2179
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2177

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) 


2183
2184
2185
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2183

def expires_in
  @expires_in
end

#federated_id ⇒ String

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

Returns:

  • (String) 


2188
2189
2190
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2188

def federated_id
  @federated_id
end

#first_name ⇒ String

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

Returns:

  • (String) 


2193
2194
2195
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2193

def first_name
  @first_name
end

#full_name ⇒ String

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

Returns:

  • (String) 


2198
2199
2200
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2198

def full_name
  @full_name
end

#id_token ⇒ String

The ID token. Corresponds to the JSON property idToken

Returns:

  • (String) 


2203
2204
2205
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2203

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) 


2210
2211
2212
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2210

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) 


2215
2216
2217
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2215

def is_new_user
  @is_new_user
end

#kind ⇒ String

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

Returns:

  • (String) 


2221
2222
2223
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2221

def kind
  @kind
end

#language ⇒ String

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

Returns:

  • (String) 


2226
2227
2228
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2226

def language
  @language
end

#last_name ⇒ String

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

Returns:

  • (String) 


2231
2232
2233
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2231

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) 


2237
2238
2239
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2237

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) 


2243
2244
2245
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2243

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) 


2249
2250
2251
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2249

def need_email
  @need_email
end

#nick_name ⇒ String

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

Returns:

  • (String) 


2255
2256
2257
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2255

def nick_name
  @nick_name
end

#oauth_access_token ⇒ String

The OAuth2 access token. Corresponds to the JSON property oauthAccessToken

Returns:

  • (String) 


2260
2261
2262
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2260

def oauth_access_token
  @oauth_access_token
end

#oauth_authorization_code ⇒ String

The OAuth2 authorization code. Corresponds to the JSON property oauthAuthorizationCode

Returns:

  • (String) 


2265
2266
2267
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2265

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) 


2270
2271
2272
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2270

def oauth_expire_in
  @oauth_expire_in
end

#oauth_id_token ⇒ String

The OIDC id token. Corresponds to the JSON property oauthIdToken

Returns:

  • (String) 


2275
2276
2277
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2275

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) 


2280
2281
2282
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2280

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) 


2285
2286
2287
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2285

def oauth_scope
  @oauth_scope
end

#oauth_token_secret ⇒ String

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

Returns:

  • (String) 


2290
2291
2292
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2290

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) 


2296
2297
2298
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2296

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) 


2301
2302
2303
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2301

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) 


2310
2311
2312
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2310

def provider_id
  @provider_id
end

#raw_user_info ⇒ String

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

Returns:

  • (String) 


2315
2316
2317
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2315

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) 


2320
2321
2322
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2320

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) 


2325
2326
2327
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2325

def screen_name
  @screen_name
end

#time_zone ⇒ String

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

Returns:

  • (String) 


2330
2331
2332
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2330

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>) 


2335
2336
2337
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2335

def verified_provider
  @verified_provider
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2342

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