GoogleCloudRecaptchaenterpriseV1Event

import type { GoogleCloudRecaptchaenterpriseV1Event } from "https://googleapis.deno.dev/v1/recaptchaenterprise:v1.ts";

The event being assessed.

interface GoogleCloudRecaptchaenterpriseV1Event {

expectedAction?: string;

express?: boolean;

firewallPolicyEvaluation?: boolean;

fraudPrevention?: "FRAUD_PREVENTION_UNSPECIFIED" | "ENABLED" | "DISABLED";

hashedAccountId?: Uint8Array;

headers?: string[];

ja3?: string;

requestedUri?: string;

siteKey?: string;

token?: string;

transactionData?: GoogleCloudRecaptchaenterpriseV1TransactionData;

userAgent?: string;

userInfo?: GoogleCloudRecaptchaenterpriseV1UserInfo;

userIpAddress?: string;

wafTokenAssessment?: boolean;

}

§Properties

expectedAction?: string

[src]

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.

express?: boolean

[src]

Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, site_key must reference a SCORE key with WAF feature set to EXPRESS.

firewallPolicyEvaluation?: boolean

[src]

Optional. Flag for enabling firewall policy config assessment. If this flag is enabled, the firewall policy will be evaluated and a suggested firewall action will be returned in the response.

fraudPrevention?: "FRAUD_PREVENTION_UNSPECIFIED" | "ENABLED" | "DISABLED"

[src]

Optional. The Fraud Prevention setting for this assessment.

hashedAccountId?: Uint8Array

[src]

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.

headers?: string[]

[src]

Optional. HTTP header information about the request.

ja3?: string

[src]

Optional. JA3 fingerprint for SSL clients.

requestedUri?: string

[src]

Optional. The URI resource the user requested that triggered an assessment.

siteKey?: string

[src]

Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.

token?: string

[src]

Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.

transactionData?: GoogleCloudRecaptchaenterpriseV1TransactionData

[src]

Optional. Data describing a payment transaction to be assessed. Sending this data enables reCAPTCHA Enterprise Fraud Prevention and the FraudPreventionAssessment component in the response.

userAgent?: string

[src]

Optional. The user agent present in the request from the user's device related to this event.

userInfo?: GoogleCloudRecaptchaenterpriseV1UserInfo

[src]

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.

userIpAddress?: string

[src]

Optional. The IP address in the request from the user's device related to this event.

wafTokenAssessment?: boolean

[src]

Optional. Flag for running WAF token assessment. If enabled, the token must be specified, and have been created by a WAF-enabled key.