recaptchaenterprisepb

package
Version: v2.7.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 22, 2023 License: Apache-2.0 Imports: 10 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
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.

View Source 
var (
	AnnotateAssessmentRequest_Reason_name = map[int32]string{
		0: "REASON_UNSPECIFIED",
		1: "CHARGEBACK",
		8: "CHARGEBACK_FRAUD",
		9: "CHARGEBACK_DISPUTE",
		2: "PAYMENT_HEURISTICS",
		7: "INITIATED_TWO_FACTOR",
		3: "PASSED_TWO_FACTOR",
		4: "FAILED_TWO_FACTOR",
		5: "CORRECT_PASSWORD",
		6: "INCORRECT_PASSWORD",
	}
	AnnotateAssessmentRequest_Reason_value = map[string]int32{
		"REASON_UNSPECIFIED":   0,
		"CHARGEBACK":           1,
		"CHARGEBACK_FRAUD":     8,
		"CHARGEBACK_DISPUTE":   9,
		"PAYMENT_HEURISTICS":   2,
		"INITIATED_TWO_FACTOR": 7,
		"PASSED_TWO_FACTOR":    3,
		"FAILED_TWO_FACTOR":    4,
		"CORRECT_PASSWORD":     5,
		"INCORRECT_PASSWORD":   6,
	}
)

Enum value maps for AnnotateAssessmentRequest_Reason.

View Source 
var (
	Assessment_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",
	}
	Assessment_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,
	}
)

Enum value maps for Assessment_ClassificationReason.

View Source 
var (
	TokenProperties_InvalidReason_name = map[int32]string{
		0: "INVALID_REASON_UNSPECIFIED",
		1: "UNKNOWN_INVALID_REASON",
		2: "MALFORMED",
		3: "EXPIRED",
		4: "DUPE",
		5: "SITE_MISMATCH",
		6: "MISSING",
		7: "BROWSER_ERROR",
	}
	TokenProperties_InvalidReason_value = map[string]int32{
		"INVALID_REASON_UNSPECIFIED": 0,
		"UNKNOWN_INVALID_REASON":     1,
		"MALFORMED":                  2,
		"EXPIRED":                    3,
		"DUPE":                       4,
		"SITE_MISMATCH":              5,
		"MISSING":                    6,
		"BROWSER_ERROR":              7,
	}
)

Enum value maps for TokenProperties_InvalidReason.

View Source 
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.

View Source 
var File_google_cloud_recaptchaenterprise_v1beta1_recaptchaenterprise_proto protoreflect.FileDescriptor

Functions

func RegisterRecaptchaEnterpriseServiceV1Beta1Server 

func RegisterRecaptchaEnterpriseServiceV1Beta1Server(s *grpc.Server, srv RecaptchaEnterpriseServiceV1Beta1Server)

Types

type AccountDefenderAssessment 

type AccountDefenderAssessment struct {

	// Labels for this request.
	Labels []AccountDefenderAssessment_AccountDefenderLabel `` /* 166-byte string literal not displayed */
	// contains filtered or unexported fields
}

Account Defender risk assessment.

func (*AccountDefenderAssessment) Descriptor deprecated 

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

type AccountDefenderAssessment_AccountDefenderLabel 

type AccountDefenderAssessment_AccountDefenderLabel int32

Labels returned by Account Defender for this request. 

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 should be further
	// verified either via 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 could mean 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 could require
	// investigating.
	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 deprecated 

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 

func (AccountDefenderAssessment_AccountDefenderLabel) Type() protoreflect.EnumType

type AnnotateAssessmentRequest 

