reCAPTCHA token attributes for Google Cloud Armor

This document lists the reCAPTCHA action-tokens attributes and reCAPTCHA session-tokens attributes that you can use when configuring security policies for Google Cloud Armor.

reCAPTCHA action-tokens attributes

The following table lists the reCAPTCHA action-tokens attributes for Google Cloud Armor:

Attribute name Data type Description
score float The score from a reCAPTCHA token. A valid score ranges from 0.0 to 1.0. The score 1.0 indicates that the interaction poses low risk and is likely legitimate, whereas 0.0 indicates that the interaction poses high risk and might be fraudulent. For more information, see Interpreting scores.
captcha_status string The CAPTCHA status from a reCAPTCHA token. Following are the three possible statuses:
  • NONE: Challenges were not involved when assessing the user.
  • PASS: Challenges were involved, and the user solved them correctly.
  • FAIL: Challenges were involved, and the user failed to solve them.
action_name string action_name is the action parameter that you specified for a user interaction when calling grecaptcha.enterprise.execute(). For more information, see Action names.
key string key is the reCAPTCHA key (action-token key) that you created and used in this request. For more information, see reCAPTCHA keys overview.

reCAPTCHA session-tokens attributes

The following table lists the reCAPTCHA session-tokens attributes for Google Cloud Armor:

Attribute name Data type Description
Score float The score from a reCAPTCHA token. A valid score ranges from 0.0 to 1.0. The score 1.0 indicates that the interaction poses low risk and is likely legitimate, whereas 0.0 indicates that the interaction poses high risk and might be fraudulent. For more information, see Interpreting scores.
key string key is the reCAPTCHA key (session-token key) that you created and used in this request. For more information, see reCAPTCHA keys overview.

What's next