Close httplib2 connections.
finalize(body=None, x__xgafv=None)
Verifies the MFA challenge and performs sign-in
start(body=None, x__xgafv=None)
Sends the MFA challenge
close()
Close httplib2 connections.
finalize(body=None, x__xgafv=None)
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.
}
start(body=None, x__xgafv=None)
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.
},
}