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



2313
2314
2315
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2313

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

Instance Attribute Details

#action ⇒ String

The action code. Corresponds to the JSON property action

Returns:

  • (String) 


2103
2104
2105
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2103

def action
  @action
end

#app_installation_url ⇒ String

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

Returns:

  • (String) 


2108
2109
2110
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2108

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) 


2113
2114
2115
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2113

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) 


2119
2120
2121
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2119

def context
  @context
end

#date_of_birth ⇒ String

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

Returns:

  • (String) 


2124
2125
2126
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2124

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) 


2129
2130
2131
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2129

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) 


2135
2136
2137
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2135

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) 


2140
2141
2142
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2140

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) 


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

def email_verified
  @email_verified
end

#error_message ⇒ String

Client error code. Corresponds to the JSON property errorMessage

Returns:

  • (String) 


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

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) 


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

def expires_in
  @expires_in
end

#federated_id ⇒ String

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

Returns:

  • (String) 


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

def federated_id
  @federated_id
end

#first_name ⇒ String

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

Returns:

  • (String) 


2169
2170
2171
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2169

def first_name
  @first_name
end

#full_name ⇒ String

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

Returns:

  • (String) 


2174
2175
2176
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2174

def full_name
  @full_name
end

#id_token ⇒ String

The ID token. Corresponds to the JSON property idToken

Returns:

  • (String) 


2179
2180
2181
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2179

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) 


2186
2187
2188
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2186

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) 


2191
2192
2193
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2191

def is_new_user
  @is_new_user
end

#kind ⇒ String

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

Returns:

  • (String) 


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

def kind
  @kind
end

#language ⇒ String

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

Returns:

  • (String) 


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

def language
  @language
end

#last_name ⇒ String

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

Returns:

  • (String) 


2207
2208
2209
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2207

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) 


2213
2214
2215
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2213

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) 


2219
2220
2221
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2219

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) 


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

def need_email
  @need_email
end

#nick_name ⇒ String

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

Returns:

  • (String) 


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

def nick_name
  @nick_name
end

#oauth_access_token ⇒ String

The OAuth2 access token. Corresponds to the JSON property oauthAccessToken

Returns:

  • (String) 


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

def oauth_access_token
  @oauth_access_token
end

#oauth_authorization_code ⇒ String

The OAuth2 authorization code. Corresponds to the JSON property oauthAuthorizationCode

Returns:

  • (String) 


2241
2242
2243
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2241

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) 


2246
2247
2248
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2246

def oauth_expire_in
  @oauth_expire_in
end

#oauth_id_token ⇒ String

The OIDC id token. Corresponds to the JSON property oauthIdToken

Returns:

  • (String) 


2251
2252
2253
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2251

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) 


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

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) 


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

def oauth_scope
  @oauth_scope
end

#oauth_token_secret ⇒ String

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

Returns:

  • (String) 


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

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) 


2272
2273
2274
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2272

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) 


2277
2278
2279
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2277

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) 


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

def provider_id
  @provider_id
end

#raw_user_info ⇒ String

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

Returns:

  • (String) 


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

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) 


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

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) 


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

def screen_name
  @screen_name
end

#time_zone ⇒ String

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

Returns:

  • (String) 


2306
2307
2308
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2306

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


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

def verified_provider
  @verified_provider
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 2318

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