Identity Toolkit API v2 - Package cloud.google.com/go/identitytoolkit/apiv2/identitytoolkitpb (v0.6.0)

0.6.0 (latest) 0.5.0 0.4.0 0.3.0 0.2.6 0.1.4

Note: To get more information about this package, such as access to older versions, view this package on pkg.go.dev.

Constants

AccountManagementService_FinalizeMfaEnrollment_FullMethodName, AccountManagementService_StartMfaEnrollment_FullMethodName, AccountManagementService_WithdrawMfa_FullMethodName

const (
	AccountManagementService_FinalizeMfaEnrollment_FullMethodName = "/google.cloud.identitytoolkit.v2.AccountManagementService/FinalizeMfaEnrollment"
	AccountManagementService_StartMfaEnrollment_FullMethodName    = "/google.cloud.identitytoolkit.v2.AccountManagementService/StartMfaEnrollment"
	AccountManagementService_WithdrawMfa_FullMethodName           = "/google.cloud.identitytoolkit.v2.AccountManagementService/WithdrawMfa"
)

AuthenticationService_FinalizeMfaSignIn_FullMethodName, AuthenticationService_StartMfaSignIn_FullMethodName

const (
	AuthenticationService_FinalizeMfaSignIn_FullMethodName = "/google.cloud.identitytoolkit.v2.AuthenticationService/FinalizeMfaSignIn"
	AuthenticationService_StartMfaSignIn_FullMethodName    = "/google.cloud.identitytoolkit.v2.AuthenticationService/StartMfaSignIn"
)

Variables

AccountManagementService_ServiceDesc

var AccountManagementService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.identitytoolkit.v2.AccountManagementService",
	HandlerType: (*AccountManagementServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "FinalizeMfaEnrollment",
			Handler:    _AccountManagementService_FinalizeMfaEnrollment_Handler,
		},
		{
			MethodName: "StartMfaEnrollment",
			Handler:    _AccountManagementService_StartMfaEnrollment_Handler,
		},
		{
			MethodName: "WithdrawMfa",
			Handler:    _AccountManagementService_WithdrawMfa_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/identitytoolkit/v2/account_management_service.proto",
}

AccountManagementService_ServiceDesc is the grpc.ServiceDesc for AccountManagementService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

AuthenticationService_ServiceDesc

var AuthenticationService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "google.cloud.identitytoolkit.v2.AuthenticationService",
	HandlerType: (*AuthenticationServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "FinalizeMfaSignIn",
			Handler:    _AuthenticationService_FinalizeMfaSignIn_Handler,
		},
		{
			MethodName: "StartMfaSignIn",
			Handler:    _AuthenticationService_StartMfaSignIn_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "google/cloud/identitytoolkit/v2/authentication_service.proto",
}

AuthenticationService_ServiceDesc is the grpc.ServiceDesc for AuthenticationService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

File_google_cloud_identitytoolkit_v2_account_management_service_proto

var File_google_cloud_identitytoolkit_v2_account_management_service_proto protoreflect.FileDescriptor

File_google_cloud_identitytoolkit_v2_authentication_service_proto

var File_google_cloud_identitytoolkit_v2_authentication_service_proto protoreflect.FileDescriptor

File_google_cloud_identitytoolkit_v2_mfa_info_proto

var File_google_cloud_identitytoolkit_v2_mfa_info_proto protoreflect.FileDescriptor

Functions

func RegisterAccountManagementServiceServer

func RegisterAccountManagementServiceServer(s grpc.ServiceRegistrar, srv AccountManagementServiceServer)

func RegisterAuthenticationServiceServer

func RegisterAuthenticationServiceServer(s grpc.ServiceRegistrar, srv AuthenticationServiceServer)

AccountManagementServiceClient

type AccountManagementServiceClient interface {
	// Finishes enrolling a second factor for the user.
	FinalizeMfaEnrollment(ctx context.Context, in *FinalizeMfaEnrollmentRequest, opts ...grpc.CallOption) (*FinalizeMfaEnrollmentResponse, error)
	// Step one of the MFA enrollment process. In SMS case, this sends an
	// SMS verification code to the user.
	StartMfaEnrollment(ctx context.Context, in *StartMfaEnrollmentRequest, opts ...grpc.CallOption) (*StartMfaEnrollmentResponse, error)
	// Revokes one second factor from the enrolled second factors for an account.
	WithdrawMfa(ctx context.Context, in *WithdrawMfaRequest, opts ...grpc.CallOption) (*WithdrawMfaResponse, error)
}

AccountManagementServiceClient is the client API for AccountManagementService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewAccountManagementServiceClient

func NewAccountManagementServiceClient(cc grpc.ClientConnInterface) AccountManagementServiceClient

AccountManagementServiceServer

type AccountManagementServiceServer interface {
	// Finishes enrolling a second factor for the user.
	FinalizeMfaEnrollment(context.Context, *FinalizeMfaEnrollmentRequest) (*FinalizeMfaEnrollmentResponse, error)
	// Step one of the MFA enrollment process. In SMS case, this sends an
	// SMS verification code to the user.
	StartMfaEnrollment(context.Context, *StartMfaEnrollmentRequest) (*StartMfaEnrollmentResponse, error)
	// Revokes one second factor from the enrolled second factors for an account.
	WithdrawMfa(context.Context, *WithdrawMfaRequest) (*WithdrawMfaResponse, error)
}

