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
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
<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.mfaEnrollment.html">mfaEnrollment</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">Finishes enrolling a second factor for the user.</p>
<p class="toc_element">
<code><a href="#start">start(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Step one of the MFA enrollment process. In SMS case, this sends an SMS verification code to the user.</p>
<p class="toc_element">
<code><a href="#withdraw">withdraw(body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Revokes one second factor from the enrolled second factors for an account.</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>Finishes enrolling a second factor for the user.
Args:
body: object, The request body.
The object takes the form of:
{ # Finishes enrolling a second factor for the user.
"displayName": "A String", # Display name which is entered by users to distinguish between different second factors with same type or different type.
"idToken": "A String", # Required. ID token.
"phoneVerificationInfo": { # Phone Verification info for a FinalizeMfa request. # Verification info to authorize sending an SMS for phone verification.
"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 that the user enrolling MFA belongs to. If not set, the user belongs to the default Identity Platform project.
"totpVerificationInfo": { # Mfa request info specific to TOTP auth for FinalizeMfa. # Verification information for TOTP.
"sessionInfo": "A String", # An opaque string that represents the enrollment session.
"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:
{ # FinalizeMfaEnrollment response.
"idToken": "A String", # ID token updated to reflect MFA enrollment.
"phoneAuthInfo": { # Phone Verification info for a FinalizeMfa response. # Auxiliary auth info specific to phone auth.
"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 updated to reflect MFA enrollment.
"totpAuthInfo": { # Mfa response info specific to TOTP auth for FinalizeMfa. # Auxiliary auth info specific to TOTP auth.
},
}</pre>
</div>
<div class="method">
<code class="details" id="start">start(body=None, x__xgafv=None)</code>
<pre>Step one of the MFA enrollment process. In SMS case, this sends an SMS verification code to the user.
Args:
body: object, The request body.
The object takes the form of:
{ # Sends MFA enrollment verification SMS for a user.
"idToken": "A String", # Required. User's ID token.
"phoneEnrollmentInfo": { # 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 that the user enrolling MFA belongs to. If not set, the user belongs to the default Identity Platform project.
"totpEnrollmentInfo": { # Mfa request info specific to TOTP auth for StartMfa. # Sign-in info specific to TOTP auth.
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # StartMfaEnrollment response.
"phoneSessionInfo": { # Phone Verification info for a StartMfa response. # Verification info to authorize sending an SMS for phone verification.
"sessionInfo": "A String", # An opaque string that represents the enrollment session.
},
"totpSessionInfo": { # Mfa response info specific to TOTP auth for StartMfa. # Enrollment response info specific to TOTP auth.
"finalizeEnrollmentTime": "A String", # The time by which the enrollment must finish.
"hashingAlgorithm": "A String", # The hashing algorithm used to generate the verification code.
"periodSec": 42, # Duration in seconds at which the verification code will change.
"sessionInfo": "A String", # An encoded string that represents the enrollment session.
"sharedSecretKey": "A String", # A base 32 encoded string that represents the shared TOTP secret. The base 32 encoding is the one specified by [RFC4648#section-6](https://datatracker.ietf.org/doc/html/rfc4648#section-6). (This is the same as the base 32 encoding from [RFC3548#section-5](https://datatracker.ietf.org/doc/html/rfc3548#section-5).)
"verificationCodeLength": 42, # The length of the verification code that needs to be generated.
},
}</pre>
</div>
<div class="method">
<code class="details" id="withdraw">withdraw(body=None, x__xgafv=None)</code>
<pre>Revokes one second factor from the enrolled second factors for an account.
Args:
body: object, The request body.
The object takes the form of:
{ # Withdraws MFA.
"idToken": "A String", # Required. User's ID token.
"mfaEnrollmentId": "A String", # Required. MFA enrollment id from a current MFA enrollment.
"tenantId": "A String", # The ID of the Identity Platform tenant that the user unenrolling MFA belongs to. If not set, the user belongs 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:
{ # Withdraws MultiFactorAuth response.
"idToken": "A String", # ID token updated to reflect removal of the second factor.
"refreshToken": "A String", # Refresh token updated to reflect removal of the second factor.
}</pre>
</div>
</body></html>
|
