- HTTP request
- Request body
- Response body
- Authorization scopes
- FinalizeMfaTotpEnrollmentRequestInfo
- FinalizeMfaTotpEnrollmentResponseInfo
- Try it!
Finishes enrolling a second factor for the user.
HTTP request
POST https://identitytoolkit.googleapis.com/v2/accounts/mfaEnrollment:finalize
The URL uses gRPC Transcoding syntax.
Request body
The request body contains data with the following structure:
| JSON representation |
|---|
{ "idToken" : string , "displayName" : string , "tenantId" : string , // Union field |
idToken
string
Required. ID token.
displayName
string
Display name which is entered by users to distinguish between different second factors with same type or different type.
tenantId
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.
verification_info
. MFA enrollment information to be verified. verification_info
can be only one of the following:phoneVerificationInfo
object (
FinalizeMfaPhoneRequestInfo
)
Verification info to authorize sending an SMS for phone verification.
totpVerificationInfo
object (
FinalizeMfaTotpEnrollmentRequestInfo
)
Verification information for TOTP.
Response body
mfaEnrollment.finalize response.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{ "idToken" : string , "refreshToken" : string , // Union field |
idToken
string
ID token updated to reflect MFA enrollment.
refreshToken
string
Refresh token updated to reflect MFA enrollment.
auxiliary_auth_info
. MFA verified enrollment information. auxiliary_auth_info
can be only one of the following:phoneAuthInfo
object (
FinalizeMfaPhoneResponseInfo
)
Auxiliary auth info specific to phone auth.
totpAuthInfo
object (
FinalizeMfaTotpEnrollmentResponseInfo
)
Auxiliary auth info specific to TOTP auth.
Authorization scopes
Requires one of the following OAuth scopes:
-
https://www.googleapis.com/auth/identitytoolkit -
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview .
FinalizeMfaTotpEnrollmentRequestInfo
Mfa request info specific to TOTP auth for FinalizeMfa.
| JSON representation |
|---|
{ "sessionInfo" : string , "verificationCode" : string } |
| Fields | |
|---|---|
sessionInfo
|
An opaque string that represents the enrollment session. |
verificationCode
|
User-entered verification code. |
FinalizeMfaTotpEnrollmentResponseInfo
This type has no fields.
Mfa response info specific to TOTP auth for FinalizeMfa.