AccountManagementServiceServer is the server API for AccountManagementService service. All implementations should embed UnimplementedAccountManagementServiceServer for forward compatibility

AuthenticationServiceClient

type AuthenticationServiceClient interface {
	// Verifies the MFA challenge and performs sign-in
	FinalizeMfaSignIn(ctx context.Context, in *FinalizeMfaSignInRequest, opts ...grpc.CallOption) (*FinalizeMfaSignInResponse, error)
	// Sends the MFA challenge
	StartMfaSignIn(ctx context.Context, in *StartMfaSignInRequest, opts ...grpc.CallOption) (*StartMfaSignInResponse, error)
}

AuthenticationServiceClient is the client API for AuthenticationService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewAuthenticationServiceClient

func NewAuthenticationServiceClient(cc grpc.ClientConnInterface) AuthenticationServiceClient

AuthenticationServiceServer

type AuthenticationServiceServer interface {
	// Verifies the MFA challenge and performs sign-in
	FinalizeMfaSignIn(context.Context, *FinalizeMfaSignInRequest) (*FinalizeMfaSignInResponse, error)
	// Sends the MFA challenge
	StartMfaSignIn(context.Context, *StartMfaSignInRequest) (*StartMfaSignInResponse, error)
}

AuthenticationServiceServer is the server API for AuthenticationService service. All implementations should embed UnimplementedAuthenticationServiceServer for forward compatibility

AutoRetrievalInfo

type AutoRetrievalInfo struct {

	// The Android app's signature hash for Google Play Service's
	// SMS Retriever API.
	AppSignatureHash string `protobuf:"bytes,1,opt,name=app_signature_hash,json=appSignatureHash,proto3" json:"app_signature_hash,omitempty"`
	// contains filtered or unexported fields
}

The information required to auto-retrieve an SMS.

func (*AutoRetrievalInfo) Descriptor

func (*AutoRetrievalInfo) Descriptor() ([]byte, []int)

Deprecated: Use AutoRetrievalInfo.ProtoReflect.Descriptor instead.

func (*AutoRetrievalInfo) GetAppSignatureHash

func (x *AutoRetrievalInfo) GetAppSignatureHash() string

func (*AutoRetrievalInfo) ProtoMessage

func (*AutoRetrievalInfo) ProtoMessage()

func (*AutoRetrievalInfo) ProtoReflect

func (x *AutoRetrievalInfo) ProtoReflect() protoreflect.Message

func (*AutoRetrievalInfo) Reset

func (x *AutoRetrievalInfo) Reset()

func (*AutoRetrievalInfo) String

func (x *AutoRetrievalInfo) String() string

FinalizeMfaEnrollmentRequest

