Class: Google::Apis::IdentitytoolkitV3::VerifyAssertionResponse
- Inherits:
-
Object
- Object
- Google::Apis::IdentitytoolkitV3::VerifyAssertionResponse
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/identitytoolkit_v3/classes.rb,
lib/google/apis/identitytoolkit_v3/representations.rb,
lib/google/apis/identitytoolkit_v3/representations.rb
Overview
Response of verifying the IDP assertion.
Instance Attribute Summary collapse
-
#action ⇒ String
The action code.
-
#app_installation_url ⇒ String
URL for OTA app installation.
-
#app_scheme ⇒ String
The custom scheme used by mobile app.
-
#context ⇒ String
The opaque value used by the client to maintain context info between the authentication request and the IDP callback.
-
#date_of_birth ⇒ String
The birth date of the IdP account.
-
#display_name ⇒ String
The display name of the user.
-
#email ⇒ String
The email returned by the IdP.
-
#email_recycled ⇒ Boolean
(also: #email_recycled?)
It's true if the email is recycled.
-
#email_verified ⇒ Boolean
(also: #email_verified?)
The value is true if the IDP is also the email provider.
-
#error_message ⇒ String
Client error code.
-
#expires_in ⇒ Fixnum
If idToken is STS id token, then this field will be expiration time of STS id token in seconds.
-
#federated_id ⇒ String
The unique ID identifies the IdP account.
-
#first_name ⇒ String
The first name of the user.
-
#full_name ⇒ String
The full name of the user.
-
#id_token ⇒ String
The ID token.
-
#input_email ⇒ String
It's the identifier param in the createAuthUri request if the identifier is an email.
-
#is_new_user ⇒ Boolean
(also: #is_new_user?)
True if it's a new user sign-in, false if it's a returning user.
-
#kind ⇒ String
The fixed string "identitytoolkit#VerifyAssertionResponse".
-
#language ⇒ String
The language preference of the user.
-
#last_name ⇒ String
The last name of the user.
-
#local_id ⇒ String
The RP local ID if it's already been mapped to the IdP account identified by the federated ID.
-
#need_confirmation ⇒ Boolean
(also: #need_confirmation?)
Whether the assertion is from a non-trusted IDP and need account linking confirmation.
-
#need_email ⇒ Boolean
(also: #need_email?)
Whether need client to supply email to complete the federated login flow.
-
#nick_name ⇒ String
The nick name of the user.
-
#oauth_access_token ⇒ String
The OAuth2 access token.
-
#oauth_authorization_code ⇒ String
The OAuth2 authorization code.
-
#oauth_expire_in ⇒ Fixnum
The lifetime in seconds of the OAuth2 access token.
-
#oauth_id_token ⇒ String
The OIDC id token.
-
#oauth_request_token ⇒ String
The user approved request token for the OpenID OAuth extension.
-
#oauth_scope ⇒ String
The scope for the OpenID OAuth extension.
-
#oauth_token_secret ⇒ String
The OAuth1 access token secret.
-
#original_email ⇒ String
The original email stored in the mapping storage.
-
#photo_url ⇒ String
The URI of the public accessible profiel picture.
-
#provider_id ⇒ String
The IdP ID.
-
#raw_user_info ⇒ String
Raw IDP-returned user info.
-
#refresh_token ⇒ String
If idToken is STS id token, then this field will be refresh token.
-
#screen_name ⇒ String
The screen_name of a Twitter user or the login name at Github.
-
#time_zone ⇒ String
The timezone of the user.
-
#verified_provider ⇒ Array<String>
When action is 'map', contains the idps which can be used for confirmation.
Instance Method Summary collapse
-
#initialize(**args) ⇒ VerifyAssertionResponse
constructor
A new instance of VerifyAssertionResponse.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ VerifyAssertionResponse
Returns a new instance of VerifyAssertionResponse.
2486 2487 2488 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2486 def initialize(**args) update!(**args) end |
Instance Attribute Details
#action ⇒ String
The action code.
Corresponds to the JSON property action
2276 2277 2278 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2276 def action @action end |
#app_installation_url ⇒ String
URL for OTA app installation.
Corresponds to the JSON property appInstallationUrl
2281 2282 2283 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2281 def app_installation_url @app_installation_url end |
#app_scheme ⇒ String
The custom scheme used by mobile app.
Corresponds to the JSON property appScheme
2286 2287 2288 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2286 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
2292 2293 2294 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2292 def context @context end |
#date_of_birth ⇒ String
The birth date of the IdP account.
Corresponds to the JSON property dateOfBirth
2297 2298 2299 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2297 def date_of_birth @date_of_birth end |
#display_name ⇒ String
The display name of the user.
Corresponds to the JSON property displayName
2302 2303 2304 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2302 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
2308 2309 2310 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2308 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
2313 2314 2315 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2313 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
2320 2321 2322 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2320 def email_verified @email_verified end |
#error_message ⇒ String
Client error code.
Corresponds to the JSON property errorMessage
2326 2327 2328 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2326 def @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
2332 2333 2334 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2332 def expires_in @expires_in end |
#federated_id ⇒ String
The unique ID identifies the IdP account.
Corresponds to the JSON property federatedId
2337 2338 2339 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2337 def federated_id @federated_id end |
#first_name ⇒ String
The first name of the user.
Corresponds to the JSON property firstName
2342 2343 2344 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2342 def first_name @first_name end |
#full_name ⇒ String
The full name of the user.
Corresponds to the JSON property fullName
2347 2348 2349 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2347 def full_name @full_name end |
#id_token ⇒ String
The ID token.
Corresponds to the JSON property idToken
2352 2353 2354 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2352 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
2359 2360 2361 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2359 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
2364 2365 2366 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2364 def is_new_user @is_new_user end |
#kind ⇒ String
The fixed string "identitytoolkit#VerifyAssertionResponse".
Corresponds to the JSON property kind
2370 2371 2372 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2370 def kind @kind end |
#language ⇒ String
The language preference of the user.
Corresponds to the JSON property language
2375 2376 2377 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2375 def language @language end |
#last_name ⇒ String
The last name of the user.
Corresponds to the JSON property lastName
2380 2381 2382 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2380 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
2386 2387 2388 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2386 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
2392 2393 2394 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2392 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
2398 2399 2400 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2398 def need_email @need_email end |
#nick_name ⇒ String
The nick name of the user.
Corresponds to the JSON property nickName
2404 2405 2406 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2404 def nick_name @nick_name end |
#oauth_access_token ⇒ String
The OAuth2 access token.
Corresponds to the JSON property oauthAccessToken
2409 2410 2411 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2409 def oauth_access_token @oauth_access_token end |
#oauth_authorization_code ⇒ String
The OAuth2 authorization code.
Corresponds to the JSON property oauthAuthorizationCode
2414 2415 2416 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2414 def @oauth_authorization_code end |
#oauth_expire_in ⇒ Fixnum
The lifetime in seconds of the OAuth2 access token.
Corresponds to the JSON property oauthExpireIn
2419 2420 2421 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2419 def oauth_expire_in @oauth_expire_in end |
#oauth_id_token ⇒ String
The OIDC id token.
Corresponds to the JSON property oauthIdToken
2424 2425 2426 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2424 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
2429 2430 2431 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2429 def oauth_request_token @oauth_request_token end |
#oauth_scope ⇒ String
The scope for the OpenID OAuth extension.
Corresponds to the JSON property oauthScope
2434 2435 2436 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2434 def oauth_scope @oauth_scope end |
#oauth_token_secret ⇒ String
The OAuth1 access token secret.
Corresponds to the JSON property oauthTokenSecret
2439 2440 2441 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2439 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
2445 2446 2447 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2445 def original_email @original_email end |
#photo_url ⇒ String
The URI of the public accessible profiel picture.
Corresponds to the JSON property photoUrl
2450 2451 2452 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2450 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
2459 2460 2461 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2459 def provider_id @provider_id end |
#raw_user_info ⇒ String
Raw IDP-returned user info.
Corresponds to the JSON property rawUserInfo
2464 2465 2466 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2464 def raw_user_info @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
2469 2470 2471 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2469 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
2474 2475 2476 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2474 def screen_name @screen_name end |
#time_zone ⇒ String
The timezone of the user.
Corresponds to the JSON property timeZone
2479 2480 2481 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2479 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
2484 2485 2486 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2484 def verified_provider @verified_provider end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 |
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 2491 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 |