Variables
TransactionEvent_TransactionEventType_name, TransactionEvent_TransactionEventType_value
var (
TransactionEvent_TransactionEventType_name = map[int32]string{
0: "TRANSACTION_EVENT_TYPE_UNSPECIFIED",
1: "MERCHANT_APPROVE",
2: "MERCHANT_DENY",
3: "MANUAL_REVIEW",
4: "AUTHORIZATION",
5: "AUTHORIZATION_DECLINE",
6: "PAYMENT_CAPTURE",
7: "PAYMENT_CAPTURE_DECLINE",
8: "CANCEL",
9: "CHARGEBACK_INQUIRY",
10: "CHARGEBACK_ALERT",
11: "FRAUD_NOTIFICATION",
12: "CHARGEBACK",
13: "CHARGEBACK_REPRESENTMENT",
14: "CHARGEBACK_REVERSE",
15: "REFUND_REQUEST",
16: "REFUND_DECLINE",
17: "REFUND",
18: "REFUND_REVERSE",
}
TransactionEvent_TransactionEventType_value = map[string]int32{
"TRANSACTION_EVENT_TYPE_UNSPECIFIED": 0,
"MERCHANT_APPROVE": 1,
"MERCHANT_DENY": 2,
"MANUAL_REVIEW": 3,
"AUTHORIZATION": 4,
"AUTHORIZATION_DECLINE": 5,
"PAYMENT_CAPTURE": 6,
"PAYMENT_CAPTURE_DECLINE": 7,
"CANCEL": 8,
"CHARGEBACK_INQUIRY": 9,
"CHARGEBACK_ALERT": 10,
"FRAUD_NOTIFICATION": 11,
"CHARGEBACK": 12,
"CHARGEBACK_REPRESENTMENT": 13,
"CHARGEBACK_REVERSE": 14,
"REFUND_REQUEST": 15,
"REFUND_DECLINE": 16,
"REFUND": 17,
"REFUND_REVERSE": 18,
}
)
Enum value maps for TransactionEvent_TransactionEventType.
AnnotateAssessmentRequest_Annotation_name, AnnotateAssessmentRequest_Annotation_value
var (
AnnotateAssessmentRequest_Annotation_name = map[int32]string{
0: "ANNOTATION_UNSPECIFIED",
1: "LEGITIMATE",
2: "FRAUDULENT",
3: "PASSWORD_CORRECT",
4: "PASSWORD_INCORRECT",
}
AnnotateAssessmentRequest_Annotation_value = map[string]int32{
"ANNOTATION_UNSPECIFIED": 0,
"LEGITIMATE": 1,
"FRAUDULENT": 2,
"PASSWORD_CORRECT": 3,
"PASSWORD_INCORRECT": 4,
}
)
Enum value maps for AnnotateAssessmentRequest_Annotation.
AnnotateAssessmentRequest_Reason_name, AnnotateAssessmentRequest_Reason_value
var (
AnnotateAssessmentRequest_Reason_name = map[int32]string{
0: "REASON_UNSPECIFIED",
1: "CHARGEBACK",
8: "CHARGEBACK_FRAUD",
9: "CHARGEBACK_DISPUTE",
10: "REFUND",
11: "REFUND_FRAUD",
12: "TRANSACTION_ACCEPTED",
13: "TRANSACTION_DECLINED",
2: "PAYMENT_HEURISTICS",
7: "INITIATED_TWO_FACTOR",
3: "PASSED_TWO_FACTOR",
4: "FAILED_TWO_FACTOR",
5: "CORRECT_PASSWORD",
6: "INCORRECT_PASSWORD",
14: "SOCIAL_SPAM",
}
AnnotateAssessmentRequest_Reason_value = map[string]int32{
"REASON_UNSPECIFIED": 0,
"CHARGEBACK": 1,
"CHARGEBACK_FRAUD": 8,
"CHARGEBACK_DISPUTE": 9,
"REFUND": 10,
"REFUND_FRAUD": 11,
"TRANSACTION_ACCEPTED": 12,
"TRANSACTION_DECLINED": 13,
"PAYMENT_HEURISTICS": 2,
"INITIATED_TWO_FACTOR": 7,
"PASSED_TWO_FACTOR": 3,
"FAILED_TWO_FACTOR": 4,
"CORRECT_PASSWORD": 5,
"INCORRECT_PASSWORD": 6,
"SOCIAL_SPAM": 14,
}
)
Enum value maps for AnnotateAssessmentRequest_Reason.
AccountVerificationInfo_Result_name, AccountVerificationInfo_Result_value
var (
AccountVerificationInfo_Result_name = map[int32]string{
0: "RESULT_UNSPECIFIED",
1: "SUCCESS_USER_VERIFIED",
2: "ERROR_USER_NOT_VERIFIED",
3: "ERROR_SITE_ONBOARDING_INCOMPLETE",
4: "ERROR_RECIPIENT_NOT_ALLOWED",
5: "ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED",
6: "ERROR_CRITICAL_INTERNAL",
7: "ERROR_CUSTOMER_QUOTA_EXHAUSTED",
8: "ERROR_VERIFICATION_BYPASSED",
9: "ERROR_VERDICT_MISMATCH",
}
AccountVerificationInfo_Result_value = map[string]int32{
"RESULT_UNSPECIFIED": 0,
"SUCCESS_USER_VERIFIED": 1,
"ERROR_USER_NOT_VERIFIED": 2,
"ERROR_SITE_ONBOARDING_INCOMPLETE": 3,
"ERROR_RECIPIENT_NOT_ALLOWED": 4,
"ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED": 5,
"ERROR_CRITICAL_INTERNAL": 6,
"ERROR_CUSTOMER_QUOTA_EXHAUSTED": 7,
"ERROR_VERIFICATION_BYPASSED": 8,
"ERROR_VERDICT_MISMATCH": 9,
}
)
Enum value maps for AccountVerificationInfo_Result.
Event_FraudPrevention_name, Event_FraudPrevention_value
var (
Event_FraudPrevention_name = map[int32]string{
0: "FRAUD_PREVENTION_UNSPECIFIED",
1: "ENABLED",
2: "DISABLED",
}
Event_FraudPrevention_value = map[string]int32{
"FRAUD_PREVENTION_UNSPECIFIED": 0,
"ENABLED": 1,
"DISABLED": 2,
}
)
Enum value maps for Event_FraudPrevention.
RiskAnalysis_ClassificationReason_name, RiskAnalysis_ClassificationReason_value
var (
RiskAnalysis_ClassificationReason_name = map[int32]string{
0: "CLASSIFICATION_REASON_UNSPECIFIED",
1: "AUTOMATION",
2: "UNEXPECTED_ENVIRONMENT",
3: "TOO_MUCH_TRAFFIC",
4: "UNEXPECTED_USAGE_PATTERNS",
5: "LOW_CONFIDENCE_SCORE",
6: "SUSPECTED_CARDING",
7: "SUSPECTED_CHARGEBACK",
}
RiskAnalysis_ClassificationReason_value = map[string]int32{
"CLASSIFICATION_REASON_UNSPECIFIED": 0,
"AUTOMATION": 1,
"UNEXPECTED_ENVIRONMENT": 2,
"TOO_MUCH_TRAFFIC": 3,
"UNEXPECTED_USAGE_PATTERNS": 4,
"LOW_CONFIDENCE_SCORE": 5,
"SUSPECTED_CARDING": 6,
"SUSPECTED_CHARGEBACK": 7,
}
)
Enum value maps for RiskAnalysis_ClassificationReason.
RiskAnalysis_Challenge_name, RiskAnalysis_Challenge_value
var (
RiskAnalysis_Challenge_name = map[int32]string{
0: "CHALLENGE_UNSPECIFIED",
1: "NOCAPTCHA",
2: "PASSED",
3: "FAILED",
}
RiskAnalysis_Challenge_value = map[string]int32{
"CHALLENGE_UNSPECIFIED": 0,
"NOCAPTCHA": 1,
"PASSED": 2,
"FAILED": 3,
}
)
Enum value maps for RiskAnalysis_Challenge.
TokenProperties_InvalidReason_name, TokenProperties_InvalidReason_value
var (
TokenProperties_InvalidReason_name = map[int32]string{
0: "INVALID_REASON_UNSPECIFIED",
1: "UNKNOWN_INVALID_REASON",
2: "MALFORMED",
3: "EXPIRED",
4: "DUPE",
5: "MISSING",
6: "BROWSER_ERROR",
}
TokenProperties_InvalidReason_value = map[string]int32{
"INVALID_REASON_UNSPECIFIED": 0,
"UNKNOWN_INVALID_REASON": 1,
"MALFORMED": 2,
"EXPIRED": 3,
"DUPE": 4,
"MISSING": 5,
"BROWSER_ERROR": 6,
}
)
Enum value maps for TokenProperties_InvalidReason.
FraudSignals_CardSignals_CardLabel_name, FraudSignals_CardSignals_CardLabel_value
var (
FraudSignals_CardSignals_CardLabel_name = map[int32]string{
0: "CARD_LABEL_UNSPECIFIED",
1: "PREPAID",
2: "VIRTUAL",
3: "UNEXPECTED_LOCATION",
}
FraudSignals_CardSignals_CardLabel_value = map[string]int32{
"CARD_LABEL_UNSPECIFIED": 0,
"PREPAID": 1,
"VIRTUAL": 2,
"UNEXPECTED_LOCATION": 3,
}
)
Enum value maps for FraudSignals_CardSignals_CardLabel.
SmsTollFraudVerdict_SmsTollFraudReason_name, SmsTollFraudVerdict_SmsTollFraudReason_value
var (
SmsTollFraudVerdict_SmsTollFraudReason_name = map[int32]string{
0: "SMS_TOLL_FRAUD_REASON_UNSPECIFIED",
1: "INVALID_PHONE_NUMBER",
}
SmsTollFraudVerdict_SmsTollFraudReason_value = map[string]int32{
"SMS_TOLL_FRAUD_REASON_UNSPECIFIED": 0,
"INVALID_PHONE_NUMBER": 1,
}
)
Enum value maps for SmsTollFraudVerdict_SmsTollFraudReason.
AccountDefenderAssessment_AccountDefenderLabel_name, AccountDefenderAssessment_AccountDefenderLabel_value
var (
AccountDefenderAssessment_AccountDefenderLabel_name = map[int32]string{
0: "ACCOUNT_DEFENDER_LABEL_UNSPECIFIED",
1: "PROFILE_MATCH",
2: "SUSPICIOUS_LOGIN_ACTIVITY",
3: "SUSPICIOUS_ACCOUNT_CREATION",
4: "RELATED_ACCOUNTS_NUMBER_HIGH",
}
AccountDefenderAssessment_AccountDefenderLabel_value = map[string]int32{
"ACCOUNT_DEFENDER_LABEL_UNSPECIFIED": 0,
"PROFILE_MATCH": 1,
"SUSPICIOUS_LOGIN_ACTIVITY": 2,
"SUSPICIOUS_ACCOUNT_CREATION": 3,
"RELATED_ACCOUNTS_NUMBER_HIGH": 4,
}
)
Enum value maps for AccountDefenderAssessment_AccountDefenderLabel.
TestingOptions_TestingChallenge_name, TestingOptions_TestingChallenge_value
var (
TestingOptions_TestingChallenge_name = map[int32]string{
0: "TESTING_CHALLENGE_UNSPECIFIED",
1: "NOCAPTCHA",
2: "UNSOLVABLE_CHALLENGE",
}
TestingOptions_TestingChallenge_value = map[string]int32{
"TESTING_CHALLENGE_UNSPECIFIED": 0,
"NOCAPTCHA": 1,
"UNSOLVABLE_CHALLENGE": 2,
}
)
Enum value maps for TestingOptions_TestingChallenge.
WebKeySettings_IntegrationType_name, WebKeySettings_IntegrationType_value
var (
WebKeySettings_IntegrationType_name = map[int32]string{
0: "INTEGRATION_TYPE_UNSPECIFIED",
1: "SCORE",
2: "CHECKBOX",
3: "INVISIBLE",
}
WebKeySettings_IntegrationType_value = map[string]int32{
"INTEGRATION_TYPE_UNSPECIFIED": 0,
"SCORE": 1,
"CHECKBOX": 2,
"INVISIBLE": 3,
}
)
Enum value maps for WebKeySettings_IntegrationType.
WebKeySettings_ChallengeSecurityPreference_name, WebKeySettings_ChallengeSecurityPreference_value
var (
WebKeySettings_ChallengeSecurityPreference_name = map[int32]string{
0: "CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED",
1: "USABILITY",
2: "BALANCE",
3: "SECURITY",
}
WebKeySettings_ChallengeSecurityPreference_value = map[string]int32{
"CHALLENGE_SECURITY_PREFERENCE_UNSPECIFIED": 0,
"USABILITY": 1,
"BALANCE": 2,
"SECURITY": 3,
}
)
Enum value maps for WebKeySettings_ChallengeSecurityPreference.
WafSettings_WafFeature_name, WafSettings_WafFeature_value
var (
WafSettings_WafFeature_name = map[int32]string{
0: "WAF_FEATURE_UNSPECIFIED",
1: "CHALLENGE_PAGE",
2: "SESSION_TOKEN",
3: "ACTION_TOKEN",
5: "EXPRESS",
}
WafSettings_WafFeature_value = map[string]int32{
"WAF_FEATURE_UNSPECIFIED": 0,
"CHALLENGE_PAGE": 1,
"SESSION_TOKEN": 2,
"ACTION_TOKEN": 3,
"EXPRESS": 5,
}
)
Enum value maps for WafSettings_WafFeature.
WafSettings_WafService_name, WafSettings_WafService_value
var (
WafSettings_WafService_name = map[int32]string{
0: "WAF_SERVICE_UNSPECIFIED",
1: "CA",
3: "FASTLY",
4: "CLOUDFLARE",
5: "AKAMAI",
}
WafSettings_WafService_value = map[string]int32{
"WAF_SERVICE_UNSPECIFIED": 0,
"CA": 1,
"FASTLY": 3,
"CLOUDFLARE": 4,
"AKAMAI": 5,
}
)
Enum value maps for WafSettings_WafService.
IpOverrideData_OverrideType_name, IpOverrideData_OverrideType_value
var (
IpOverrideData_OverrideType_name = map[int32]string{
0: "OVERRIDE_TYPE_UNSPECIFIED",
1: "ALLOW",
}
IpOverrideData_OverrideType_value = map[string]int32{
"OVERRIDE_TYPE_UNSPECIFIED": 0,
"ALLOW": 1,
}
)
Enum value maps for IpOverrideData_OverrideType.
File_google_cloud_recaptchaenterprise_v1_recaptchaenterprise_proto
var File_google_cloud_recaptchaenterprise_v1_recaptchaenterprise_proto protoreflect.FileDescriptor
Functions
func RegisterRecaptchaEnterpriseServiceServer
func RegisterRecaptchaEnterpriseServiceServer(s *grpc.Server, srv RecaptchaEnterpriseServiceServer)
AccountDefenderAssessment
type AccountDefenderAssessment struct {
// Output only. Labels for this request.
Labels []AccountDefenderAssessment_AccountDefenderLabel `protobuf:"varint,1,rep,packed,name=labels,proto3,enum=google.cloud.recaptchaenterprise.v1.AccountDefenderAssessment_AccountDefenderLabel" json:"labels,omitempty"`
// contains filtered or unexported fields
}
Account defender risk assessment.
func (*AccountDefenderAssessment) Descriptor
func (*AccountDefenderAssessment) Descriptor() ([]byte, []int)
Deprecated: Use AccountDefenderAssessment.ProtoReflect.Descriptor instead.
func (*AccountDefenderAssessment) GetLabels
func (x *AccountDefenderAssessment) GetLabels() []AccountDefenderAssessment_AccountDefenderLabel
func (*AccountDefenderAssessment) ProtoMessage
func (*AccountDefenderAssessment) ProtoMessage()
func (*AccountDefenderAssessment) ProtoReflect
func (x *AccountDefenderAssessment) ProtoReflect() protoreflect.Message
func (*AccountDefenderAssessment) Reset
func (x *AccountDefenderAssessment) Reset()
func (*AccountDefenderAssessment) String
func (x *AccountDefenderAssessment) String() string
AccountDefenderAssessment_AccountDefenderLabel
type AccountDefenderAssessment_AccountDefenderLabel int32
Labels returned by account defender for this request.
AccountDefenderAssessment_ACCOUNT_DEFENDER_LABEL_UNSPECIFIED, AccountDefenderAssessment_PROFILE_MATCH, AccountDefenderAssessment_SUSPICIOUS_LOGIN_ACTIVITY, AccountDefenderAssessment_SUSPICIOUS_ACCOUNT_CREATION, AccountDefenderAssessment_RELATED_ACCOUNTS_NUMBER_HIGH
const (
// Default unspecified type.
AccountDefenderAssessment_ACCOUNT_DEFENDER_LABEL_UNSPECIFIED AccountDefenderAssessment_AccountDefenderLabel = 0
// The request matches a known good profile for the user.
AccountDefenderAssessment_PROFILE_MATCH AccountDefenderAssessment_AccountDefenderLabel = 1
// The request is potentially a suspicious login event and must be further
// verified either through multi-factor authentication or another system.
AccountDefenderAssessment_SUSPICIOUS_LOGIN_ACTIVITY AccountDefenderAssessment_AccountDefenderLabel = 2
// The request matched a profile that previously had suspicious account
// creation behavior. This can mean that this is a fake account.
AccountDefenderAssessment_SUSPICIOUS_ACCOUNT_CREATION AccountDefenderAssessment_AccountDefenderLabel = 3
// The account in the request has a high number of related accounts. It does
// not necessarily imply that the account is bad but can require further
// investigation.
AccountDefenderAssessment_RELATED_ACCOUNTS_NUMBER_HIGH AccountDefenderAssessment_AccountDefenderLabel = 4
)
func (AccountDefenderAssessment_AccountDefenderLabel) Descriptor
func (AccountDefenderAssessment_AccountDefenderLabel) Descriptor() protoreflect.EnumDescriptor
func (AccountDefenderAssessment_AccountDefenderLabel) Enum
func (x AccountDefenderAssessment_AccountDefenderLabel) Enum() *AccountDefenderAssessment_AccountDefenderLabel
func (AccountDefenderAssessment_AccountDefenderLabel) EnumDescriptor
func (AccountDefenderAssessment_AccountDefenderLabel) EnumDescriptor() ([]byte, []int)
Deprecated: Use AccountDefenderAssessment_AccountDefenderLabel.Descriptor instead.
func (AccountDefenderAssessment_AccountDefenderLabel) Number
func (x AccountDefenderAssessment_AccountDefenderLabel) Number() protoreflect.EnumNumber
func (AccountDefenderAssessment_AccountDefenderLabel) String
func (x AccountDefenderAssessment_AccountDefenderLabel) String() string
func (AccountDefenderAssessment_AccountDefenderLabel) Type
AccountVerificationInfo
type AccountVerificationInfo struct {
// Optional. Endpoints that can be used for identity verification.
Endpoints []*EndpointVerificationInfo `protobuf:"bytes,1,rep,name=endpoints,proto3" json:"endpoints,omitempty"`
// Optional. Language code preference for the verification message, set as a
// IETF BCP 47 language code.
LanguageCode string `protobuf:"bytes,3,opt,name=language_code,json=languageCode,proto3" json:"language_code,omitempty"`
// Output only. Result of the latest account verification challenge.
LatestVerificationResult AccountVerificationInfo_Result `protobuf:"varint,7,opt,name=latest_verification_result,json=latestVerificationResult,proto3,enum=google.cloud.recaptchaenterprise.v1.AccountVerificationInfo_Result" json:"latest_verification_result,omitempty"`
// Username of the account that is being verified. Deprecated. Customers
// should now provide the `account_id` field in `event.user_info`.
//
// Deprecated: Marked as deprecated in google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto.
Username string `protobuf:"bytes,2,opt,name=username,proto3" json:"username,omitempty"`
// contains filtered or unexported fields
}
Information about account verification, used for identity verification.
func (*AccountVerificationInfo) Descriptor
func (*AccountVerificationInfo) Descriptor() ([]byte, []int)
Deprecated: Use AccountVerificationInfo.ProtoReflect.Descriptor instead.
func (*AccountVerificationInfo) GetEndpoints
func (x *AccountVerificationInfo) GetEndpoints() []*EndpointVerificationInfo
func (*AccountVerificationInfo) GetLanguageCode
func (x *AccountVerificationInfo) GetLanguageCode() string
func (*AccountVerificationInfo) GetLatestVerificationResult
func (x *AccountVerificationInfo) GetLatestVerificationResult() AccountVerificationInfo_Result
func (*AccountVerificationInfo) GetUsername
func (x *AccountVerificationInfo) GetUsername() string
Deprecated: Marked as deprecated in google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto.
func (*AccountVerificationInfo) ProtoMessage
func (*AccountVerificationInfo) ProtoMessage()
func (*AccountVerificationInfo) ProtoReflect
func (x *AccountVerificationInfo) ProtoReflect() protoreflect.Message
func (*AccountVerificationInfo) Reset
func (x *AccountVerificationInfo) Reset()
func (*AccountVerificationInfo) String
func (x *AccountVerificationInfo) String() string
AccountVerificationInfo_Result
type AccountVerificationInfo_Result int32
Result of the account verification as contained in the verdict token issued at the end of the verification flow.
AccountVerificationInfo_RESULT_UNSPECIFIED, AccountVerificationInfo_SUCCESS_USER_VERIFIED, AccountVerificationInfo_ERROR_USER_NOT_VERIFIED, AccountVerificationInfo_ERROR_SITE_ONBOARDING_INCOMPLETE, AccountVerificationInfo_ERROR_RECIPIENT_NOT_ALLOWED, AccountVerificationInfo_ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED, AccountVerificationInfo_ERROR_CRITICAL_INTERNAL, AccountVerificationInfo_ERROR_CUSTOMER_QUOTA_EXHAUSTED, AccountVerificationInfo_ERROR_VERIFICATION_BYPASSED, AccountVerificationInfo_ERROR_VERDICT_MISMATCH
const (
// No information about the latest account verification.
AccountVerificationInfo_RESULT_UNSPECIFIED AccountVerificationInfo_Result = 0
// The user was successfully verified. This means the account verification
// challenge was successfully completed.
AccountVerificationInfo_SUCCESS_USER_VERIFIED AccountVerificationInfo_Result = 1
// The user failed the verification challenge.
AccountVerificationInfo_ERROR_USER_NOT_VERIFIED AccountVerificationInfo_Result = 2
// The site is not properly onboarded to use the account verification
// feature.
AccountVerificationInfo_ERROR_SITE_ONBOARDING_INCOMPLETE AccountVerificationInfo_Result = 3
// The recipient is not allowed for account verification. This can occur
// during integration but should not occur in production.
AccountVerificationInfo_ERROR_RECIPIENT_NOT_ALLOWED AccountVerificationInfo_Result = 4
// The recipient has already been sent too many verification codes in a
// short amount of time.
AccountVerificationInfo_ERROR_RECIPIENT_ABUSE_LIMIT_EXHAUSTED AccountVerificationInfo_Result = 5
// The verification flow could not be completed due to a critical internal
// error.
AccountVerificationInfo_ERROR_CRITICAL_INTERNAL AccountVerificationInfo_Result = 6
// The client has exceeded their two factor request quota for this period of
// time.
AccountVerificationInfo_ERROR_CUSTOMER_QUOTA_EXHAUSTED AccountVerificationInfo_Result = 7
// The request cannot be processed at the time because of an incident. This
// bypass can be restricted to a problematic destination email domain, a
// customer, or could affect the entire service.
AccountVerificationInfo_ERROR_VERIFICATION_BYPASSED AccountVerificationInfo_Result = 8
// The request parameters do not match with the token provided and cannot be
// processed.
AccountVerificationInfo_ERROR_VERDICT_MISMATCH AccountVerificationInfo_Result = 9
)
func (AccountVerificationInfo_Result) Descriptor
func (AccountVerificationInfo_Result) Descriptor() protoreflect.EnumDescriptor
func (AccountVerificationInfo_Result) Enum
func (x AccountVerificationInfo_Result) Enum() *AccountVerificationInfo_Result
func (AccountVerificationInfo_Result) EnumDescriptor
func (AccountVerificationInfo_Result) EnumDescriptor() ([]byte, []int)
Deprecated: Use AccountVerificationInfo_Result.Descriptor instead.
func (AccountVerificationInfo_Result) Number
func (x AccountVerificationInfo_Result) Number() protoreflect.EnumNumber
func (AccountVerificationInfo_Result) String
func (x AccountVerificationInfo_Result) String() string
func (AccountVerificationInfo_Result) Type
func (AccountVerificationInfo_Result) Type() protoreflect.EnumType
AddIpOverrideRequest
type AddIpOverrideRequest struct {
// Required. The name of the key to which the IP override is added, in the
// format `projects/{project}/keys/{key}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. IP override added to the key.
IpOverrideData *IpOverrideData `protobuf:"bytes,2,opt,name=ip_override_data,json=ipOverrideData,proto3" json:"ip_override_data,omitempty"`
// contains filtered or unexported fields
}
The AddIpOverride request message.
func (*AddIpOverrideRequest) Descriptor
func (*AddIpOverrideRequest) Descriptor() ([]byte, []int)
Deprecated: Use AddIpOverrideRequest.ProtoReflect.Descriptor instead.
func (*AddIpOverrideRequest) GetIpOverrideData
func (x *AddIpOverrideRequest) GetIpOverrideData() *IpOverrideData
func (*AddIpOverrideRequest) GetName
func (x *AddIpOverrideRequest) GetName() string
func (*AddIpOverrideRequest) ProtoMessage
func (*AddIpOverrideRequest) ProtoMessage()
func (*AddIpOverrideRequest) ProtoReflect
func (x *AddIpOverrideRequest) ProtoReflect() protoreflect.Message
func (*AddIpOverrideRequest) Reset
func (x *AddIpOverrideRequest) Reset()
func (*AddIpOverrideRequest) String
func (x *AddIpOverrideRequest) String() string
AddIpOverrideResponse
type AddIpOverrideResponse struct {
// contains filtered or unexported fields
}
Response for AddIpOverride.
func (*AddIpOverrideResponse) Descriptor
func (*AddIpOverrideResponse) Descriptor() ([]byte, []int)
Deprecated: Use AddIpOverrideResponse.ProtoReflect.Descriptor instead.
func (*AddIpOverrideResponse) ProtoMessage
func (*AddIpOverrideResponse) ProtoMessage()
func (*AddIpOverrideResponse) ProtoReflect
func (x *AddIpOverrideResponse) ProtoReflect() protoreflect.Message
func (*AddIpOverrideResponse) Reset
func (x *AddIpOverrideResponse) Reset()
func (*AddIpOverrideResponse) String
func (x *AddIpOverrideResponse) String() string
AndroidKeySettings
type AndroidKeySettings struct {
// Optional. If set to true, allowed_package_names are not enforced.
AllowAllPackageNames bool `protobuf:"varint,2,opt,name=allow_all_package_names,json=allowAllPackageNames,proto3" json:"allow_all_package_names,omitempty"`
// Optional. Android package names of apps allowed to use the key.
// Example: 'com.companyname.appname'
AllowedPackageNames []string `protobuf:"bytes,1,rep,name=allowed_package_names,json=allowedPackageNames,proto3" json:"allowed_package_names,omitempty"`
// Optional. Set to true for keys that are used in an Android application that
// is available for download in app stores in addition to the Google Play
// Store.
SupportNonGoogleAppStoreDistribution bool `protobuf:"varint,3,opt,name=support_non_google_app_store_distribution,json=supportNonGoogleAppStoreDistribution,proto3" json:"support_non_google_app_store_distribution,omitempty"`
// contains filtered or unexported fields
}
Settings specific to keys that can be used by Android apps.
func (*AndroidKeySettings) Descriptor
func (*AndroidKeySettings) Descriptor() ([]byte, []int)
Deprecated: Use AndroidKeySettings.ProtoReflect.Descriptor instead.
func (*AndroidKeySettings) GetAllowAllPackageNames
func (x *AndroidKeySettings) GetAllowAllPackageNames() bool
func (*AndroidKeySettings) GetAllowedPackageNames
func (x *AndroidKeySettings) GetAllowedPackageNames() []string
func (*AndroidKeySettings) GetSupportNonGoogleAppStoreDistribution
func (x *AndroidKeySettings) GetSupportNonGoogleAppStoreDistribution() bool
func (*AndroidKeySettings) ProtoMessage
func (*AndroidKeySettings) ProtoMessage()
func (*AndroidKeySettings) ProtoReflect
func (x *AndroidKeySettings) ProtoReflect() protoreflect.Message
func (*AndroidKeySettings) Reset
func (x *AndroidKeySettings) Reset()
func (*AndroidKeySettings) String
func (x *AndroidKeySettings) String() string
AnnotateAssessmentRequest
type AnnotateAssessmentRequest struct {
// Required. The resource name of the Assessment, in the format
// `projects/{project}/assessments/{assessment}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The annotation that is assigned to the Event. This field can be
// left empty to provide reasons that apply to an event without concluding
// whether the event is legitimate or fraudulent.
Annotation AnnotateAssessmentRequest_Annotation `protobuf:"varint,2,opt,name=annotation,proto3,enum=google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest_Annotation" json:"annotation,omitempty"`
// Optional. Reasons for the annotation that are assigned to the event.
Reasons []AnnotateAssessmentRequest_Reason `protobuf:"varint,3,rep,packed,name=reasons,proto3,enum=google.cloud.recaptchaenterprise.v1.AnnotateAssessmentRequest_Reason" json:"reasons,omitempty"`
// Optional. A stable account identifier to apply to the assessment. This is
// an alternative to setting `account_id` in `CreateAssessment`, for example
// when a stable account identifier is not yet known in the initial request.
AccountId string `protobuf:"bytes,7,opt,name=account_id,json=accountId,proto3" json:"account_id,omitempty"`
// Optional. A stable hashed account identifier to apply to the assessment.
// This is an alternative to setting `hashed_account_id` in
// `CreateAssessment`, for example when a stable account identifier is not yet
// known in the initial request.
HashedAccountId []byte `protobuf:"bytes,4,opt,name=hashed_account_id,json=hashedAccountId,proto3" json:"hashed_account_id,omitempty"`
// Optional. If the assessment is part of a payment transaction, provide
// details on payment lifecycle events that occur in the transaction.
TransactionEvent *TransactionEvent `protobuf:"bytes,5,opt,name=transaction_event,json=transactionEvent,proto3" json:"transaction_event,omitempty"`
// contains filtered or unexported fields
}
The request message to annotate an Assessment.
func (*AnnotateAssessmentRequest) Descriptor
func (*AnnotateAssessmentRequest) Descriptor() ([]byte, []int)
Deprecated: Use AnnotateAssessmentRequest.ProtoReflect.Descriptor instead.
func (*AnnotateAssessmentRequest) GetAccountId
func (x *AnnotateAssessmentRequest) GetAccountId() string
func (*AnnotateAssessmentRequest) GetAnnotation
func (x *AnnotateAssessmentRequest) GetAnnotation() AnnotateAssessmentRequest_Annotation
func (*AnnotateAssessmentRequest) GetHashedAccountId
func (x *AnnotateAssessmentRequest) GetHashedAccountId() []byte
func (*AnnotateAssessmentRequest) GetName
func (x *AnnotateAssessmentRequest) GetName() string
func (*AnnotateAssessmentRequest) GetReasons
func (x *AnnotateAssessmentRequest) GetReasons() []AnnotateAssessmentRequest_Reason
func (*AnnotateAssessmentRequest) GetTransactionEvent
func (x *AnnotateAssessmentRequest) GetTransactionEvent() *TransactionEvent
func (*AnnotateAssessmentRequest) ProtoMessage
func (*AnnotateAssessmentRequest) ProtoMessage()
func (*AnnotateAssessmentRequest) ProtoReflect
func (x *AnnotateAssessmentRequest) ProtoReflect() protoreflect.Message
func (*AnnotateAssessmentRequest) Reset
func (x *AnnotateAssessmentRequest) Reset()
func (*AnnotateAssessmentRequest) String
func (x *AnnotateAssessmentRequest) String() string
AnnotateAssessmentRequest_Annotation
type AnnotateAssessmentRequest_Annotation int32
Enum that represents the types of annotations.
AnnotateAssessmentRequest_ANNOTATION_UNSPECIFIED, AnnotateAssessmentRequest_LEGITIMATE, AnnotateAssessmentRequest_FRAUDULENT, AnnotateAssessmentRequest_PASSWORD_CORRECT, AnnotateAssessmentRequest_PASSWORD_INCORRECT
const (
// Default unspecified type.
AnnotateAssessmentRequest_ANNOTATION_UNSPECIFIED AnnotateAssessmentRequest_Annotation = 0
// Provides information that the event turned out to be legitimate.
AnnotateAssessmentRequest_LEGITIMATE AnnotateAssessmentRequest_Annotation = 1
// Provides information that the event turned out to be fraudulent.
AnnotateAssessmentRequest_FRAUDULENT AnnotateAssessmentRequest_Annotation = 2
// Provides information that the event was related to a login event in which
// the user typed the correct password. Deprecated, prefer indicating
// CORRECT_PASSWORD through the reasons field instead.
//
// Deprecated: Marked as deprecated in google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto.
AnnotateAssessmentRequest_PASSWORD_CORRECT AnnotateAssessmentRequest_Annotation = 3
// Provides information that the event was related to a login event in which
// the user typed the incorrect password. Deprecated, prefer indicating
// INCORRECT_PASSWORD through the reasons field instead.
//
// Deprecated: Marked as deprecated in google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto.
AnnotateAssessmentRequest_PASSWORD_INCORRECT AnnotateAssessmentRequest_Annotation = 4
)
func (AnnotateAssessmentRequest_Annotation) Descriptor
func (AnnotateAssessmentRequest_Annotation) Descriptor() protoreflect.EnumDescriptor
func (AnnotateAssessmentRequest_Annotation) Enum
func (x AnnotateAssessmentRequest_Annotation) Enum() *AnnotateAssessmentRequest_Annotation
func (AnnotateAssessmentRequest_Annotation) EnumDescriptor
func (AnnotateAssessmentRequest_Annotation) EnumDescriptor() ([]byte, []int)
Deprecated: Use AnnotateAssessmentRequest_Annotation.Descriptor instead.
func (AnnotateAssessmentRequest_Annotation) Number
func (x AnnotateAssessmentRequest_Annotation) Number() protoreflect.EnumNumber
func (AnnotateAssessmentRequest_Annotation) String
func (x AnnotateAssessmentRequest_Annotation) String() string
func (AnnotateAssessmentRequest_Annotation) Type
func (AnnotateAssessmentRequest_Annotation) Type() protoreflect.EnumType
AnnotateAssessmentRequest_Reason
type AnnotateAssessmentRequest_Reason int32
Enum that represents potential reasons for annotating an assessment.
AnnotateAssessmentRequest_REASON_UNSPECIFIED, AnnotateAssessmentRequest_CHARGEBACK, AnnotateAssessmentRequest_CHARGEBACK_FRAUD, AnnotateAssessmentRequest_CHARGEBACK_DISPUTE, AnnotateAssessmentRequest_REFUND, AnnotateAssessmentRequest_REFUND_FRAUD, AnnotateAssessmentRequest_TRANSACTION_ACCEPTED, AnnotateAssessmentRequest_TRANSACTION_DECLINED, AnnotateAssessmentRequest_PAYMENT_HEURISTICS, AnnotateAssessmentRequest_INITIATED_TWO_FACTOR, AnnotateAssessmentRequest_PASSED_TWO_FACTOR, AnnotateAssessmentRequest_FAILED_TWO_FACTOR, AnnotateAssessmentRequest_CORRECT_PASSWORD, AnnotateAssessmentRequest_INCORRECT_PASSWORD, AnnotateAssessmentRequest_SOCIAL_SPAM
const (
// Unspecified reason. Do not use.
AnnotateAssessmentRequest_REASON_UNSPECIFIED AnnotateAssessmentRequest_Reason = 0
// Indicates that the transaction had a chargeback issued with no other
// details. When possible, specify the type by using CHARGEBACK_FRAUD or
// CHARGEBACK_DISPUTE instead.
AnnotateAssessmentRequest_CHARGEBACK AnnotateAssessmentRequest_Reason = 1
// Indicates that the transaction had a chargeback issued related to an
// alleged unauthorized transaction from the cardholder's perspective (for
// example, the card number was stolen).
AnnotateAssessmentRequest_CHARGEBACK_FRAUD AnnotateAssessmentRequest_Reason = 8
// Indicates that the transaction had a chargeback issued related to the
// cardholder having provided their card details but allegedly not being
// satisfied with the purchase (for example, misrepresentation, attempted
// cancellation).
AnnotateAssessmentRequest_CHARGEBACK_DISPUTE AnnotateAssessmentRequest_Reason = 9
// Indicates that the completed payment transaction was refunded by the
// seller.
AnnotateAssessmentRequest_REFUND AnnotateAssessmentRequest_Reason = 10
// Indicates that the completed payment transaction was determined to be
// fraudulent by the seller, and was cancelled and refunded as a result.
AnnotateAssessmentRequest_REFUND_FRAUD AnnotateAssessmentRequest_Reason = 11
// Indicates that the payment transaction was accepted, and the user was
// charged.
AnnotateAssessmentRequest_TRANSACTION_ACCEPTED AnnotateAssessmentRequest_Reason = 12
// Indicates that the payment transaction was declined, for example due to
// invalid card details.
AnnotateAssessmentRequest_TRANSACTION_DECLINED AnnotateAssessmentRequest_Reason = 13
// Indicates the transaction associated with the assessment is suspected of
// being fraudulent based on the payment method, billing details, shipping
// address or other transaction information.
AnnotateAssessmentRequest_PAYMENT_HEURISTICS AnnotateAssessmentRequest_Reason = 2
// Indicates that the user was served a 2FA challenge. An old assessment
// with `ENUM_VALUES.INITIATED_TWO_FACTOR` reason that has not been
// overwritten with `PASSED_TWO_FACTOR` is treated as an abandoned 2FA flow.
// This is equivalent to `FAILED_TWO_FACTOR`.
AnnotateAssessmentRequest_INITIATED_TWO_FACTOR AnnotateAssessmentRequest_Reason = 7
// Indicates that the user passed a 2FA challenge.
AnnotateAssessmentRequest_PASSED_TWO_FACTOR AnnotateAssessmentRequest_Reason = 3
// Indicates that the user failed a 2FA challenge.
AnnotateAssessmentRequest_FAILED_TWO_FACTOR AnnotateAssessmentRequest_Reason = 4
// Indicates the user provided the correct password.
AnnotateAssessmentRequest_CORRECT_PASSWORD AnnotateAssessmentRequest_Reason = 5
// Indicates the user provided an incorrect password.
AnnotateAssessmentRequest_INCORRECT_PASSWORD AnnotateAssessmentRequest_Reason = 6
// Indicates that the user sent unwanted and abusive messages to other users
// of the platform, such as spam, scams, phishing, or social engineering.
AnnotateAssessmentRequest_SOCIAL_SPAM AnnotateAssessmentRequest_Reason = 14
)
func (AnnotateAssessmentRequest_Reason) Descriptor
func (AnnotateAssessmentRequest_Reason) Descriptor() protoreflect.EnumDescriptor
func (AnnotateAssessmentRequest_Reason) Enum
func (x AnnotateAssessmentRequest_Reason) Enum() *AnnotateAssessmentRequest_Reason
func (AnnotateAssessmentRequest_Reason) EnumDescriptor
func (AnnotateAssessmentRequest_Reason) EnumDescriptor() ([]byte, []int)
Deprecated: Use AnnotateAssessmentRequest_Reason.Descriptor instead.
func (AnnotateAssessmentRequest_Reason) Number
func (x AnnotateAssessmentRequest_Reason) Number() protoreflect.EnumNumber
func (AnnotateAssessmentRequest_Reason) String
func (x AnnotateAssessmentRequest_Reason) String() string
func (AnnotateAssessmentRequest_Reason) Type
func (AnnotateAssessmentRequest_Reason) Type() protoreflect.EnumType
AnnotateAssessmentResponse
type AnnotateAssessmentResponse struct {
// contains filtered or unexported fields
}
Empty response for AnnotateAssessment.
func (*AnnotateAssessmentResponse) Descriptor
func (*AnnotateAssessmentResponse) Descriptor() ([]byte, []int)
Deprecated: Use AnnotateAssessmentResponse.ProtoReflect.Descriptor instead.
func (*AnnotateAssessmentResponse) ProtoMessage
func (*AnnotateAssessmentResponse) ProtoMessage()
func (*AnnotateAssessmentResponse) ProtoReflect
func (x *AnnotateAssessmentResponse) ProtoReflect() protoreflect.Message
func (*AnnotateAssessmentResponse) Reset
func (x *AnnotateAssessmentResponse) Reset()
func (*AnnotateAssessmentResponse) String
func (x *AnnotateAssessmentResponse) String() string
AppleDeveloperId
type AppleDeveloperId struct {
// Required. Input only. A private key (downloaded as a text file with a .p8
// file extension) generated for your Apple Developer account. Ensure that
// Apple DeviceCheck is enabled for the private key.
PrivateKey string `protobuf:"bytes,1,opt,name=private_key,json=privateKey,proto3" json:"private_key,omitempty"`
// Required. The Apple developer key ID (10-character string).
KeyId string `protobuf:"bytes,2,opt,name=key_id,json=keyId,proto3" json:"key_id,omitempty"`
// Required. The Apple team ID (10-character string) owning the provisioning
// profile used to build your application.
TeamId string `protobuf:"bytes,3,opt,name=team_id,json=teamId,proto3" json:"team_id,omitempty"`
// contains filtered or unexported fields
}
Contains fields that are required to perform Apple-specific integrity checks.
func (*AppleDeveloperId) Descriptor
func (*AppleDeveloperId) Descriptor() ([]byte, []int)
Deprecated: Use AppleDeveloperId.ProtoReflect.Descriptor instead.
func (*AppleDeveloperId) GetKeyId
func (x *AppleDeveloperId) GetKeyId() string
func (*AppleDeveloperId) GetPrivateKey
func (x *AppleDeveloperId) GetPrivateKey() string
func (*AppleDeveloperId) GetTeamId
func (x *AppleDeveloperId) GetTeamId() string
func (*AppleDeveloperId) ProtoMessage
func (*AppleDeveloperId) ProtoMessage()
func (*AppleDeveloperId) ProtoReflect
func (x *AppleDeveloperId) ProtoReflect() protoreflect.Message
func (*AppleDeveloperId) Reset
func (x *AppleDeveloperId) Reset()
func (*AppleDeveloperId) String
func (x *AppleDeveloperId) String() string
Assessment
type Assessment struct {
// Output only. Identifier. The resource name for the Assessment in the format
// `projects/{project}/assessments/{assessment}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Optional. The event being assessed.
Event *Event `protobuf:"bytes,2,opt,name=event,proto3" json:"event,omitempty"`
// Output only. The risk analysis result for the event being assessed.
RiskAnalysis *RiskAnalysis `protobuf:"bytes,3,opt,name=risk_analysis,json=riskAnalysis,proto3" json:"risk_analysis,omitempty"`
// Output only. Properties of the provided event token.
TokenProperties *TokenProperties `protobuf:"bytes,4,opt,name=token_properties,json=tokenProperties,proto3" json:"token_properties,omitempty"`
// Optional. Account verification information for identity verification. The
// assessment event must include a token and site key to use this feature.
AccountVerification *AccountVerificationInfo `protobuf:"bytes,5,opt,name=account_verification,json=accountVerification,proto3" json:"account_verification,omitempty"`
// Output only. Assessment returned by account defender when an account
// identifier is provided.
AccountDefenderAssessment *AccountDefenderAssessment `protobuf:"bytes,6,opt,name=account_defender_assessment,json=accountDefenderAssessment,proto3" json:"account_defender_assessment,omitempty"`
// Optional. The private password leak verification field contains the
// parameters that are used to to check for leaks privately without sharing
// user credentials.
PrivatePasswordLeakVerification *PrivatePasswordLeakVerification `protobuf:"bytes,8,opt,name=private_password_leak_verification,json=privatePasswordLeakVerification,proto3" json:"private_password_leak_verification,omitempty"`
// Output only. Assessment returned when firewall policies belonging to the
// project are evaluated using the field firewall_policy_evaluation.
FirewallPolicyAssessment *FirewallPolicyAssessment `protobuf:"bytes,10,opt,name=firewall_policy_assessment,json=firewallPolicyAssessment,proto3" json:"firewall_policy_assessment,omitempty"`
// Output only. Assessment returned by Fraud Prevention when TransactionData
// is provided.
FraudPreventionAssessment *FraudPreventionAssessment `protobuf:"bytes,11,opt,name=fraud_prevention_assessment,json=fraudPreventionAssessment,proto3" json:"fraud_prevention_assessment,omitempty"`
// Output only. Fraud Signals specific to the users involved in a payment
// transaction.
FraudSignals *FraudSignals `protobuf:"bytes,13,opt,name=fraud_signals,json=fraudSignals,proto3" json:"fraud_signals,omitempty"`
// Output only. Assessment returned when a site key, a token, and a phone
// number as `user_id` are provided. Account defender and SMS toll fraud
// protection need to be enabled.
PhoneFraudAssessment *PhoneFraudAssessment `protobuf:"bytes,12,opt,name=phone_fraud_assessment,json=phoneFraudAssessment,proto3" json:"phone_fraud_assessment,omitempty"`
// Optional. The environment creating the assessment. This describes your
// environment (the system invoking CreateAssessment), NOT the environment of
// your user.
AssessmentEnvironment *AssessmentEnvironment `protobuf:"bytes,14,opt,name=assessment_environment,json=assessmentEnvironment,proto3" json:"assessment_environment,omitempty"`
// contains filtered or unexported fields
}
A reCAPTCHA Enterprise assessment resource.
func (*Assessment) Descriptor
func (*Assessment) Descriptor() ([]byte, []int)
Deprecated: Use Assessment.ProtoReflect.Descriptor instead.
func (*Assessment) GetAccountDefenderAssessment
func (x *Assessment) GetAccountDefenderAssessment() *AccountDefenderAssessment
func (*Assessment) GetAccountVerification
func (x *Assessment) GetAccountVerification() *AccountVerificationInfo
func (*Assessment) GetAssessmentEnvironment
func (x *Assessment) GetAssessmentEnvironment() *AssessmentEnvironment
func (*Assessment) GetEvent
func (x *Assessment) GetEvent() *Event
func (*Assessment) GetFirewallPolicyAssessment
func (x *Assessment) GetFirewallPolicyAssessment() *FirewallPolicyAssessment
func (*Assessment) GetFraudPreventionAssessment
func (x *Assessment) GetFraudPreventionAssessment() *FraudPreventionAssessment
func (*Assessment) GetFraudSignals
func (x *Assessment) GetFraudSignals() *FraudSignals
func (*Assessment) GetName
func (x *Assessment) GetName() string
func (*Assessment) GetPhoneFraudAssessment
func (x *Assessment) GetPhoneFraudAssessment() *PhoneFraudAssessment
func (*Assessment) GetPrivatePasswordLeakVerification
func (x *Assessment) GetPrivatePasswordLeakVerification() *PrivatePasswordLeakVerification
func (*Assessment) GetRiskAnalysis
func (x *Assessment) GetRiskAnalysis() *RiskAnalysis
func (*Assessment) GetTokenProperties
func (x *Assessment) GetTokenProperties() *TokenProperties
func (*Assessment) ProtoMessage
func (*Assessment) ProtoMessage()
func (*Assessment) ProtoReflect
func (x *Assessment) ProtoReflect() protoreflect.Message
func (*Assessment) Reset
func (x *Assessment) Reset()
func (*Assessment) String
func (x *Assessment) String() string
AssessmentEnvironment
type AssessmentEnvironment struct {
// Optional. Identifies the client module initiating the CreateAssessment
// request. This can be the link to the client module's project. Examples
// include:
// - "github.com/GoogleCloudPlatform/recaptcha-enterprise-google-tag-manager"
// - "cloud.google.com/recaptcha/docs/implement-waf-akamai"
// - "cloud.google.com/recaptcha/docs/implement-waf-cloudflare"
// - "wordpress.org/plugins/recaptcha-something"
Client string `protobuf:"bytes,1,opt,name=client,proto3" json:"client,omitempty"`
// Optional. The version of the client module. For example, "1.0.0".
Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
// contains filtered or unexported fields
}
The environment creating the assessment. This describes your environment (the system invoking CreateAssessment), NOT the environment of your user.
func (*AssessmentEnvironment) Descriptor
func (*AssessmentEnvironment) Descriptor() ([]byte, []int)
Deprecated: Use AssessmentEnvironment.ProtoReflect.Descriptor instead.
func (*AssessmentEnvironment) GetClient
func (x *AssessmentEnvironment) GetClient() string
func (*AssessmentEnvironment) GetVersion
func (x *AssessmentEnvironment) GetVersion() string
func (*AssessmentEnvironment) ProtoMessage
func (*AssessmentEnvironment) ProtoMessage()
func (*AssessmentEnvironment) ProtoReflect
func (x *AssessmentEnvironment) ProtoReflect() protoreflect.Message
func (*AssessmentEnvironment) Reset
func (x *AssessmentEnvironment) Reset()
func (*AssessmentEnvironment) String
func (x *AssessmentEnvironment) String() string
ChallengeMetrics
type ChallengeMetrics struct {
// Count of reCAPTCHA checkboxes or badges rendered. This is mostly equivalent
// to a count of pageloads for pages that include reCAPTCHA.
PageloadCount int64 `protobuf:"varint,1,opt,name=pageload_count,json=pageloadCount,proto3" json:"pageload_count,omitempty"`
// Count of nocaptchas (successful verification without a challenge) issued.
NocaptchaCount int64 `protobuf:"varint,2,opt,name=nocaptcha_count,json=nocaptchaCount,proto3" json:"nocaptcha_count,omitempty"`
// Count of submitted challenge solutions that were incorrect or otherwise
// deemed suspicious such that a subsequent challenge was triggered.
FailedCount int64 `protobuf:"varint,3,opt,name=failed_count,json=failedCount,proto3" json:"failed_count,omitempty"`
// Count of nocaptchas (successful verification without a challenge) plus
// submitted challenge solutions that were correct and resulted in
// verification.
PassedCount int64 `protobuf:"varint,4,opt,name=passed_count,json=passedCount,proto3" json:"passed_count,omitempty"`
// contains filtered or unexported fields
}
Metrics related to challenges.
func (*ChallengeMetrics) Descriptor
func (*ChallengeMetrics) Descriptor() ([]byte, []int)
Deprecated: Use ChallengeMetrics.ProtoReflect.Descriptor instead.
func (*ChallengeMetrics) GetFailedCount
func (x *ChallengeMetrics) GetFailedCount() int64
func (*ChallengeMetrics) GetNocaptchaCount
func (x *ChallengeMetrics) GetNocaptchaCount() int64
func (*ChallengeMetrics) GetPageloadCount
func (x *ChallengeMetrics) GetPageloadCount() int64
func (*ChallengeMetrics) GetPassedCount
func (x *ChallengeMetrics) GetPassedCount() int64
func (*ChallengeMetrics) ProtoMessage
func (*ChallengeMetrics) ProtoMessage()
func (*ChallengeMetrics) ProtoReflect
func (x *ChallengeMetrics) ProtoReflect() protoreflect.Message
func (*ChallengeMetrics) Reset
func (x *ChallengeMetrics) Reset()
func (*ChallengeMetrics) String
func (x *ChallengeMetrics) String() string
CreateAssessmentRequest
type CreateAssessmentRequest struct {
// Required. The name of the project in which the assessment is created,
// in the format `projects/{project}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. The assessment details.
Assessment *Assessment `protobuf:"bytes,2,opt,name=assessment,proto3" json:"assessment,omitempty"`
// contains filtered or unexported fields
}
The create assessment request message.
func (*CreateAssessmentRequest) Descriptor
func (*CreateAssessmentRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateAssessmentRequest.ProtoReflect.Descriptor instead.
func (*CreateAssessmentRequest) GetAssessment
func (x *CreateAssessmentRequest) GetAssessment() *Assessment
func (*CreateAssessmentRequest) GetParent
func (x *CreateAssessmentRequest) GetParent() string
func (*CreateAssessmentRequest) ProtoMessage
func (*CreateAssessmentRequest) ProtoMessage()
func (*CreateAssessmentRequest) ProtoReflect
func (x *CreateAssessmentRequest) ProtoReflect() protoreflect.Message
func (*CreateAssessmentRequest) Reset
func (x *CreateAssessmentRequest) Reset()
func (*CreateAssessmentRequest) String
func (x *CreateAssessmentRequest) String() string
CreateFirewallPolicyRequest
type CreateFirewallPolicyRequest struct {
// Required. The name of the project this policy applies to, in the format
// `projects/{project}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. Information to create the policy.
FirewallPolicy *FirewallPolicy `protobuf:"bytes,2,opt,name=firewall_policy,json=firewallPolicy,proto3" json:"firewall_policy,omitempty"`
// contains filtered or unexported fields
}
The create firewall policy request message.
func (*CreateFirewallPolicyRequest) Descriptor
func (*CreateFirewallPolicyRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateFirewallPolicyRequest.ProtoReflect.Descriptor instead.
func (*CreateFirewallPolicyRequest) GetFirewallPolicy
func (x *CreateFirewallPolicyRequest) GetFirewallPolicy() *FirewallPolicy
func (*CreateFirewallPolicyRequest) GetParent
func (x *CreateFirewallPolicyRequest) GetParent() string
func (*CreateFirewallPolicyRequest) ProtoMessage
func (*CreateFirewallPolicyRequest) ProtoMessage()
func (*CreateFirewallPolicyRequest) ProtoReflect
func (x *CreateFirewallPolicyRequest) ProtoReflect() protoreflect.Message
func (*CreateFirewallPolicyRequest) Reset
func (x *CreateFirewallPolicyRequest) Reset()
func (*CreateFirewallPolicyRequest) String
func (x *CreateFirewallPolicyRequest) String() string
CreateKeyRequest
type CreateKeyRequest struct {
// Required. The name of the project in which the key is created, in the
// format `projects/{project}`.
Parent string `protobuf:"bytes,1,opt,name=parent,proto3" json:"parent,omitempty"`
// Required. Information to create a reCAPTCHA Enterprise key.
Key *Key `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
// contains filtered or unexported fields
}
The create key request message.
func (*CreateKeyRequest) Descriptor
func (*CreateKeyRequest) Descriptor() ([]byte, []int)
Deprecated: Use CreateKeyRequest.ProtoReflect.Descriptor instead.
func (*CreateKeyRequest) GetKey
func (x *CreateKeyRequest) GetKey() *Key
func (*CreateKeyRequest) GetParent
func (x *CreateKeyRequest) GetParent() string
func (*CreateKeyRequest) ProtoMessage
func (*CreateKeyRequest) ProtoMessage()
func (*CreateKeyRequest) ProtoReflect
func (x *CreateKeyRequest) ProtoReflect() protoreflect.Message
func (*CreateKeyRequest) Reset
func (x *CreateKeyRequest) Reset()
func (*CreateKeyRequest) String
func (x *CreateKeyRequest) String() string
DeleteFirewallPolicyRequest
type DeleteFirewallPolicyRequest struct {
// Required. The name of the policy to be deleted, in the format
// `projects/{project}/firewallpolicies/{firewallpolicy}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The delete firewall policy request message.
func (*DeleteFirewallPolicyRequest) Descriptor
func (*DeleteFirewallPolicyRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteFirewallPolicyRequest.ProtoReflect.Descriptor instead.
func (*DeleteFirewallPolicyRequest) GetName
func (x *DeleteFirewallPolicyRequest) GetName() string
func (*DeleteFirewallPolicyRequest) ProtoMessage
func (*DeleteFirewallPolicyRequest) ProtoMessage()
func (*DeleteFirewallPolicyRequest) ProtoReflect
func (x *DeleteFirewallPolicyRequest) ProtoReflect() protoreflect.Message
func (*DeleteFirewallPolicyRequest) Reset
func (x *DeleteFirewallPolicyRequest) Reset()
func (*DeleteFirewallPolicyRequest) String
func (x *DeleteFirewallPolicyRequest) String() string
DeleteKeyRequest
type DeleteKeyRequest struct {
// Required. The name of the key to be deleted, in the format
// `projects/{project}/keys/{key}`.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// contains filtered or unexported fields
}
The delete key request message.
func (*DeleteKeyRequest) Descriptor
func (*DeleteKeyRequest) Descriptor() ([]byte, []int)
Deprecated: Use DeleteKeyRequest.ProtoReflect.Descriptor instead.
func (*DeleteKeyRequest) GetName
func (x *DeleteKeyRequest) GetName() string
func (*DeleteKeyRequest) ProtoMessage
func (*DeleteKeyRequest) ProtoMessage()
func (*DeleteKeyRequest) ProtoReflect
func (x *DeleteKeyRequest) ProtoReflect() protoreflect.Message
func (*DeleteKeyRequest) Reset
func (x *DeleteKeyRequest) Reset()
func (*DeleteKeyRequest) String
func (x *DeleteKeyRequest) String() string
EndpointVerificationInfo
type EndpointVerificationInfo struct {
// Types that are assignable to Endpoint:
//
// *EndpointVerificationInfo_EmailAddress
// *EndpointVerificationInfo_PhoneNumber
Endpoint isEndpointVerificationInfo_Endpoint `protobuf_oneof:"endpoint"`
// Output only. Token to provide to the client to trigger endpoint
// verification. It must be used within 15 minutes.
RequestToken string `protobuf:"bytes,3,opt,name=request_token,json=requestToken,proto3" json:"request_token,omitempty"`
// Output only. Timestamp of the last successful verification for the
// endpoint, if any.
LastVerificationTime *timestamppb.Timestamp `protobuf:"bytes,4,opt,name=last_verification_time,json=lastVerificationTime,proto3" json:"last_verification_time,omitempty"`
// contains filtered or unexported fields
}
Information about a verification endpoint that can be used for 2FA.
func (*EndpointVerificationInfo) Descriptor
func (*EndpointVerificationInfo) Descriptor() ([]byte, []int)
Deprecated: Use EndpointVerificationInfo.ProtoReflect.Descriptor instead.
func (*EndpointVerificationInfo) GetEmailAddress
func (x *EndpointVerificationInfo) GetEmailAddress() string
func (*EndpointVerificationInfo) GetEndpoint
func (m *EndpointVerificationInfo) GetEndpoint() isEndpointVerificationInfo_Endpoint
func (*EndpointVerificationInfo) GetLastVerificationTime
func (x *EndpointVerificationInfo) GetLastVerificationTime() *timestamppb.Timestamp
func (*EndpointVerificationInfo) GetPhoneNumber
func (x *EndpointVerificationInfo) GetPhoneNumber() string
func (*EndpointVerificationInfo) GetRequestToken
func (x *EndpointVerificationInfo) GetRequestToken() string
func (*EndpointVerificationInfo) ProtoMessage
func (*EndpointVerificationInfo) ProtoMessage()
func (*EndpointVerificationInfo) ProtoReflect
func (x *EndpointVerificationInfo) ProtoReflect() protoreflect.Message
func (*EndpointVerificationInfo) Reset
func (x *EndpointVerificationInfo) Reset()
func (*EndpointVerificationInfo) String
func (x *EndpointVerificationInfo) String() string
EndpointVerificationInfo_EmailAddress
type EndpointVerificationInfo_EmailAddress struct {
// Email address for which to trigger a verification request.
EmailAddress string `protobuf:"bytes,1,opt,name=email_address,json=emailAddress,proto3,oneof"`
}
EndpointVerificationInfo_PhoneNumber
type EndpointVerificationInfo_PhoneNumber struct {
// Phone number for which to trigger a verification request. Should be given
// in E.164 format.
PhoneNumber string `protobuf:"bytes,2,opt,name=phone_number,json=phoneNumber,proto3,oneof"`
}
Event
type Event struct {
// Optional. The user response token provided by the reCAPTCHA Enterprise
// client-side integration on your site.
Token string `protobuf:"bytes,1,opt,name=token,proto3" json:"token,omitempty"`
// Optional. The site key that was used to invoke reCAPTCHA Enterprise on your
// site and generate the token.
SiteKey string `protobuf:"bytes,2,opt,name=site_key,json=siteKey,proto3" json:"site_key,omitempty"`
// Optional. The user agent present in the request from the user's device
// related to this event.
UserAgent string `protobuf:"bytes,3,opt,name=user_agent,json=userAgent,proto3" json:"user_agent,omitempty"`
// Optional. The IP address in the request from the user's device related to
// this event.
UserIpAddress string `protobuf:"bytes,4,opt,name=user_ip_address,json=userIpAddress,proto3" json:"user_ip_address,omitempty"`
// Optional. The expected action for this type of event. This should be the
// same action provided at token generation time on client-side platforms
// already integrated with recaptcha enterprise.
ExpectedAction string `protobuf:"bytes,5,opt,name=expected_action,json=expectedAction,proto3" json:"expected_action,omitempty"`
// Optional. Deprecated: use `user_info.account_id` instead.
// Unique stable hashed user identifier for the request. The identifier must
// be hashed using hmac-sha256 with stable secret.
//
// Deprecated: Marked as deprecated in google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto.
HashedAccountId []byte `protobuf:"bytes,6,opt,name=hashed_account_id,json=hashedAccountId,proto3" json:"hashed_account_id,omitempty"`
// Optional. Flag for a reCAPTCHA express request for an assessment without a
// token. If enabled, `site_key` must reference an Express site key.
Express bool `protobuf:"varint,14,opt,name=express,proto3" json:"express,omitempty"`
// Optional. The URI resource the user requested that triggered an assessment.
RequestedUri string `protobuf:"bytes,8,opt,name=requested_uri,json=requestedUri,proto3" json:"requested_uri,omitempty"`
// Optional. Flag for running WAF token assessment.
// If enabled, the token must be specified, and have been created by a
// WAF-enabled key.
WafTokenAssessment bool `protobuf:"varint,9,opt,name=waf_token_assessment,json=wafTokenAssessment,proto3" json:"waf_token_assessment,omitempty"`
// Optional. JA3 fingerprint for SSL clients. To learn how to compute this
// fingerprint, please refer to https://github.com/salesforce/ja3.
Ja3 string `protobuf:"bytes,10,opt,name=ja3,proto3" json:"ja3,omitempty"`
// Optional. JA4 fingerprint for SSL clients. To learn how to compute this
// fingerprint, please refer to https://github.com/FoxIO-LLC/ja4.
Ja4 string `protobuf:"bytes,18,opt,name=ja4,proto3" json:"ja4,omitempty"`
// Optional. HTTP header information about the request.
Headers []string `protobuf:"bytes,11,rep,name=headers,proto3" json:"headers,omitempty"`
// Optional. Flag for enabling firewall policy config assessment.
// If this flag is enabled, the firewall policy is evaluated and a
// suggested firewall action is returned in the response.
FirewallPolicyEvaluation bool `protobuf:"varint,12,opt,name=firewall_policy_evaluation,json=firewallPolicyEvaluation,proto3" json:"firewall_policy_evaluation,omitempty"`
// Optional. Data describing a payment transaction to be assessed. Sending
// this data enables reCAPTCHA Enterprise Fraud Prevention and the
// FraudPreventionAssessment component in the response.
TransactionData *TransactionData `protobuf:"bytes,13,opt,name=transaction_data,json=transactionData,proto3" json:"transaction_data,omitempty"`
// Optional. Information about the user that generates this event, when they
// can be identified. They are often identified through the use of an account
// for logged-in requests or login/registration requests, or by providing user
// identifiers for guest actions like checkout.
UserInfo *UserInfo `protobuf:"bytes,15,opt,name=user_info,json=userInfo,proto3" json:"user_info,omitempty"`
// Optional. The Fraud Prevention setting for this assessment.
FraudPrevention Event_FraudPrevention `protobuf:"varint,17,opt,name=fraud_prevention,json=fraudPrevention,proto3,enum=google.cloud.recaptchaenterprise.v1.Event_FraudPrevention" json:"fraud_prevention,omitempty"`
// contains filtered or unexported fields
}
The event being assessed.
func (*Event) Descriptor
Deprecated: Use Event.ProtoReflect.Descriptor instead.
func (*Event) GetExpectedAction
func (*Event) GetExpress
func (*Event) GetFirewallPolicyEvaluation
func (*Event) GetFraudPrevention
func (x *Event) GetFraudPrevention() Event_FraudPrevention
func (*Event) GetHashedAccountId
Deprecated: Marked as deprecated in google/cloud/recaptchaenterprise/v1/recaptchaenterprise.proto.
func (*Event) GetHeaders
func (*Event) GetJa3
func (*Event) GetJa4
func (*Event) GetRequestedUri
func (*Event) GetSiteKey
func (*Event) GetToken
func (*Event) GetTransactionData
func (x *Event) GetTransactionData() *TransactionData
func (*Event) GetUserAgent
func (*Event) GetUserInfo
func (*Event) GetUserIpAddress
func (*Event) GetWafTokenAssessment
func (*Event) ProtoMessage
func (*Event) ProtoMessage()
func (*Event) ProtoReflect
func (x *Event) ProtoReflect() protoreflect.Message
func (*Event) Reset
func (x *Event) Reset()
func (*Event) String
Event_FraudPrevention
type Event_FraudPrevention int32
Setting that controls Fraud Prevention assessments.
Event_FRAUD_PREVENTION_UNSPECIFIED, Event_ENABLED, Event_DISABLED
const (
// Default, unspecified setting. `fraud_prevention_assessment` is returned
// if `transaction_data` is present in `Event` and Fraud Prevention is
// enabled in the Google Cloud console.
Event_FRAUD_PREVENTION_UNSPECIFIED Event_FraudPrevention = 0
// Enable Fraud Prevention for this assessment, if Fraud Prevention is
// enabled in the Google Cloud console.
Event_ENABLED Event_FraudPrevention = 1
// Disable Fraud Prevention for this assessment, regardless of the Google
// Cloud console settings.
Event_DISABLED Event_FraudPrevention = 2
)
func (Event_FraudPrevention) Descriptor
func (Event_FraudPrevention) Descriptor() protoreflect.EnumDescriptor
func (Event_FraudPrevention) Enum
func (x Event_FraudPrevention) Enum() *Event_FraudPrevention
func (Event_FraudPrevention) EnumDescriptor
func (Event_FraudPrevention) EnumDescriptor() ([]byte, []int)
Deprecated: Use Event_FraudPrevention.Descriptor instead.
func (Event_FraudPrevention) Number
func (x Event_FraudPrevention) Number() protoreflect.EnumNumber
func (Event_FraudPrevention) String
func (x Event_FraudPrevention) String() string
func (Event_FraudPrevention) Type
func (Event_FraudPrevention) Type() protoreflect.EnumType
ExpressKeySettings
type ExpressKeySettings struct {
// contains filtered or unexported fields
}
Settings specific to keys that can be used for reCAPTCHA Express.
func (*ExpressKeySettings) Descriptor
func (*ExpressKeySettings) Descriptor() ([]byte, []int)
Deprecated: Use ExpressKeySettings.ProtoReflect.Descriptor instead.
func (*ExpressKeySettings) ProtoMessage
func (*ExpressKeySettings) ProtoMessage()
func (*ExpressKeySettings) ProtoReflect
func (x *ExpressKeySettings) ProtoReflect() protoreflect.Message
func (*ExpressKeySettings) Reset
func (x *ExpressKeySettings) Reset()
func (*ExpressKeySettings) String
func (x *ExpressKeySettings) String() string
FirewallAction
type FirewallAction struct {
// Types that are assignable to FirewallActionOneof:
//
// *FirewallAction_Allow
// *FirewallAction_Block
// *FirewallAction_IncludeRecaptchaScript
// *FirewallAction_Redirect
// *FirewallAction_Substitute
// *FirewallAction_SetHeader
FirewallActionOneof isFirewallAction_FirewallActionOneof `protobuf_oneof:"firewall_action_oneof"`
// contains filtered or unexported fields
}
An individual action. Each action represents what to do if a policy matches.
func (*FirewallAction) Descriptor
func (*