1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="identitytoolkit_v2.html">Identity Toolkit API</a> . <a href="identitytoolkit_v2.accounts.html">accounts</a> . <a href="identitytoolkit_v2.accounts.mfaSignIn.html">mfaSignIn</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#finalize">finalize(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Verifies the MFA challenge and performs sign-in</p>
<p class="toc_element">
<code><a href="#start">start(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Sends the MFA challenge</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="finalize">finalize(body=None, x__xgafv=None)</code>
<pre>Verifies the MFA challenge and performs sign-in
Args:
body: object, The request body.
The object takes the form of:
{ # Finalizes sign-in by verifying MFA challenge.
"mfaEnrollmentId": "A String", # The MFA enrollment ID from the user's list of current MFA enrollments.
"mfaPendingCredential": "A String", # Required. Pending credential from first factor sign-in.
"phoneVerificationInfo": { # Phone Verification info for a FinalizeMfa request. # Proof of completion of the SMS based MFA challenge.
"androidVerificationProof": "A String", # Android only. Uses for "instant" phone number verification though GmsCore.
"code": "A String", # User-entered verification code.
"phoneNumber": "A String", # Required if Android verification proof is presented.
"sessionInfo": "A String", # An opaque string that represents the enrollment session.
},
"tenantId": "A 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.
"totpVerificationInfo": { # TOTP verification info for FinalizeMfaSignInRequest. # Proof of completion of the TOTP based MFA challenge.
"verificationCode": "A String", # User-entered verification code.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # FinalizeMfaSignIn response.
"idToken": "A String", # ID token for the authenticated user.
"phoneAuthInfo": { # Phone Verification info for a FinalizeMfa response. # Extra phone auth info, including android verification proof.
"androidVerificationProof": "A String", # Android only. Long-lived replacement for valid code tied to android device.
"androidVerificationProofExpireTime": "A String", # Android only. Expiration time of verification proof in seconds.
"phoneNumber": "A String", # For Android verification proof.
},
"refreshToken": "A String", # Refresh token for the authenticated user.
}</pre>
</div>
<div class="method">
<code class="details" id="start">start(body=None, x__xgafv=None)</code>
<pre>Sends the MFA challenge
Args:
body: object, The request body.
The object takes the form of:
{ # Starts multi-factor sign-in by sending the multi-factor auth challenge.
"mfaEnrollmentId": "A String", # Required. MFA enrollment id from the user's list of current MFA enrollments.
"mfaPendingCredential": "A String", # Required. Pending credential from first factor sign-in.
"phoneSignInInfo": { # App Verification info for a StartMfa request. # Verification info to authorize sending an SMS for phone verification.
"autoRetrievalInfo": { # The information required to auto-retrieve an SMS. # Android only. Used by Google Play Services to identify the app for auto-retrieval.
"appSignatureHash": "A String", # The Android app's signature hash for Google Play Service's SMS Retriever API.
},
"captchaResponse": "A String", # The reCAPTCHA Enterprise token provided by the reCAPTCHA client-side integration. Required when reCAPTCHA enterprise is enabled.
"clientType": "A String", # The client type, web, android or ios. Required when reCAPTCHA Enterprise is enabled.
"iosReceipt": "A String", # iOS only. Receipt of successful app token validation with APNS.
"iosSecret": "A String", # iOS only. Secret delivered to iOS app via APNS.
"phoneNumber": "A String", # Required for enrollment. Phone number to be enrolled as MFA.
"playIntegrityToken": "A String", # Android only. Used to assert application identity in place of a recaptcha token (or safety net token). A Play Integrity Token can be generated via the [PlayIntegrity API] (https://developer.android.com/google/play/integrity) with applying SHA256 to the `phone_number` field as the nonce.
"recaptchaToken": "A String", # Web only. Recaptcha solution.
"recaptchaVersion": "A String", # The reCAPTCHA version of the reCAPTCHA token in the captcha_response. Required when reCAPTCHA Enterprise is enabled.
"safetyNetToken": "A String", # Android only. Used to assert application identity in place of a recaptcha token. A SafetyNet Token can be generated via the [SafetyNet Android Attestation API](https://developer.android.com/training/safetynet/attestation.html), with the Base64 encoding of the `phone_number` field as the nonce.
},
"tenantId": "A 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.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # StartMfaSignIn response.
"phoneResponseInfo": { # Phone Verification info for a StartMfa response. # MultiFactor sign-in session information specific to SMS-type second factors. Along with the one-time code retrieved from the sent SMS, the contents of this session information should be passed to FinalizeMfaSignIn to complete the sign in.
"sessionInfo": "A String", # An opaque string that represents the enrollment session.
},
}</pre>
</div>
</body></html>
|
