Class: Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithIdpResponse

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

Overview

Response message for SignInWithIdp.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1SignInWithIdpResponse

Returns a new instance of GoogleCloudIdentitytoolkitV1SignInWithIdpResponse.



2871
2872
2873
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2871

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

Instance Attribute Details

#context ⇒ String

The opaque string set in CreateAuthUri that is used to maintain contextual information between the authentication request and the callback from the IdP. Corresponds to the JSON property context

Returns:

  • (String) 


2647
2648
2649
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2647

def context
  @context
end

#date_of_birth ⇒ String

The date of birth for the user's account at the IdP. Corresponds to the JSON property dateOfBirth

Returns:

  • (String) 


2652
2653
2654
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2652

def date_of_birth
  @date_of_birth
end

#display_name ⇒ String

The display name for the user's account at the IdP. Corresponds to the JSON property displayName

Returns:

  • (String) 


2657
2658
2659
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2657

def display_name
  @display_name
end

#email ⇒ String

The email address of the user's account at the IdP. Corresponds to the JSON property email

Returns:

  • (String) 


2662
2663
2664
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2662

def email
  @email
end

#email_recycled ⇒ Boolean Also known as: email_recycled?

Whether or not there is an existing Identity Platform user account with the same email address but linked to a different account at the same IdP. Only present if the "One account per email address" setting is enabled and the email address at the IdP is verified. Corresponds to the JSON property emailRecycled

Returns:

  • (Boolean) 


2670
2671
2672
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2670

def email_recycled
  @email_recycled
end

#email_verified ⇒ Boolean Also known as: email_verified?

Whether the user account's email address is verified. Corresponds to the JSON property emailVerified

Returns:

  • (Boolean) 


2676
2677
2678
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2676

def email_verified
  @email_verified
end

#error_message ⇒ String

The error message returned if return_idp_credential is set to true and either the FEDERATED_USER_ID_ALREADY_LINKED or EMAIL_EXISTS error is encountered. This field's value is either FEDERATED_USER_ID_ALREADY_LINKED or EMAIL_EXISTS. Corresponds to the JSON property errorMessage

Returns:

  • (String) 


2685
2686
2687
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2685

def error_message
  @error_message
end

#expires_in ⇒ Fixnum

The number of seconds until the Identity Platform ID token expires. Corresponds to the JSON property expiresIn

Returns:

  • (Fixnum) 


2690
2691
2692
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2690

def expires_in
  @expires_in
end

#federated_id ⇒ String

The user's account ID at the IdP. Always present in the response. Corresponds to the JSON property federatedId

Returns:

  • (String) 


2695
2696
2697
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2695

def federated_id
  @federated_id
end

#first_name ⇒ String

The first name for the user's account at the IdP. Corresponds to the JSON property firstName

Returns:

  • (String) 


2700
2701
2702
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2700

def first_name
  @first_name
end

#full_name ⇒ String

The full name for the user's account at the IdP. Corresponds to the JSON property fullName

Returns:

  • (String) 


2705
2706
2707
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2705

def full_name
  @full_name
end

#id_token ⇒ String

An Identity Platform ID token for the authenticated user. Corresponds to the JSON property idToken

Returns:

  • (String) 


2710
2711
2712
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2710

def id_token
  @id_token
end

#input_email ⇒ String

Corresponds to the JSON property inputEmail

Returns:

  • (String) 


2715
2716
2717
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2715

def input_email
  @input_email
end

#is_new_user ⇒ Boolean Also known as: is_new_user?

Whether or not a new Identity Platform account was created for the authenticated user. Corresponds to the JSON property isNewUser

Returns:

  • (Boolean) 


2721
2722
2723
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2721

def is_new_user
  @is_new_user
end

#kind ⇒ String

Corresponds to the JSON property kind

Returns:

  • (String) 


2727
2728
2729
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2727

def kind
  @kind
end

#language ⇒ String

The language preference for the user's account at the IdP. Corresponds to the JSON property language

Returns:

  • (String) 


2732
2733
2734
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2732

def language
  @language
end

#last_name ⇒ String

The last name for the user's account at the IdP. Corresponds to the JSON property lastName

Returns:

  • (String) 


2737
2738
2739
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2737

def last_name
  @last_name
end

#local_id ⇒ String

The ID of the authenticated Identity Platform user. Always present in the response. Corresponds to the JSON property localId

Returns:

  • (String) 


2743
2744
2745
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2743

def local_id
  @local_id
end

#mfa_info ⇒ Array<Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1MfaEnrollment>

Info on which multi-factor authentication providers are enabled for the account. Present if the user needs to complete the sign-in using multi-factor authentication. Corresponds to the JSON property mfaInfo

Returns:



2750
2751
2752
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2750

def mfa_info
  @mfa_info
end

#mfa_pending_credential ⇒ String

An opaque string that functions as proof that the user has successfully passed the first factor authentication. Corresponds to the JSON property mfaPendingCredential

Returns:

  • (String) 


2756
2757
2758
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2756

def mfa_pending_credential
  @mfa_pending_credential
end

#need_confirmation ⇒ Boolean Also known as: need_confirmation?

Whether or not there is an existing Identity Platform user account with the same email address as the current account signed in at the IdP, and the account's email address is not verified at the IdP. The user will need to sign in to the existing Identity Platform account and then link the current credential from the IdP to it. Only present if the "One account per email address" setting is enabled. Corresponds to the JSON property needConfirmation

Returns:

  • (Boolean) 


2766
2767
2768
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2766