type FinalizeMfaEnrollmentRequest struct {

	// Required. ID token.
	IdToken string `protobuf:"bytes,1,opt,name=id_token,json=idToken,proto3" json:"id_token,omitempty"`
	// Display name which is entered  by users to distinguish between different
	// second factors with same type or different type.
	DisplayName string `protobuf:"bytes,3,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// MFA enrollment information to be verified.
	//
	// Types that are valid to be assigned to VerificationInfo:
	//
	//	*FinalizeMfaEnrollmentRequest_PhoneVerificationInfo
	VerificationInfo isFinalizeMfaEnrollmentRequest_VerificationInfo `protobuf_oneof:"verification_info"`
	// 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.
	TenantId string `protobuf:"bytes,5,opt,name=tenant_id,json=tenantId,proto3" json:"tenant_id,omitempty"`
	// contains filtered or unexported fields
}

Finishes enrolling a second factor for the user.

func (*FinalizeMfaEnrollmentRequest) Descriptor

func (*FinalizeMfaEnrollmentRequest) Descriptor() ([]byte, []int)

Deprecated: Use FinalizeMfaEnrollmentRequest.ProtoReflect.Descriptor instead.

func (*FinalizeMfaEnrollmentRequest) GetDisplayName

func (x *FinalizeMfaEnrollmentRequest) GetDisplayName() string

func (*FinalizeMfaEnrollmentRequest) GetIdToken

func (x *FinalizeMfaEnrollmentRequest) GetIdToken() string

func (*FinalizeMfaEnrollmentRequest) GetPhoneVerificationInfo

func (x *FinalizeMfaEnrollmentRequest) GetPhoneVerificationInfo() *FinalizeMfaPhoneRequestInfo

func (*FinalizeMfaEnrollmentRequest) GetTenantId

func (x *FinalizeMfaEnrollmentRequest) GetTenantId() string

func (*FinalizeMfaEnrollmentRequest) GetVerificationInfo

func (x *FinalizeMfaEnrollmentRequest) GetVerificationInfo() isFinalizeMfaEnrollmentRequest_VerificationInfo

func (*FinalizeMfaEnrollmentRequest) ProtoMessage

func (*FinalizeMfaEnrollmentRequest) ProtoMessage()

func (*FinalizeMfaEnrollmentRequest) ProtoReflect

func (x *FinalizeMfaEnrollmentRequest) ProtoReflect() protoreflect.Message

func (*FinalizeMfaEnrollmentRequest) Reset

func (x *FinalizeMfaEnrollmentRequest) Reset()

func (*FinalizeMfaEnrollmentRequest) String

func (x *FinalizeMfaEnrollmentRequest) String() string

FinalizeMfaEnrollmentRequest_PhoneVerificationInfo

type FinalizeMfaEnrollmentRequest_PhoneVerificationInfo struct {
	// Verification info to authorize sending an SMS for phone verification.
	PhoneVerificationInfo *FinalizeMfaPhoneRequestInfo `protobuf:"bytes,4,opt,name=phone_verification_info,json=phoneVerificationInfo,proto3,oneof"`
}

FinalizeMfaEnrollmentResponse

type FinalizeMfaEnrollmentResponse struct {

	// ID token updated to reflect MFA enrollment.
	IdToken string `protobuf:"bytes,1,opt,name=id_token,json=idToken,proto3" json:"id_token,omitempty"`
	// Refresh token updated to reflect MFA enrollment.
	RefreshToken string `protobuf:"bytes,2,opt,name=refresh_token,json=refreshToken,proto3" json:"refresh_token,omitempty"`
	// MFA verified enrollment information.
	//
	// Types that are valid to be assigned to AuxiliaryAuthInfo:
	//
	//	*FinalizeMfaEnrollmentResponse_PhoneAuthInfo
	AuxiliaryAuthInfo isFinalizeMfaEnrollmentResponse_AuxiliaryAuthInfo `protobuf_oneof:"auxiliary_auth_info"`
	// contains filtered or unexported fields
}

FinalizeMfaEnrollment response.

func (*FinalizeMfaEnrollmentResponse) Descriptor

func (*FinalizeMfaEnrollmentResponse) Descriptor() ([]byte, []int)

Deprecated: Use FinalizeMfaEnrollmentResponse.ProtoReflect.Descriptor instead.

func (*FinalizeMfaEnrollmentResponse) GetAuxiliaryAuthInfo

func (x *FinalizeMfaEnrollmentResponse) GetAuxiliaryAuthInfo() isFinalizeMfaEnrollmentResponse_AuxiliaryAuthInfo

func (*FinalizeMfaEnrollmentResponse) GetIdToken

func (x *FinalizeMfaEnrollmentResponse) GetIdToken() string

func (*FinalizeMfaEnrollmentResponse) GetPhoneAuthInfo

func (x *FinalizeMfaEnrollmentResponse) GetPhoneAuthInfo() *FinalizeMfaPhoneResponseInfo

func (*FinalizeMfaEnrollmentResponse) GetRefreshToken

func (x *FinalizeMfaEnrollmentResponse) GetRefreshToken() string

func (*FinalizeMfaEnrollmentResponse) ProtoMessage

func (*FinalizeMfaEnrollmentResponse) ProtoMessage()

func (*FinalizeMfaEnrollmentResponse) ProtoReflect

func (x *FinalizeMfaEnrollmentResponse) ProtoReflect() protoreflect.Message

func (*FinalizeMfaEnrollmentResponse) Reset

func (x *FinalizeMfaEnrollmentResponse) Reset()

func (*FinalizeMfaEnrollmentResponse) String

func (x *FinalizeMfaEnrollmentResponse) String() string

FinalizeMfaEnrollmentResponse_PhoneAuthInfo

type FinalizeMfaEnrollmentResponse_PhoneAuthInfo struct {
	// Auxiliary auth info specific to phone auth.
	PhoneAuthInfo *FinalizeMfaPhoneResponseInfo `protobuf:"bytes,3,opt,name=phone_auth_info,json=phoneAuthInfo,proto3,oneof"`
}

FinalizeMfaPhoneRequestInfo

type FinalizeMfaPhoneRequestInfo struct {

	// An opaque string that represents the enrollment session.
	SessionInfo string `protobuf:"bytes,1,opt,name=session_info,json=sessionInfo,proto3" json:"session_info,omitempty"`
	// User-entered verification code.
	Code string `protobuf:"bytes,2,opt,name=code,proto3" json:"code,omitempty"`
	// Android only. Uses for "instant" phone number verification though GmsCore.
	AndroidVerificationProof string `protobuf:"bytes,3,opt,name=android_verification_proof,json=androidVerificationProof,proto3" json:"android_verification_proof,omitempty"`
	// Required if Android verification proof is presented.
	PhoneNumber string `protobuf:"bytes,4,opt,name=phone_number,json=phoneNumber,proto3" json:"phone_number,omitempty"`
	// contains filtered or unexported fields
}

Phone Verification info for a FinalizeMfa request.

func (*FinalizeMfaPhoneRequestInfo) Descriptor

func (*FinalizeMfaPhoneRequestInfo) Descriptor() ([]byte, []int)

Deprecated: Use FinalizeMfaPhoneRequestInfo.ProtoReflect.Descriptor instead.

func (*FinalizeMfaPhoneRequestInfo) GetAndroidVerificationProof

func (x *FinalizeMfaPhoneRequestInfo) GetAndroidVerificationProof() string

func (*FinalizeMfaPhoneRequestInfo) GetCode

func (x *FinalizeMfaPhoneRequestInfo) GetCode() string

func (*FinalizeMfaPhoneRequestInfo) GetPhoneNumber

func (x *FinalizeMfaPhoneRequestInfo) GetPhoneNumber() string

func (*FinalizeMfaPhoneRequestInfo) GetSessionInfo

func (x *FinalizeMfaPhoneRequestInfo) GetSessionInfo() string

func (*FinalizeMfaPhoneRequestInfo) ProtoMessage

func (*FinalizeMfaPhoneRequestInfo) ProtoMessage()

func (*FinalizeMfaPhoneRequestInfo) ProtoReflect

func (x *FinalizeMfaPhoneRequestInfo) ProtoReflect() protoreflect.Message

func (*FinalizeMfaPhoneRequestInfo) Reset

func (x *FinalizeMfaPhoneRequestInfo) Reset()

func (*FinalizeMfaPhoneRequestInfo) String

func (x *FinalizeMfaPhoneRequestInfo) String() string

FinalizeMfaPhoneResponseInfo

type FinalizeMfaPhoneResponseInfo struct {

	// Android only. Long-lived replacement for valid code tied to android device.
	AndroidVerificationProof string `protobuf:"bytes,1,opt,name=android_verification_proof,json=androidVerificationProof,proto3" json:"android_verification_proof,omitempty"`
	// Android only. Expiration time of verification proof in seconds.
	AndroidVerificationProofExpireTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=android_verification_proof_expire_time,json=androidVerificationProofExpireTime,proto3" json:"android_verification_proof_expire_time,omitempty"`
	// For Android verification proof.
	PhoneNumber string `protobuf:"bytes,3,opt,name=phone_number,json=phoneNumber,proto3" json:"phone_number,omitempty"`
	// contains filtered or unexported fields
}