type AnnotateAssessmentRequest struct {

	// Required. The resource name of the Assessment, in the format
	// "projects/{project_number}/assessments/{assessment_id}".
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional. The annotation that will be 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 `` /* 157-byte string literal not displayed */
	// Optional. Optional reasons for the annotation that will be assigned to the Event.
	Reasons []AnnotateAssessmentRequest_Reason `` /* 154-byte string literal not displayed */
	// Optional. Optional unique stable hashed user identifier to apply to the assessment.
	// This is an alternative to setting the hashed_account_id in
	// CreateAssessment, for example when the account identifier is not yet known
	// in the initial request. It is recommended that the identifier is hashed
	// using hmac-sha256 with stable secret.
	HashedAccountId []byte `protobuf:"bytes,4,opt,name=hashed_account_id,json=hashedAccountId,proto3" json:"hashed_account_id,omitempty"`
	// contains filtered or unexported fields
}

The request message to annotate an Assessment.

func (*AnnotateAssessmentRequest) Descriptor deprecated 

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

Deprecated: Use AnnotateAssessmentRequest.ProtoReflect.Descriptor instead.

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) 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

type AnnotateAssessmentRequest_Annotation 

type AnnotateAssessmentRequest_Annotation int32

Enum that represents the types of annotations. 

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: Do not use.
	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: Do not use.
	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 deprecated 

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

type AnnotateAssessmentRequest_Reason 

type AnnotateAssessmentRequest_Reason int32

Enum that represents potential reasons for annotating an assessment. 

const (
	// Default unspecified reason.
	AnnotateAssessmentRequest_REASON_UNSPECIFIED AnnotateAssessmentRequest_Reason = 0
	// Indicates a chargeback issued for the transaction with no other details.
	// When possible, specify the type by using CHARGEBACK_FRAUD or
	// CHARGEBACK_DISPUTE instead.
	AnnotateAssessmentRequest_CHARGEBACK AnnotateAssessmentRequest_Reason = 1
	// Indicates a chargeback 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 a chargeback 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 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
)

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 deprecated 

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

type AnnotateAssessmentResponse 

type AnnotateAssessmentResponse struct {
	// contains filtered or unexported fields
}

Empty response for AnnotateAssessment.

func (*AnnotateAssessmentResponse) Descriptor deprecated 

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

type Assessment 

type Assessment struct {

	// Output only. The resource name for the Assessment in the format
	// "projects/{project_number}/assessments/{assessment_id}".
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The event being assessed.
	Event *Event `protobuf:"bytes,2,opt,name=event,proto3" json:"event,omitempty"`
	// Output only. Legitimate event score from 0.0 to 1.0.
	// (1.0 means very likely legitimate traffic while 0.0 means very likely
	// non-legitimate traffic).
	Score float32 `protobuf:"fixed32,3,opt,name=score,proto3" json:"score,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"`
	// Output only. Reasons contributing to the risk analysis verdict.
	Reasons []Assessment_ClassificationReason `` /* 153-byte string literal not displayed */
	// Information about the user's credentials used to check for leaks.
	// This feature is part of the Early Access Program (EAP). Exercise caution,
	// and do not deploy integrations based on this feature in a production
	// environment.
	PasswordLeakVerification *PasswordLeakVerification `` /* 135-byte string literal not displayed */
	// Assessment returned by Account Defender when a hashed_account_id is
	// provided.
	AccountDefenderAssessment *AccountDefenderAssessment `` /* 138-byte string literal not displayed */
	// contains filtered or unexported fields
}

A recaptcha assessment resource.

func (*Assessment) Descriptor deprecated 

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

Deprecated: Use Assessment.ProtoReflect.Descriptor instead.

func (*Assessment) GetAccountDefenderAssessment 

func (x *Assessment) GetAccountDefenderAssessment() *AccountDefenderAssessment

func (*Assessment) GetEvent 

func (x *Assessment) GetEvent() *Event

func (*Assessment) GetName 

func (x *Assessment) GetName() string

func (*Assessment) GetPasswordLeakVerification 

func (x *Assessment) GetPasswordLeakVerification() *PasswordLeakVerification

func (*Assessment) GetReasons 

func (x *Assessment) GetReasons() []Assessment_ClassificationReason

func (*Assessment) GetScore 