def need_confirmation
  @need_confirmation
end

#need_email ⇒ Boolean Also known as: need_email?

Corresponds to the JSON property needEmail

Returns:

  • (Boolean) 


2772
2773
2774
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2772

def need_email
  @need_email
end

#nick_name ⇒ String

The nickname for the user's account at the IdP. Corresponds to the JSON property nickName

Returns:

  • (String) 


2778
2779
2780
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2778

def nick_name
  @nick_name
end

#oauth_access_token ⇒ String

The OAuth access token from the IdP, if available. Corresponds to the JSON property oauthAccessToken

Returns:

  • (String) 


2783
2784
2785
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2783

def oauth_access_token
  @oauth_access_token
end

#oauth_authorization_code ⇒ String

The OAuth 2.0 authorization code, if available. Only present for the Google provider. Corresponds to the JSON property oauthAuthorizationCode

Returns:

  • (String) 


2789
2790
2791
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2789

def oauth_authorization_code
  @oauth_authorization_code
end

#oauth_expire_in ⇒ Fixnum

The number of seconds until the OAuth access token from the IdP expires. Corresponds to the JSON property oauthExpireIn

Returns:

  • (Fixnum) 


2794
2795
2796
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2794

def oauth_expire_in
  @oauth_expire_in
end

#oauth_id_token ⇒ String

The OpenID Connect ID token from the IdP, if available. Corresponds to the JSON property oauthIdToken

Returns:

  • (String) 


2799
2800
2801
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2799

def oauth_id_token
  @oauth_id_token
end

#oauth_refresh_token ⇒ String

The OAuth 2.0 refresh token from the IdP, if available and return_refresh_token is set to true. Corresponds to the JSON property oauthRefreshToken

Returns:

  • (String) 


2805
2806
2807
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2805

def oauth_refresh_token
  @oauth_refresh_token
end

#oauth_token_secret ⇒ String

The OAuth 1.0 token secret from the IdP, if available. Only present for the Twitter provider. Corresponds to the JSON property oauthTokenSecret

Returns:

  • (String) 


2811
2812
2813
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2811

def oauth_token_secret
  @oauth_token_secret
end

#original_email ⇒ String

The main (top-level) email address of the user's Identity Platform account, if different from the email address at the IdP. Only present if the "One account per email address" setting is enabled. Corresponds to the JSON property originalEmail

Returns:

  • (String) 


2818
2819
2820
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2818

def original_email
  @original_email
end

#pending_token ⇒ String

An opaque string that can be used as a credential from the IdP the user is signing into. The pending token obtained here can be set in a future SignInWithIdp request to sign the same user in with the IdP again. Corresponds to the JSON property pendingToken

Returns:

  • (String) 


2825
2826
2827
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2825

def pending_token
  @pending_token
end

#photo_url ⇒ String

The URL of the user's profile picture at the IdP. Corresponds to the JSON property photoUrl

Returns:

  • (String) 


2830
2831
2832
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2830

def photo_url
  @photo_url
end

#provider_id ⇒ String

The provider ID of the IdP that the user is signing in to. Always present in the response. Corresponds to the JSON property providerId

Returns:

  • (String) 


2836
2837
2838
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2836

def provider_id
  @provider_id
end

#raw_user_info ⇒ String

The stringified JSON response containing all the data corresponding to the user's account at the IdP. Corresponds to the JSON property rawUserInfo

Returns:

  • (String) 


2842
2843
2844
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2842

def 
  @raw_user_info
end

#refresh_token ⇒ String

An Identity Platform refresh token for the authenticated user. Corresponds to the JSON property refreshToken

Returns:

  • (String) 


2847
2848
2849
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2847

def refresh_token
  @refresh_token
end

#screen_name ⇒ String

The screen name for the user's account at the Twitter IdP or the login name for the user's account at the GitHub IdP. Corresponds to the JSON property screenName

Returns:

  • (String) 


2853
2854
2855
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2853

def screen_name
  @screen_name
end

#tenant_id ⇒ String

The value of the tenant_id field in the request. Corresponds to the JSON property tenantId

Returns:

  • (String) 


2858
2859
2860
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2858

def tenant_id
  @tenant_id
end

#time_zone ⇒ String

The time zone for the user's account at the IdP. Corresponds to the JSON property timeZone

Returns:

  • (String) 


2863
2864
2865
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2863

def time_zone
  @time_zone
end

#verified_provider ⇒ Array<String>

A list of provider IDs that the user can sign in to in order to resolve a need_confirmation error. Only present if need_confirmation is set to true. Corresponds to the JSON property verifiedProvider

Returns:

  • (Array<String>) 


2869
2870
2871
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2869

def verified_provider
  @verified_provider
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2876

def update!(**args)
  @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)
  @mfa_info = args[:mfa_info] if args.key?(:mfa_info)
  @mfa_pending_credential = args[:mfa_pending_credential] if args.key?(:mfa_pending_credential)
  @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_refresh_token = args[:oauth_refresh_token] if args.key?(:oauth_refresh_token)
  @oauth_token_secret = args[:oauth_token_secret] if args.key?(:oauth_token_secret)
  @original_email = args[:original_email] if args.key?(:original_email)
  @pending_token = args[:pending_token] if args.key?(:pending_token)
  @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)
  @tenant_id = args[:tenant_id] if args.key?(:tenant_id)
  @time_zone = args[:time_zone] if args.key?(:time_zone)
  @verified_provider = args[:verified_provider] if args.key?(:verified_provider)
end