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.



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

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) 


1028
1029
1030
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1028

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) 


1033
1034
1035
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1033

def id_token
  @id_token
end

#instance_id ⇒ String

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

Returns:

  • (String) 


1038
1039
1040
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1038

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) 


1043
1044
1045
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1043

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) 


1048
1049
1050
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1048

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) 


1054
1055
1056
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1054

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) 


1060
1061
1062
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1060

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) 


1066
1067
1068
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1066

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) 


1072
1073
1074
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1072

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) 


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

def session_id
  @session_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 1085

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