func (x *Assessment) GetScore() float32

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

type Assessment_ClassificationReason 

type Assessment_ClassificationReason int32

Reasons contributing to the risk analysis verdict. 

const (
	// Default unspecified type.
	Assessment_CLASSIFICATION_REASON_UNSPECIFIED Assessment_ClassificationReason = 0
	// Interactions matched the behavior of an automated agent.
	Assessment_AUTOMATION Assessment_ClassificationReason = 1
	// The event originated from an illegitimate environment.
	Assessment_UNEXPECTED_ENVIRONMENT Assessment_ClassificationReason = 2
	// Traffic volume from the event source is higher than normal.
	Assessment_TOO_MUCH_TRAFFIC Assessment_ClassificationReason = 3
	// Interactions with the site were significantly different than expected
	// patterns.
	Assessment_UNEXPECTED_USAGE_PATTERNS Assessment_ClassificationReason = 4
	// Too little traffic has been received from this site thus far to generate
	// quality risk analysis.
	Assessment_LOW_CONFIDENCE_SCORE Assessment_ClassificationReason = 5
)

func (Assessment_ClassificationReason) Descriptor 

func (Assessment_ClassificationReason) Descriptor() protoreflect.EnumDescriptor

func (Assessment_ClassificationReason) Enum 

func (x Assessment_ClassificationReason) Enum() *Assessment_ClassificationReason

func (Assessment_ClassificationReason) EnumDescriptor deprecated 

func (Assessment_ClassificationReason) EnumDescriptor() ([]byte, []int)

Deprecated: Use Assessment_ClassificationReason.Descriptor instead.

func (Assessment_ClassificationReason) Number 

func (x Assessment_ClassificationReason) Number() protoreflect.EnumNumber

func (Assessment_ClassificationReason) String 

func (x Assessment_ClassificationReason) String() string

func (Assessment_ClassificationReason) Type 

func (Assessment_ClassificationReason) Type() protoreflect.EnumType

type CreateAssessmentRequest 

