Package google.cloud.identitytoolkit.v2alpha1

Index

• AccountManagementService (interface)
• AuthenticationV2Alpha1Service (interface)
• AutoRetrievalInfo (message)
• FinalizeMfaEnrollmentRequest (message)
• FinalizeMfaEnrollmentResponse (message)
• FinalizeMfaPhoneRequestInfo (message)
• FinalizeMfaPhoneResponseInfo (message)
• FinalizeMfaSignInRequest (message)
• FinalizeMfaSignInResponse (message)
• MfaProvider (enum)
• StartMfaEnrollmentRequest (message)
• StartMfaEnrollmentResponse (message)
• StartMfaPhoneRequestInfo (message)
• StartMfaPhoneResponseInfo (message)
• StartMfaSignInRequest (message)
• StartMfaSignInResponse (message)
• WithdrawMfaRequest (message)
• WithdrawMfaResponse (message)

AccountManagementService

Account management for Identity Toolkit

FinalizeMfaEnrollment

rpc FinalizeMfaEnrollment(FinalizeMfaEnrollmentRequest) returns (FinalizeMfaEnrollmentResponse) Finishes enrolling a phone number as a MFA factor for the user. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

StartMfaEnrollment
rpc StartMfaEnrollment(StartMfaEnrollmentRequest) returns (StartMfaEnrollmentResponse) Sends MFA enrollment verification SMS for a user. Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

WithdrawMfa
rpc WithdrawMfa(WithdrawMfaRequest) returns (WithdrawMfaResponse) Revokes one MFA for user Authorization scopes Requires one of the following OAuth scopes: https://www.googleapis.com/auth/identitytoolkit https://www.googleapis.com/auth/firebase https://www.googleapis.com/auth/cloud-platform For more information, see the Authentication Overview.

AuthenticationV2Alpha1Service

Authentication for Identity Toolkit

FinalizeMfaSignIn
rpc FinalizeMfaSignIn(FinalizeMfaSignInRequest) returns (FinalizeMfaSignInResponse) Verifies the MultiFactorAuth challenge and performs MultiFactorAuth sign-in

StartMfaSignIn
rpc StartMfaSignIn(StartMfaSignInRequest) returns (StartMfaSignInResponse) Sends the MultiFactorAuth challenge

AutoRetrievalInfo

The information required to auto-retrieve an SMS.

Fields
app_signature_hash	string The Android app's signature hash for Google Play Service's SMS Retriever API.

FinalizeMfaEnrollmentRequest

Finishes enrolling a phone number as a MFA factor for the user.

Fields
id_token	string Required. Firebase first factor ID token to indicate authenticated user.
mfa_provider	MfaProvider Required. Type of 2nd factor.
display_name	string Display name which is entered by users to distinguish between differet multi-factors with same type or different type.
Union field verification_info. Required. MultiFactor enrollment information to be verified. verification_info can be only one of the following:
phone_verification_info	FinalizeMfaPhoneRequestInfo Verification info specific to phone auth.

FinalizeMfaEnrollmentResponse

FinalizeMfaEnrollment response.

Fields
id_token	string Firebase ID token for MFA user.
refresh_token	string Refresh token for MFA user to get MFA id token.
Union field auxiliary_auth_info. MultiFactor verified enrollment information. auxiliary_auth_info can be only one of the following:
phone_auth_info	FinalizeMfaPhoneResponseInfo Auxiliary auth info specific to phone auth.

FinalizeMfaPhoneRequestInfo

Mfa request info specific to phone auth.

Fields
session_info	string An opaque string that represents the enrollment session.
code	string User-entered verification code.
android_verification_proof	string Android only. Uses for "instant" phone number verification though GmsCore.
phone_number	string Required if Android verification proof is presented.

FinalizeMfaPhoneResponseInfo

Mfa response info specific to phone auth.

Fields
android_verification_proof	string Android only. Long-lived replacement for valid code tied to android device.
android_verification_proof_expire_time	Timestamp Android only. Expiration time of verification proof in seconds.
phone_number	string For Android verification proof.