Phone Verification info for a FinalizeMfa response.

func (*FinalizeMfaPhoneResponseInfo) Descriptor

func (*FinalizeMfaPhoneResponseInfo) Descriptor() ([]byte, []int)

Deprecated: Use FinalizeMfaPhoneResponseInfo.ProtoReflect.Descriptor instead.

func (*FinalizeMfaPhoneResponseInfo) GetAndroidVerificationProof

func (x *FinalizeMfaPhoneResponseInfo) GetAndroidVerificationProof() string

func (*FinalizeMfaPhoneResponseInfo) GetAndroidVerificationProofExpireTime

func (x *FinalizeMfaPhoneResponseInfo) GetAndroidVerificationProofExpireTime() *timestamppb.Timestamp

func (*FinalizeMfaPhoneResponseInfo) GetPhoneNumber

func (x *FinalizeMfaPhoneResponseInfo) GetPhoneNumber() string

func (*FinalizeMfaPhoneResponseInfo) ProtoMessage

func (*FinalizeMfaPhoneResponseInfo) ProtoMessage()

func (*FinalizeMfaPhoneResponseInfo) ProtoReflect

func (x *FinalizeMfaPhoneResponseInfo) ProtoReflect() protoreflect.Message

func (*FinalizeMfaPhoneResponseInfo) Reset

func (x *FinalizeMfaPhoneResponseInfo) Reset()

func (*FinalizeMfaPhoneResponseInfo) String

func (x *FinalizeMfaPhoneResponseInfo) String() string

FinalizeMfaSignInRequest

type FinalizeMfaSignInRequest struct {

	// Required. Pending credential from first factor sign-in.
	MfaPendingCredential string `protobuf:"bytes,2,opt,name=mfa_pending_credential,json=mfaPendingCredential,proto3" json:"mfa_pending_credential,omitempty"`
	// Proof of completion of the MFA challenge.
	//
	// Types that are valid to be assigned to VerificationInfo:
	//
	//	*FinalizeMfaSignInRequest_PhoneVerificationInfo
	VerificationInfo isFinalizeMfaSignInRequest_VerificationInfo `protobuf_oneof:"verification_info"`
	// 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.
	TenantId string `protobuf:"bytes,4,opt,name=tenant_id,json=tenantId,proto3" json:"tenant_id,omitempty"`
	// contains filtered or unexported fields
}

Finalizes sign-in by verifying MFA challenge.

func (*FinalizeMfaSignInRequest) Descriptor

func (*FinalizeMfaSignInRequest) Descriptor() ([]byte, []int)

Deprecated: Use FinalizeMfaSignInRequest.ProtoReflect.Descriptor instead.

func (*FinalizeMfaSignInRequest) GetMfaPendingCredential

func (x *FinalizeMfaSignInRequest) GetMfaPendingCredential() string

func (*FinalizeMfaSignInRequest) GetPhoneVerificationInfo

func (x *FinalizeMfaSignInRequest) GetPhoneVerificationInfo() *FinalizeMfaPhoneRequestInfo

func (*FinalizeMfaSignInRequest) GetTenantId

func (x *FinalizeMfaSignInRequest) GetTenantId() string

func (*FinalizeMfaSignInRequest) GetVerificationInfo

func (x *FinalizeMfaSignInRequest) GetVerificationInfo() isFinalizeMfaSignInRequest_VerificationInfo

func (*FinalizeMfaSignInRequest) ProtoMessage

func (*FinalizeMfaSignInRequest) ProtoMessage()

func (*FinalizeMfaSignInRequest) ProtoReflect

func (x *FinalizeMfaSignInRequest) ProtoReflect() protoreflect.Message

func (*FinalizeMfaSignInRequest) Reset

func (x *FinalizeMfaSignInRequest) Reset()

func (*FinalizeMfaSignInRequest) String

func (x *FinalizeMfaSignInRequest) String() string

FinalizeMfaSignInRequest_PhoneVerificationInfo

type FinalizeMfaSignInRequest_PhoneVerificationInfo struct {
	// Proof of completion of the SMS based MFA challenge.
	PhoneVerificationInfo *FinalizeMfaPhoneRequestInfo `protobuf:"bytes,3,opt,name=phone_verification_info,json=phoneVerificationInfo,proto3,oneof"`
}

FinalizeMfaSignInResponse