type CreateAssessmentRequest struct {

	// Required. The name of the project in which the assessment will be created,
	// in the format "projects/{project_number}".
	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 deprecated 

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

type Event 

type Event struct {

	// Optional. The user response token provided by the reCAPTCHA 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 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. Optional unique stable hashed user identifier for the request. The
	// identifier should ideally be hashed using sha256 with stable secret.
	HashedAccountId []byte `protobuf:"bytes,6,opt,name=hashed_account_id,json=hashedAccountId,proto3" json:"hashed_account_id,omitempty"`
	// contains filtered or unexported fields
}

func (*Event) Descriptor deprecated 

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

Deprecated: Use Event.ProtoReflect.Descriptor instead.

func (*Event) GetExpectedAction 

func (x *Event) GetExpectedAction() string

func (*Event) GetHashedAccountId 

func (x *Event) GetHashedAccountId() []byte

func (*Event) GetSiteKey 

func (x *Event) GetSiteKey() string

func (*Event) GetToken 

func (x *Event) GetToken() string

func (*Event) GetUserAgent 

func (x *Event) GetUserAgent() string

func (*Event) GetUserIpAddress 

func (x *Event) GetUserIpAddress() string

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 

func (x *Event) String() string

type PasswordLeakVerification 

type PasswordLeakVerification struct {

	// Optional. Scrypt hash of the username+password that the customer wants to verify
	// against a known password leak.
	HashedUserCredentials []byte `` /* 126-byte string literal not displayed */
	// Output only. Whether or not the user's credentials are present in a known leak.
	CredentialsLeaked bool `protobuf:"varint,2,opt,name=credentials_leaked,json=credentialsLeaked,proto3" json:"credentials_leaked,omitempty"`
	// Optional. The username part of the user credentials for which we want to trigger a
	// leak check in canonicalized form. This is the same data used to create the
	// hashed_user_credentials on the customer side.
	CanonicalizedUsername string `protobuf:"bytes,3,opt,name=canonicalized_username,json=canonicalizedUsername,proto3" json:"canonicalized_username,omitempty"`
	// contains filtered or unexported fields
}

Password leak verification info.

func (*PasswordLeakVerification) Descriptor deprecated 

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

Deprecated: Use PasswordLeakVerification.ProtoReflect.Descriptor instead.

func (*PasswordLeakVerification) GetCanonicalizedUsername 

func (x *PasswordLeakVerification) GetCanonicalizedUsername() string

func (*PasswordLeakVerification) GetCredentialsLeaked 

func (x *PasswordLeakVerification) GetCredentialsLeaked() bool

func (*PasswordLeakVerification) GetHashedUserCredentials 

func (x *PasswordLeakVerification) GetHashedUserCredentials() []byte

func (*PasswordLeakVerification) ProtoMessage 

func (*PasswordLeakVerification) ProtoMessage()

func (*PasswordLeakVerification) ProtoReflect 

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

func (*PasswordLeakVerification) Reset 

func (x *PasswordLeakVerification) Reset()

func (*PasswordLeakVerification) String 

func (x *PasswordLeakVerification) String() string

type RecaptchaEnterpriseServiceV1Beta1Client 

type RecaptchaEnterpriseServiceV1Beta1Client interface {
	// Creates an Assessment of the likelihood an event is legitimate.
	CreateAssessment(ctx context.Context, in *CreateAssessmentRequest, opts ...grpc.CallOption) (*Assessment, error)
	// Annotates a previously created Assessment to provide additional information
	// on whether the event turned out to be authentic or fradulent.
	AnnotateAssessment(ctx context.Context, in *AnnotateAssessmentRequest, opts ...grpc.CallOption) (*AnnotateAssessmentResponse, error)
}

RecaptchaEnterpriseServiceV1Beta1Client is the client API for RecaptchaEnterpriseServiceV1Beta1 service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewRecaptchaEnterpriseServiceV1Beta1Client 

func NewRecaptchaEnterpriseServiceV1Beta1Client(cc grpc.ClientConnInterface) RecaptchaEnterpriseServiceV1Beta1Client

type RecaptchaEnterpriseServiceV1Beta1Server 

type RecaptchaEnterpriseServiceV1Beta1Server interface {
	// Creates an Assessment of the likelihood an event is legitimate.
	CreateAssessment(context.Context, *CreateAssessmentRequest) (*Assessment, error)
	// Annotates a previously created Assessment to provide additional information
	// on whether the event turned out to be authentic or fradulent.
	AnnotateAssessment(context.Context, *AnnotateAssessmentRequest) (*AnnotateAssessmentResponse, error)
}

RecaptchaEnterpriseServiceV1Beta1Server is the server API for RecaptchaEnterpriseServiceV1Beta1 service.

type TokenProperties 

type TokenProperties struct {

	// Whether the provided user response token is valid. When valid = false, the
	// reason could be specified in invalid_reason or it could also be due to
	// a user failing to solve a challenge or a sitekey mismatch (i.e the sitekey
	// used to generate the token was different than the one specified in the
	// assessment).
	Valid bool `protobuf:"varint,1,opt,name=valid,proto3" json:"valid,omitempty"`
	// Reason associated with the response when valid = false.
	InvalidReason TokenProperties_InvalidReason `` /* 177-byte string literal not displayed */
	// The timestamp corresponding to the generation of the token.
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// The hostname of the page on which the token was generated.
	Hostname string `protobuf:"bytes,4,opt,name=hostname,proto3" json:"hostname,omitempty"`
	// Action name provided at token generation.
	Action string `protobuf:"bytes,5,opt,name=action,proto3" json:"action,omitempty"`
	// contains filtered or unexported fields
}

func (*TokenProperties) Descriptor deprecated 

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

Deprecated: Use TokenProperties.ProtoReflect.Descriptor instead.

func (*TokenProperties) GetAction 

func (x *TokenProperties) GetAction() string

func (*TokenProperties) GetCreateTime 

func (x *TokenProperties) GetCreateTime() *timestamppb.Timestamp

func (*TokenProperties) GetHostname 

func (x *TokenProperties) GetHostname() string

func (*TokenProperties) GetInvalidReason 

func (x *TokenProperties) GetInvalidReason() TokenProperties_InvalidReason

func (*TokenProperties) GetValid 

func (x *TokenProperties) GetValid() bool

func (*TokenProperties) ProtoMessage 

func (*TokenProperties) ProtoMessage()

func (*TokenProperties) ProtoReflect 

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

func (*TokenProperties) Reset 

func (x *TokenProperties) Reset()

func (*TokenProperties) String 

func (x *TokenProperties) String() string

type TokenProperties_InvalidReason 

type TokenProperties_InvalidReason int32

Enum that represents the types of invalid token reasons. 

const (
	// Default unspecified type.
	TokenProperties_INVALID_REASON_UNSPECIFIED TokenProperties_InvalidReason = 0
	// If the failure reason was not accounted for.
	TokenProperties_UNKNOWN_INVALID_REASON TokenProperties_InvalidReason = 1
	// The provided user verification token was malformed.
	TokenProperties_MALFORMED TokenProperties_InvalidReason = 2
	// The user verification token had expired.
	TokenProperties_EXPIRED TokenProperties_InvalidReason = 3
	// The user verification had already been seen.
	TokenProperties_DUPE TokenProperties_InvalidReason = 4
	// The user verification token did not match the provided site key.
	// This may be a configuration error (e.g. development keys used in
	// production) or end users trying to use verification tokens from other
	// sites.
	//
	// Deprecated: Do not use.
	TokenProperties_SITE_MISMATCH TokenProperties_InvalidReason = 5
	// The user verification token was not present.  It is a required input.
	TokenProperties_MISSING TokenProperties_InvalidReason = 6
	// A retriable error (such as network failure) occurred on the browser.
	// Could easily be simulated by an attacker.
	TokenProperties_BROWSER_ERROR TokenProperties_InvalidReason = 7
)

func (TokenProperties_InvalidReason) Descriptor 

func (TokenProperties_InvalidReason) Descriptor() protoreflect.EnumDescriptor

func (TokenProperties_InvalidReason) Enum 

func (x TokenProperties_InvalidReason) Enum() *TokenProperties_InvalidReason

func (TokenProperties_InvalidReason) EnumDescriptor deprecated 

func (TokenProperties_InvalidReason) EnumDescriptor() ([]byte, []int)

Deprecated: Use TokenProperties_InvalidReason.Descriptor instead.

func (TokenProperties_InvalidReason) Number 

func (x TokenProperties_InvalidReason) Number() protoreflect.EnumNumber

func (TokenProperties_InvalidReason) String 

func (x TokenProperties_InvalidReason) String() string

func (TokenProperties_InvalidReason) Type 

func (TokenProperties_InvalidReason) Type() protoreflect.EnumType

type UnimplementedRecaptchaEnterpriseServiceV1Beta1Server 

type UnimplementedRecaptchaEnterpriseServiceV1Beta1Server struct {
}

UnimplementedRecaptchaEnterpriseServiceV1Beta1Server can be embedded to have forward compatible implementations.

func (*UnimplementedRecaptchaEnterpriseServiceV1Beta1Server) AnnotateAssessment 

func (*UnimplementedRecaptchaEnterpriseServiceV1Beta1Server) AnnotateAssessment(context.Context, *AnnotateAssessmentRequest) (*AnnotateAssessmentResponse, error)

func (*UnimplementedRecaptchaEnterpriseServiceV1Beta1Server) CreateAssessment 

func (*UnimplementedRecaptchaEnterpriseServiceV1Beta1Server) CreateAssessment(context.Context, *CreateAssessmentRequest) (*Assessment, error)

Source Files

View all

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.