FinalizeMfaSignInRequest

Finalizes multi-factor sign-in by verifying multi-factor auth challenge.

Fields
mfa_provider	MfaProvider Required. Type of 2nd factor.
mfa_pending_credential	string Required. Pending credential from MFA first factor sign-in.
Union field verification_info. Required for one of the verification info. MultiFactor enrollment information to be verified. verification_info can be only one of the following:
phone_verification_info	FinalizeMfaPhoneRequestInfo Verification info specific to phone auth.

FinalizeMfaSignInResponse

FinalizeMfaSignIn response.

Fields
id_token	string Firebase ID token for MFA user.
refresh_token	string Refresh token for MFA user to get MFA id token.
Union field auxiliary_auth_info. MultiFactor verified sign-in information. auxiliary_auth_info can be only one of the following:
phone_auth_info	FinalizeMfaPhoneResponseInfo Auxiliary auth info specific to phone auth.

MfaProvider

The type of auth to use for mfa.

Enums
MFA_PROVIDER_UNSPECIFIED	Default value. Do not use.
PHONE_SMS	Phone authentication.

StartMfaEnrollmentRequest

Sends MFA enrollment verification SMS for a user.

Fields
id_token	string Required. Firebase first factor ID token to indicate authenticated user.
mfa_provider	MfaProvider Required. Type of 2nd factor.
Union field enrollment_info. Required. MultiFactor information by type of 2nd factor. enrollment_info can be only one of the following:
phone_enrollment_info	StartMfaPhoneRequestInfo Sign in info specific to phone auth.

StartMfaEnrollmentResponse

StartMfaEnrollment response.

Fields
Union field enrollment_response. MultiFactor start enrollment response by 2nd factor type. enrollment_response can be only one of the following:
phone_session_info	StartMfaPhoneResponseInfo Enrollment response info specific to phone auth.

StartMfaPhoneRequestInfo

Mfa request info specific to phone auth.

Fields
phone_number	string Required for enrollment. Phone number to be enrolled as MFA.
ios_receipt	string iOS only. Receipt of successful app token validation with APNS.
ios_secret	string iOS only. Secret delivered to iOS app via APNS.
recaptcha_token	string Web only. Recaptcha solution.
auto_retrieval_info	AutoRetrievalInfo Android only. Used by Google Play Services to identify the app for auto-retrieval.
safety_net_token	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, with the Base64 encoding of the phone_number field as the nonce.

StartMfaPhoneResponseInfo

Mfa response info specific to phone auth.

Fields
session_info	string An opaque string that represents the enrollment session.

StartMfaSignInRequest

Starts multi-factor sign-in by sending the multi-factor auth challenge.

Fields
mfa_provider	MfaProvider Required. Type of multi-factor.
mfa_pending_credential	string Required. Pending credential from MFA first factor sign-in.
mfa_enrollment_id	string Required. MFA enrollment id from first factor sign-in.
Union field sign_in_info. Required for one of the phone sign-in info. MultiFactor information by type of 2nd factor. sign_in_info can be only one of the following:
phone_sign_in_info	StartMfaPhoneRequestInfo Sign in info specific to phone auth.

StartMfaSignInResponse

StartMfaSignIn response.

Fields
Union field response_info. MultiFactor start sign-in response by 2nd factor type. response_info can be only one of the following:
phone_response_info	StartMfaPhoneResponseInfo Response info specific to phone auth.

WithdrawMfaRequest

Withdraws MultiFactorAuth.

Fields
id_token	string Required. Firebase MFA ID token to indicate authenticated user.
mfa_enrollment_id	string Required. MFA enrollment id from verified MFA list from GetAccountInfo.

WithdrawMfaResponse

Withdraws MultiFactorAuth response.

Fields
id_token	string Firebase ID token for first sign-in factor.
refresh_token	string Firebase refresh token for first sign-in factor.