type FinalizeMfaSignInResponse struct {

	// ID token for the authenticated user.
	IdToken string `protobuf:"bytes,1,opt,name=id_token,json=idToken,proto3" json:"id_token,omitempty"`
	// Refresh token for the authenticated user.
	RefreshToken string `protobuf:"bytes,2,opt,name=refresh_token,json=refreshToken,proto3" json:"refresh_token,omitempty"`
	// MFA verified sign-in information.
	//
	// Types that are valid to be assigned to AuxiliaryAuthInfo:
	//
	//	*FinalizeMfaSignInResponse_PhoneAuthInfo
	AuxiliaryAuthInfo isFinalizeMfaSignInResponse_AuxiliaryAuthInfo `protobuf_oneof:"auxiliary_auth_info"`
	// contains filtered or unexported fields
}

FinalizeMfaSignIn response.

func (*FinalizeMfaSignInResponse) Descriptor

func (*FinalizeMfaSignInResponse) Descriptor() ([]byte, []int)

Deprecated: Use FinalizeMfaSignInResponse.ProtoReflect.Descriptor instead.

func (*FinalizeMfaSignInResponse) GetAuxiliaryAuthInfo

func (x *FinalizeMfaSignInResponse) GetAuxiliaryAuthInfo() isFinalizeMfaSignInResponse_AuxiliaryAuthInfo

func (*FinalizeMfaSignInResponse) GetIdToken

func (x *FinalizeMfaSignInResponse) GetIdToken() string

func (*FinalizeMfaSignInResponse) GetPhoneAuthInfo

func (x *FinalizeMfaSignInResponse) GetPhoneAuthInfo() *FinalizeMfaPhoneResponseInfo

func (*FinalizeMfaSignInResponse) GetRefreshToken

func (x *FinalizeMfaSignInResponse) GetRefreshToken() string

func (*FinalizeMfaSignInResponse) ProtoMessage

func (*FinalizeMfaSignInResponse) ProtoMessage()

func (*FinalizeMfaSignInResponse) ProtoReflect

func (x *FinalizeMfaSignInResponse) ProtoReflect() protoreflect.Message

func (*FinalizeMfaSignInResponse) Reset

func (x *FinalizeMfaSignInResponse) Reset()

func (*FinalizeMfaSignInResponse) String

func (x *FinalizeMfaSignInResponse) String() string

FinalizeMfaSignInResponse_PhoneAuthInfo

type FinalizeMfaSignInResponse_PhoneAuthInfo struct {
	// Extra phone auth info, including android verification proof.
	PhoneAuthInfo *FinalizeMfaPhoneResponseInfo `protobuf:"bytes,3,opt,name=phone_auth_info,json=phoneAuthInfo,proto3,oneof"`
}

StartMfaEnrollmentRequest

type StartMfaEnrollmentRequest struct {

	// Required. User's ID token.
	IdToken string `protobuf:"bytes,1,opt,name=id_token,json=idToken,proto3" json:"id_token,omitempty"`
	// MFA information by type of 2nd factor.
	//
	// Types that are valid to be assigned to EnrollmentInfo:
	//
	//	*StartMfaEnrollmentRequest_PhoneEnrollmentInfo
	EnrollmentInfo isStartMfaEnrollmentRequest_EnrollmentInfo `protobuf_oneof:"enrollment_info"`
	// 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.
	TenantId string `protobuf:"bytes,4,opt,name=tenant_id,json=tenantId,proto3" json:"tenant_id,omitempty"`
	// contains filtered or unexported fields
}

Sends MFA enrollment verification SMS for a user.

func (*StartMfaEnrollmentRequest) Descriptor

func (*StartMfaEnrollmentRequest) Descriptor() ([]byte, []int)

Deprecated: Use StartMfaEnrollmentRequest.ProtoReflect.Descriptor instead.

func (*StartMfaEnrollmentRequest) GetEnrollmentInfo

func (x *StartMfaEnrollmentRequest) GetEnrollmentInfo() isStartMfaEnrollmentRequest_EnrollmentInfo

func (*StartMfaEnrollmentRequest) GetIdToken

func (x *StartMfaEnrollmentRequest) GetIdToken() string

func (*StartMfaEnrollmentRequest) GetPhoneEnrollmentInfo

func (x *StartMfaEnrollmentRequest) GetPhoneEnrollmentInfo() *StartMfaPhoneRequestInfo

func (*StartMfaEnrollmentRequest) GetTenantId

func (x *StartMfaEnrollmentRequest) GetTenantId() string

func (*StartMfaEnrollmentRequest) ProtoMessage

func (*StartMfaEnrollmentRequest) ProtoMessage()

func (*StartMfaEnrollmentRequest) ProtoReflect

func (x *StartMfaEnrollmentRequest) ProtoReflect() protoreflect.Message

func (*StartMfaEnrollmentRequest) Reset

func (x *StartMfaEnrollmentRequest) Reset()

func (*StartMfaEnrollmentRequest) String

func (x *StartMfaEnrollmentRequest) String() string

StartMfaEnrollmentRequest_PhoneEnrollmentInfo

type StartMfaEnrollmentRequest_PhoneEnrollmentInfo struct {
	// Verification info to authorize sending an SMS for phone verification.
	PhoneEnrollmentInfo *StartMfaPhoneRequestInfo `protobuf:"bytes,3,opt,name=phone_enrollment_info,json=phoneEnrollmentInfo,proto3,oneof"`
}

StartMfaEnrollmentResponse

