View Source GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1Event (google_api_recaptcha_enterprise v0.14.1)

The event being assessed.

Attributes

  • expectedAction (type: String.t, default: nil) - 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 (type: boolean(), default: nil) - Optional. Flag for a reCAPTCHA express request for an assessment without a token. If enabled, site_key must reference an Express site key.
  • firewallPolicyEvaluation (type: boolean(), default: nil) - 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.
  • fraudPrevention (type: String.t, default: nil) - Optional. The Fraud Prevention setting for this assessment.
  • hashedAccountId (type: String.t, default: nil) - 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 (type: list(String.t), default: nil) - Optional. HTTP header information about the request.
  • ja3 (type: String.t, default: nil) - Optional. JA3 fingerprint for SSL clients.
  • requestedUri (type: String.t, default: nil) - Optional. The URI resource the user requested that triggered an assessment.
  • siteKey (type: String.t, default: nil) - Optional. The site key that was used to invoke reCAPTCHA Enterprise on your site and generate the token.
  • token (type: String.t, default: nil) - Optional. The user response token provided by the reCAPTCHA Enterprise client-side integration on your site.
  • transactionData (type: GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1TransactionData.t, default: nil) - 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 (type: String.t, default: nil) - Optional. The user agent present in the request from the user's device related to this event.
  • userInfo (type: GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1UserInfo.t, default: nil) - 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 (type: String.t, default: nil) - Optional. The IP address in the request from the user's device related to this event.
  • wafTokenAssessment (type: boolean(), default: nil) - Optional. Flag for running WAF token assessment. If enabled, the token must be specified, and have been created by a WAF-enabled key.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() ::
  %GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1Event{
    expectedAction: String.t() | nil,
    express: boolean() | nil,
    firewallPolicyEvaluation: boolean() | nil,
    fraudPrevention: String.t() | nil,
    hashedAccountId: String.t() | nil,
    headers: [String.t()] | nil,
    ja3: String.t() | nil,
    requestedUri: String.t() | nil,
    siteKey: String.t() | nil,
    token: String.t() | nil,
    transactionData:
      GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1TransactionData.t()
      | nil,
    userAgent: String.t() | nil,
    userInfo:
      GoogleApi.RecaptchaEnterprise.V1.Model.GoogleCloudRecaptchaenterpriseV1UserInfo.t()
      | nil,
    userIpAddress: String.t() | nil,
    wafTokenAssessment: boolean() | nil
  }

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.