Class: Google::Apis::IdentitytoolkitV3::VerifyAssertionRequest

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

Request to verify 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) ⇒ VerifyAssertionRequest

Returns a new instance of VerifyAssertionRequest



1126
1127
1128
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1126

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

Instance Attribute Details

#delegated_project_number ⇒ String

GCP project number of the requesting delegated app. Currently only intended for Firebase V1 migration. Corresponds to the JSON property delegatedProjectNumber

Returns:

  • (String) 


1074
1075
1076
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1074

def delegated_project_number
  @delegated_project_number
end

#id_token ⇒ String

The GITKit token of the authenticated user. Corresponds to the JSON property idToken

Returns:

  • (String) 


1079
1080
1081
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1079

def id_token
  @id_token
end

#instance_id ⇒ String

Instance id token of the app. Corresponds to the JSON property instanceId

Returns:

  • (String) 


1084
1085
1086
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1084

def instance_id
  @instance_id
end

#pending_id_token ⇒ String

The GITKit token for the non-trusted IDP pending to be confirmed by the user. Corresponds to the JSON property pendingIdToken

Returns:

  • (String) 


1089
1090
1091
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1089

def pending_id_token
  @pending_id_token
end

#post_body ⇒ String

The post body if the request is a HTTP POST. Corresponds to the JSON property postBody

Returns:

  • (String) 


1094
1095
1096
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1094

def post_body
  @post_body
end

#request_uri ⇒ String

The URI to which the IDP redirects the user back. It may contain federated login result params added by the IDP. Corresponds to the JSON property requestUri

Returns:

  • (String) 


1100
1101
1102
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1100

def request_uri
  @request_uri
end

#return_idp_credential ⇒ Boolean Also known as: return_idp_credential?

Whether return 200 and IDP credential rather than throw exception when federated id is already linked. Corresponds to the JSON property returnIdpCredential

Returns:

  • (Boolean) 


1106
1107
1108
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1106

def return_idp_credential
  @return_idp_credential
end

#return_refresh_token ⇒ Boolean Also known as: return_refresh_token?

Whether to return refresh tokens. Corresponds to the JSON property returnRefreshToken

Returns:

  • (Boolean) 


1112
1113
1114
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1112

def return_refresh_token
  @return_refresh_token
end

#return_secure_token ⇒ Boolean Also known as: return_secure_token?

Whether return sts id token and refresh token instead of gitkit token. Corresponds to the JSON property returnSecureToken

Returns:

  • (Boolean) 


1118
1119
1120
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1118

def return_secure_token
  @return_secure_token
end

#session_id ⇒ String

Session ID, which should match the one in previous createAuthUri request. Corresponds to the JSON property sessionId

Returns:

  • (String) 


1124
1125
1126
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1124

def session_id
  @session_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1131

def update!(**args)
  @delegated_project_number = args[:delegated_project_number] if args.key?(:delegated_project_number)
  @id_token = args[:id_token] if args.key?(:id_token)
  @instance_id = args[:instance_id] if args.key?(:instance_id)
  @pending_id_token = args[:pending_id_token] if args.key?(:pending_id_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)
end