type StartMfaEnrollmentResponse struct {

	// MFA start enrollment response by 2nd factor type.
	//
	// Types that are valid to be assigned to EnrollmentResponse:
	//
	//	*StartMfaEnrollmentResponse_PhoneSessionInfo
	EnrollmentResponse isStartMfaEnrollmentResponse_EnrollmentResponse `protobuf_oneof:"enrollment_response"`
	// contains filtered or unexported fields
}

StartMfaEnrollment response.

func (*StartMfaEnrollmentResponse) Descriptor

func (*StartMfaEnrollmentResponse) Descriptor() ([]byte, []int)

Deprecated: Use StartMfaEnrollmentResponse.ProtoReflect.Descriptor instead.

func (*StartMfaEnrollmentResponse) GetEnrollmentResponse

func (x *StartMfaEnrollmentResponse) GetEnrollmentResponse() isStartMfaEnrollmentResponse_EnrollmentResponse

func (*StartMfaEnrollmentResponse) GetPhoneSessionInfo

func (x *StartMfaEnrollmentResponse) GetPhoneSessionInfo() *StartMfaPhoneResponseInfo

func (*StartMfaEnrollmentResponse) ProtoMessage

func (*StartMfaEnrollmentResponse) ProtoMessage()

func (*StartMfaEnrollmentResponse) ProtoReflect

func (x *StartMfaEnrollmentResponse) ProtoReflect() protoreflect.Message

func (*StartMfaEnrollmentResponse) Reset

func (x *StartMfaEnrollmentResponse) Reset()

func (*StartMfaEnrollmentResponse) String

func (x *StartMfaEnrollmentResponse) String() string

StartMfaEnrollmentResponse_PhoneSessionInfo

type StartMfaEnrollmentResponse_PhoneSessionInfo struct {
	// Verification info to authorize sending an SMS for phone verification.
	PhoneSessionInfo *StartMfaPhoneResponseInfo `protobuf:"bytes,1,opt,name=phone_session_info,json=phoneSessionInfo,proto3,oneof"`
}

StartMfaPhoneRequestInfo

type StartMfaPhoneRequestInfo struct {

	// Required for enrollment. Phone number to be enrolled as MFA.
	PhoneNumber string `protobuf:"bytes,1,opt,name=phone_number,json=phoneNumber,proto3" json:"phone_number,omitempty"`
	// iOS only. Receipt of successful app token validation with APNS.
	IosReceipt string `protobuf:"bytes,2,opt,name=ios_receipt,json=iosReceipt,proto3" json:"ios_receipt,omitempty"`
	// iOS only. Secret delivered to iOS app via APNS.
	IosSecret string `protobuf:"bytes,3,opt,name=ios_secret,json=iosSecret,proto3" json:"ios_secret,omitempty"`
	// Web only. Recaptcha solution.
	RecaptchaToken string `protobuf:"bytes,4,opt,name=recaptcha_token,json=recaptchaToken,proto3" json:"recaptcha_token,omitempty"`
	// Android only. Used by Google Play Services to identify the app for
	// auto-retrieval.
	AutoRetrievalInfo *AutoRetrievalInfo `protobuf:"bytes,5,opt,name=auto_retrieval_info,json=autoRetrievalInfo,proto3" json:"auto_retrieval_info,omitempty"`
	// 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.
	SafetyNetToken string `protobuf:"bytes,6,opt,name=safety_net_token,json=safetyNetToken,proto3" json:"safety_net_token,omitempty"`
	// contains filtered or unexported fields
}

App Verification info for a StartMfa request.

func (*StartMfaPhoneRequestInfo) Descriptor

func (*StartMfaPhoneRequestInfo) Descriptor() ([]byte, []int)

Deprecated: Use StartMfaPhoneRequestInfo.ProtoReflect.Descriptor instead.

func (*StartMfaPhoneRequestInfo) GetAutoRetrievalInfo

func (x *StartMfaPhoneRequestInfo) GetAutoRetrievalInfo() *AutoRetrievalInfo

func (*StartMfaPhoneRequestInfo) GetIosReceipt

func (x *StartMfaPhoneRequestInfo) GetIosReceipt() string

func (*StartMfaPhoneRequestInfo) GetIosSecret

func (x *StartMfaPhoneRequestInfo) GetIosSecret() string

func (*StartMfaPhoneRequestInfo) GetPhoneNumber

func (x *StartMfaPhoneRequestInfo) GetPhoneNumber() string

func (*StartMfaPhoneRequestInfo) GetRecaptchaToken

func (x *StartMfaPhoneRequestInfo) GetRecaptchaToken() string

func (*StartMfaPhoneRequestInfo) GetSafetyNetToken

func (x *StartMfaPhoneRequestInfo) GetSafetyNetToken() string

func (*StartMfaPhoneRequestInfo) ProtoMessage

func (*StartMfaPhoneRequestInfo) ProtoMessage()

func (*StartMfaPhoneRequestInfo) ProtoReflect

func (x *StartMfaPhoneRequestInfo) ProtoReflect() protoreflect.Message

func (*StartMfaPhoneRequestInfo) Reset

func (x *StartMfaPhoneRequestInfo) Reset()

func (*StartMfaPhoneRequestInfo) String

func (x *StartMfaPhoneRequestInfo) String() string

StartMfaPhoneResponseInfo

type StartMfaPhoneResponseInfo struct {

	// An opaque string that represents the enrollment session.
	SessionInfo string `protobuf:"bytes,1,opt,name=session_info,json=sessionInfo,proto3" json:"session_info,omitempty"`
	// contains filtered or unexported fields
}

