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



1333
1334
1335
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1333

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

Instance Attribute Details

#auto_create ⇒ Boolean Also known as: auto_create?

When it's true, automatically creates a new account if the user doesn't exist. When it's false, allows existing user to sign in normally and throws exception if the user doesn't exist. Corresponds to the JSON property autoCreate

Returns:

  • (Boolean) 


1274
1275
1276
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1274

def auto_create
  @auto_create
end

#delegated_project_number ⇒ Fixnum

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

Returns:

  • (Fixnum) 


1281
1282
1283
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1281

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) 


1286
1287
1288
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1286

def id_token
  @id_token
end

#instance_id ⇒ String

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

Returns:

  • (String) 


1291
1292
1293
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1291

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) 


1296
1297
1298
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1296

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) 


1301
1302
1303
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1301

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) 


1307
1308
1309
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1307

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) 


1313
1314
1315
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1313

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) 


1319
1320
1321
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1319

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) 


1325
1326
1327
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1325

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) 


1331
1332
1333
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1331

def session_id
  @session_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1338

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