Class: Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithIdpRequest

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

Request message for SignInWithIdp.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1SignInWithIdpRequest

Returns a new instance of GoogleCloudIdentitytoolkitV1SignInWithIdpRequest.



2620
2621
2622
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2620

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

Instance Attribute Details

#auto_create ⇒ Boolean Also known as: auto_create?

Corresponds to the JSON property autoCreate

Returns:

  • (Boolean) 


2526
2527
2528
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2526

def auto_create
  @auto_create
end

#delegated_project_number ⇒ Fixnum

Corresponds to the JSON property delegatedProjectNumber

Returns:

  • (Fixnum) 


2532
2533
2534
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2532

def delegated_project_number
  @delegated_project_number
end

#id_token ⇒ String

A valid Identity Platform ID token. If passed, the user's account at the IdP will be linked to the account represented by this ID token. Corresponds to the JSON property idToken

Returns:

  • (String) 


2538
2539
2540
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2538

def id_token
  @id_token
end

#pending_id_token ⇒ String

Corresponds to the JSON property pendingIdToken

Returns:

  • (String) 


2543
2544
2545
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2543

def pending_id_token
  @pending_id_token
end

#pending_token ⇒ String

An opaque string from a previous SignInWithIdp response. If set, it can be used to repeat the sign-in operation from the previous SignInWithIdp operation. This may be present if the user needs to confirm their account information as part of a previous federated login attempt, or perform account linking. Corresponds to the JSON property pendingToken

Returns:

  • (String) 


2551
2552
2553
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2551

def pending_token
  @pending_token
end

#post_body ⇒ String

If the user is signing in with an authorization response obtained via a previous CreateAuthUri authorization request, this is the body of the HTTP POST callback from the IdP, if present. Otherwise, if the user is signing in with a manually provided IdP credential, this should be a URL-encoded form that contains the credential (e.g. an ID token or access token for OAuth 2.0 IdPs) and the provider ID of the IdP that issued the credential. For example, if the user is signing in to the Google provider using a Google ID token, this should be set to id_token=[GOOGLE_ID_TOKEN]&providerId=google.com, where [ GOOGLE_ID_TOKEN] should be replaced with the Google ID token. If the user is signing in to the Facebook provider using a Facebook authentication token, this should be set to id_token=[FACEBOOK_AUTHENTICATION_TOKEN]&providerId= facebook. com&nonce= [NONCE], where [FACEBOOK_AUTHENTICATION_TOKEN] should be replaced with the Facebook authentication token. Nonce is required for validating the token. The request will fail if no nonce is provided. If the user is signing in to the Facebook provider using a Facebook access token, this should be set to access_token=[FACEBOOK_ACCESS_TOKEN]&providerId= facebook. com, where [FACEBOOK_ACCESS_TOKEN] should be replaced with the Facebook access token. If the user is signing in to the Twitter provider using a Twitter OAuth 1.0 credential, this should be set to access_token=[ TWITTER_ACCESS_TOKEN]&oauth_token_secret= [TWITTER_TOKEN_SECRET]&providerId= twitter.com, where [TWITTER_ACCESS_TOKEN] and [TWITTER_TOKEN_SECRET] should be replaced with the Twitter OAuth access token and Twitter OAuth token secret respectively. Corresponds to the JSON property postBody

Returns:

  • (String) 


2578
2579
2580
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2578

def post_body
  @post_body
end

#request_uri ⇒ String

Required. The URL to which the IdP redirects the user back. This can be set to http://localhost if the user is signing in with a manually provided IdP credential. Corresponds to the JSON property requestUri

Returns:

  • (String) 


2585
2586
2587
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2585

def request_uri
  @request_uri
end

#return_idp_credential ⇒ Boolean Also known as: return_idp_credential?

Whether or not to return OAuth credentials from the IdP on the following errors: FEDERATED_USER_ID_ALREADY_LINKED and EMAIL_EXISTS. Corresponds to the JSON property returnIdpCredential

Returns:

  • (Boolean) 


2591
2592
2593
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2591

def return_idp_credential
  @return_idp_credential
end

#return_refresh_token ⇒ Boolean Also known as: return_refresh_token?

Whether or not to return the OAuth refresh token from the IdP, if available. Corresponds to the JSON property returnRefreshToken

Returns:

  • (Boolean) 


2597
2598
2599
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2597

def return_refresh_token
  @return_refresh_token
end

#return_secure_token ⇒ Boolean Also known as: return_secure_token?

Should always be true. Corresponds to the JSON property returnSecureToken

Returns:

  • (Boolean) 


2603
2604
2605
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2603

def return_secure_token
  @return_secure_token
end

#session_id ⇒ String

The session ID returned from a previous CreateAuthUri call. This field is verified against that session ID to prevent session fixation attacks. Required if the user is signing in with an authorization response from a previous CreateAuthUri authorization request. Corresponds to the JSON property sessionId

Returns:

  • (String) 


2612
2613
2614
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2612

def session_id
  @session_id
end

#tenant_id ⇒ String

The ID of the Identity Platform tenant the user is signing in to. If not set, the user will sign in to the default Identity Platform project. Corresponds to the JSON property tenantId

Returns:

  • (String) 


2618
2619
2620
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2618

def tenant_id
  @tenant_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2625

def update!(**args)
  @auto_create = args[:auto_create] if args.key?(:auto_create)
  @delegated_project_number = args[:delegated_project_number] if args.key?(:delegated_project_number)
  @id_token = args[:id_token] if args.key?(:id_token)
  @pending_id_token = args[:pending_id_token] if args.key?(:pending_id_token)
  @pending_token = args[:pending_token] if args.key?(:pending_token)
  @post_body = args[:post_body] if args.key?(:post_body)
  @request_uri = args[:request_uri] if args.key?(:request_uri)
  @return_idp_credential = args[:return_idp_credential] if args.key?(:return_idp_credential)
  @return_refresh_token = args[:return_refresh_token] if args.key?(:return_refresh_token)
  @return_secure_token = args[:return_secure_token] if args.key?(:return_secure_token)
  @session_id = args[:session_id] if args.key?(:session_id)
  @tenant_id = args[:tenant_id] if args.key?(:tenant_id)
end