Phone Verification info for a StartMfa response.

func (*StartMfaPhoneResponseInfo) Descriptor

func (*StartMfaPhoneResponseInfo) Descriptor() ([]byte, []int)

Deprecated: Use StartMfaPhoneResponseInfo.ProtoReflect.Descriptor instead.

func (*StartMfaPhoneResponseInfo) GetSessionInfo

func (x *StartMfaPhoneResponseInfo) GetSessionInfo() string

func (*StartMfaPhoneResponseInfo) ProtoMessage

func (*StartMfaPhoneResponseInfo) ProtoMessage()

func (*StartMfaPhoneResponseInfo) ProtoReflect

func (x *StartMfaPhoneResponseInfo) ProtoReflect() protoreflect.Message

func (*StartMfaPhoneResponseInfo) Reset

func (x *StartMfaPhoneResponseInfo) Reset()

func (*StartMfaPhoneResponseInfo) String

func (x *StartMfaPhoneResponseInfo) String() string

StartMfaSignInRequest

type StartMfaSignInRequest struct {

	// Required. Pending credential from first factor sign-in.
	MfaPendingCredential string `protobuf:"bytes,2,opt,name=mfa_pending_credential,json=mfaPendingCredential,proto3" json:"mfa_pending_credential,omitempty"`
	// Required. MFA enrollment id from the user's list of current MFA enrollments.
	MfaEnrollmentId string `protobuf:"bytes,3,opt,name=mfa_enrollment_id,json=mfaEnrollmentId,proto3" json:"mfa_enrollment_id,omitempty"`
	// MFA information by type of 2nd factor.
	//
	// Types that are valid to be assigned to SignInInfo:
	//
	//	*StartMfaSignInRequest_PhoneSignInInfo
	SignInInfo isStartMfaSignInRequest_SignInInfo `protobuf_oneof:"sign_in_info"`
	// 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.
	TenantId string `protobuf:"bytes,5,opt,name=tenant_id,json=tenantId,proto3" json:"tenant_id,omitempty"`
	// contains filtered or unexported fields
}

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

func (*StartMfaSignInRequest) Descriptor

func (*StartMfaSignInRequest) Descriptor() ([]byte, []int)

Deprecated: Use StartMfaSignInRequest.ProtoReflect.Descriptor instead.

func (*StartMfaSignInRequest) GetMfaEnrollmentId

func (x *StartMfaSignInRequest) GetMfaEnrollmentId() string

func (*StartMfaSignInRequest) GetMfaPendingCredential

func (x *StartMfaSignInRequest) GetMfaPendingCredential() string

func (*StartMfaSignInRequest) GetPhoneSignInInfo

func (x *StartMfaSignInRequest) GetPhoneSignInInfo() *StartMfaPhoneRequestInfo

func (*StartMfaSignInRequest) GetSignInInfo

func (x *StartMfaSignInRequest) GetSignInInfo() isStartMfaSignInRequest_SignInInfo

func (*StartMfaSignInRequest) GetTenantId

func (x *StartMfaSignInRequest) GetTenantId() string

func (*StartMfaSignInRequest) ProtoMessage

func (*StartMfaSignInRequest) ProtoMessage()

func (*StartMfaSignInRequest) ProtoReflect

func (x *StartMfaSignInRequest) ProtoReflect() protoreflect.Message

func (*StartMfaSignInRequest) Reset

func (x *StartMfaSignInRequest) Reset()

func (*StartMfaSignInRequest) String

func (x *StartMfaSignInRequest) String() string

StartMfaSignInRequest_PhoneSignInInfo

type StartMfaSignInRequest_PhoneSignInInfo struct {
	// Verification info to authorize sending an SMS for phone verification.
	PhoneSignInInfo *StartMfaPhoneRequestInfo `protobuf:"bytes,4,opt,name=phone_sign_in_info,json=phoneSignInInfo,proto3,oneof"`
}

StartMfaSignInResponse

type StartMfaSignInResponse struct {

	// MultiFactor start sign-in response by 2nd factor type.
	//
	// Types that are valid to be assigned to ResponseInfo:
	//
	//	*StartMfaSignInResponse_PhoneResponseInfo
	ResponseInfo isStartMfaSignInResponse_ResponseInfo `protobuf_oneof:"response_info"`
	// contains filtered or unexported fields
}

StartMfaSignIn response.

func (*StartMfaSignInResponse) Descriptor

func (*StartMfaSignInResponse) Descriptor() ([]byte, []int)

Deprecated: Use StartMfaSignInResponse.ProtoReflect.Descriptor instead.

func (*StartMfaSignInResponse) GetPhoneResponseInfo

func (x *StartMfaSignInResponse) GetPhoneResponseInfo() *StartMfaPhoneResponseInfo

func (*StartMfaSignInResponse) GetResponseInfo

func (x *StartMfaSignInResponse) GetResponseInfo() isStartMfaSignInResponse_ResponseInfo

func (*StartMfaSignInResponse) ProtoMessage

func (*StartMfaSignInResponse) ProtoMessage()

func (*StartMfaSignInResponse) ProtoReflect

func (x *StartMfaSignInResponse) ProtoReflect() protoreflect.Message

func (*StartMfaSignInResponse) Reset

func (x *StartMfaSignInResponse) Reset()

func (*StartMfaSignInResponse) String

func (x *StartMfaSignInResponse) String() string

StartMfaSignInResponse_PhoneResponseInfo

type StartMfaSignInResponse_PhoneResponseInfo struct {
	// 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.
	PhoneResponseInfo *StartMfaPhoneResponseInfo `protobuf:"bytes,1,opt,name=phone_response_info,json=phoneResponseInfo,proto3,oneof"`
}

UnimplementedAccountManagementServiceServer

type UnimplementedAccountManagementServiceServer struct {
}

UnimplementedAccountManagementServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedAccountManagementServiceServer) FinalizeMfaEnrollment

func (UnimplementedAccountManagementServiceServer) FinalizeMfaEnrollment(context.Context, *FinalizeMfaEnrollmentRequest) (*FinalizeMfaEnrollmentResponse, error)

func (UnimplementedAccountManagementServiceServer) StartMfaEnrollment

func (UnimplementedAccountManagementServiceServer) StartMfaEnrollment(context.Context, *StartMfaEnrollmentRequest) (*StartMfaEnrollmentResponse, error)

func (UnimplementedAccountManagementServiceServer) WithdrawMfa

func (UnimplementedAccountManagementServiceServer) WithdrawMfa(context.Context, *WithdrawMfaRequest) (*WithdrawMfaResponse, error)

UnimplementedAuthenticationServiceServer

type UnimplementedAuthenticationServiceServer struct {
}

UnimplementedAuthenticationServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedAuthenticationServiceServer) FinalizeMfaSignIn

func (UnimplementedAuthenticationServiceServer) FinalizeMfaSignIn(context.Context, *FinalizeMfaSignInRequest) (*FinalizeMfaSignInResponse, error)

func (UnimplementedAuthenticationServiceServer) StartMfaSignIn

func (UnimplementedAuthenticationServiceServer) StartMfaSignIn(context.Context, *StartMfaSignInRequest) (*StartMfaSignInResponse, error)

UnsafeAccountManagementServiceServer

type UnsafeAccountManagementServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeAccountManagementServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to AccountManagementServiceServer will result in compilation errors.

UnsafeAuthenticationServiceServer

type UnsafeAuthenticationServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeAuthenticationServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to AuthenticationServiceServer will result in compilation errors.

WithdrawMfaRequest

type WithdrawMfaRequest struct {

	// Required. User's ID token.
	IdToken string `protobuf:"bytes,1,opt,name=id_token,json=idToken,proto3" json:"id_token,omitempty"`
	// Required. MFA enrollment id from a current MFA enrollment.
	MfaEnrollmentId string `protobuf:"bytes,2,opt,name=mfa_enrollment_id,json=mfaEnrollmentId,proto3" json:"mfa_enrollment_id,omitempty"`
	// 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.
	TenantId string `protobuf:"bytes,3,opt,name=tenant_id,json=tenantId,proto3" json:"tenant_id,omitempty"`
	// contains filtered or unexported fields
}

Withdraws MFA.

func (*WithdrawMfaRequest) Descriptor

func (*WithdrawMfaRequest) Descriptor() ([]byte, []int)

Deprecated: Use WithdrawMfaRequest.ProtoReflect.Descriptor instead.

func (*WithdrawMfaRequest) GetIdToken

func (x *WithdrawMfaRequest) GetIdToken() string

func (*WithdrawMfaRequest) GetMfaEnrollmentId

func (x *WithdrawMfaRequest) GetMfaEnrollmentId() string

func (*WithdrawMfaRequest) GetTenantId

func (x *WithdrawMfaRequest) GetTenantId() string

func (*WithdrawMfaRequest) ProtoMessage

func (*WithdrawMfaRequest) ProtoMessage()

func (*WithdrawMfaRequest) ProtoReflect

func (x *WithdrawMfaRequest) ProtoReflect() protoreflect.Message

func (*WithdrawMfaRequest) Reset

func (x *WithdrawMfaRequest) Reset()

func (*WithdrawMfaRequest) String

func (x *WithdrawMfaRequest) String() string

WithdrawMfaResponse

type WithdrawMfaResponse struct {

	// ID token updated to reflect removal of the second factor.
	IdToken string `protobuf:"bytes,1,opt,name=id_token,json=idToken,proto3" json:"id_token,omitempty"`
	// Refresh token updated to reflect removal of the second factor.
	RefreshToken string `protobuf:"bytes,2,opt,name=refresh_token,json=refreshToken,proto3" json:"refresh_token,omitempty"`
	// contains filtered or unexported fields
}

Withdraws MultiFactorAuth response.

func (*WithdrawMfaResponse) Descriptor

func (*WithdrawMfaResponse) Descriptor() ([]byte, []int)

Deprecated: Use WithdrawMfaResponse.ProtoReflect.Descriptor instead.

func (*WithdrawMfaResponse) GetIdToken

func (x *WithdrawMfaResponse) GetIdToken() string

func (*WithdrawMfaResponse) GetRefreshToken

func (x *WithdrawMfaResponse) GetRefreshToken() string

func (*WithdrawMfaResponse) ProtoMessage

func (*WithdrawMfaResponse) ProtoMessage()

func (*WithdrawMfaResponse) ProtoReflect

func (x *WithdrawMfaResponse) ProtoReflect() protoreflect.Message

func (*WithdrawMfaResponse) Reset

func (x *WithdrawMfaResponse) Reset()

func (*WithdrawMfaResponse) String

func (x *WithdrawMfaResponse) String() string