---
title: ReCAPTCHAEnterprise
description: Resource path:
component: pingam
version: 8
page_id: pingam:entity-reference:sec-amster-entity-recaptchaenterprise
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-recaptchaenterprise.html
llms_txt: https://docs.pingidentity.com/pingam/llms.txt
docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md
superseded_by: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-recaptchaenterprise.html
section_ids:
sec-amster-entity-recaptchaenterprise-realm-ops: Realm Operations
sec-amster-entity-recaptchaenterprise-realm-ops-create: create
sec-amster-entity-recaptchaenterprise-realm-ops-delete: delete
sec-amster-entity-recaptchaenterprise-realm-ops-getalltypes: getAllTypes
sec-amster-entity-recaptchaenterprise-realm-ops-getcreatabletypes: getCreatableTypes
sec-amster-entity-recaptchaenterprise-realm-ops-listoutcomes: listOutcomes
sec-amster-entity-recaptchaenterprise-realm-ops-nextdescendents: nextdescendents
sec-amster-entity-recaptchaenterprise-realm-ops-query: query
sec-amster-entity-recaptchaenterprise-realm-ops-read: read
sec-amster-entity-recaptchaenterprise-realm-ops-update: update
---
# ReCAPTCHAEnterprise
## Realm Operations
Resource path:
```
/realm-config/authentication/authenticationtrees/nodes/product-CaptchaEnterpriseNode
```
Resource version: `2.0`
### create
**Usage**
```
am> create ReCAPTCHAEnterprise --realm Realm --id id --body body
```
**Parameters**
* *\--id*
The unique identifier for the resource.
* *\--body*
The resource in JSON format, described by the following JSON schema:
```json
{
"type" : "object",
"properties" : {
"captchaUri" : {
"title" : "reCAPTCHA verification URL",
"description" : "The URL to send the reCAPTCHA to for verification.
Only change this if Google update the URL used for reCAPTCHA verifications.
Default is https://recaptchaenterprise.googleapis.com/v1.",
"propertyOrder" : 800,
"type" : "string",
"exampleValue" : ""
},
"siteKey" : {
"title" : "reCAPTCHA Site Key",
"description" : "The ID of the reCAPTCHA key you created in the Google Cloud console.
The key can be for any platform type, \"Website\", \"Android app\", or \"iOS app\".
Sometimes referred to as a \"key ID\" in the Google Cloud console and documentation.",
"propertyOrder" : 200,
"type" : "string",
"exampleValue" : ""
},
"apiUri" : {
"title" : "JavaScript reCAPTCHA API URL",
"description" : "The URL of the JavaScript file containing the reCAPTCHA API.
Only change this if Google release a new version of the JavaScript reCAPTCHA API.
Default is https://www.google.com/recaptcha/enterprise.js.",
"propertyOrder" : 900,
"type" : "string",
"exampleValue" : ""
},
"scoreThreshold" : {
"title" : "Score threshold",
"description" : "Specifies the score threshold for determining if a user is likely to be a real person.
reCAPTCHA scores are between 0.0 and 1.0, with higher scores indicating higher confidence that the user is a real person.
If the returned score is equal to or greater than the threshold the journey continues along the true outcome path.",
"propertyOrder" : 400,
"type" : "string",
"exampleValue" : ""
},
"divClass" : {
"title" : "reCAPTCHA CSS class",
"description" : "A CSS class to apply to the HTML elements that reCAPTCHA adds to JavaScript apps.
Default is g-recaptcha.",
"propertyOrder" : 700,
"type" : "string",
"exampleValue" : ""
},
"storeErrors" : {
"title" : "Store reCAPTCHA error messages",
"description" : "Stores the error messages for future reference within the journey.
The node stores the error messages in the CaptchaEnterpriseNode.FAILURE variable.",
"propertyOrder" : 600,
"type" : "boolean",
"exampleValue" : ""
},
"projectId" : {
"title" : "Google Cloud project ID",
"description" : "The ID of the project that has Google reCAPTCHA enabled.
You can get the ID of your project in the Google Cloud console.
For example, my-project-65746-07969469388.",
"propertyOrder" : 100,
"type" : "string",
"exampleValue" : ""
},
"storeAssessmentResult" : {
"title" : "Store reCAPTCHA assessment JSON",
"description" : "Stores the assessment response JSON for future reference within the journey.
The node stores the JSON response in the CaptchaEnterpriseNode.ASSESSMENT_RESULT variable.",
"propertyOrder" : 500,
"type" : "boolean",
"exampleValue" : ""
},
"secretLabelIdentifier" : {
"title" : "reCAPTCHA API key secret identifier",
"description" : "An identifier used to create a secret label for mapping to your Google reCAPTCHA API key in a secret store.
Get or create your API key from the Google Cloud Console under APIs and Services > Credentials.
The label this property creates takes the form am.authentication.nodes.captchaEnterprise.{{identifier}}.secret where {{identifier}} is the string you specify.
The string can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}.",
"propertyOrder" : 300,
"type" : "string",
"exampleValue" : ""
}
},
"required" : [ "captchaUri", "siteKey", "apiUri", "scoreThreshold", "divClass", "storeErrors", "projectId", "storeAssessmentResult", "secretLabelIdentifier" ]
}
```
### delete
**Usage**
```
am> delete ReCAPTCHAEnterprise --realm Realm --id id
```
**Parameters**
* *\--id*
The unique identifier for the resource.
### getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
**Usage**
```
am> action ReCAPTCHAEnterprise --realm Realm --actionName getAllTypes
```
### getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
**Usage**
```
am> action ReCAPTCHAEnterprise --realm Realm --actionName getCreatableTypes
```
### listOutcomes
List the available outcomes for the node type.
**Usage**
```
am> action ReCAPTCHAEnterprise --realm Realm --body body --actionName listOutcomes
```
**Parameters**
* *\--body*
The resource in JSON format, described by the following JSON schema:
```json
{
"type" : "object",
"title" : "Some configuration of the node. This does not need to be complete against the configuration schema."
}
```
### nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
**Usage**
```
am> action ReCAPTCHAEnterprise --realm Realm --actionName nextdescendents
```
### query
Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter.
**Usage**
```
am> query ReCAPTCHAEnterprise --realm Realm --filter filter
```
**Parameters**
* *\--filter*
A CREST formatted query filter, where "true" will query all.
### read
**Usage**
```
am> read ReCAPTCHAEnterprise --realm Realm --id id
```
**Parameters**
* *\--id*
The unique identifier for the resource.
### update
**Usage**
```
am> update ReCAPTCHAEnterprise --realm Realm --id id --body body
```
**Parameters**
* *\--id*
The unique identifier for the resource.
* *\--body*
The resource in JSON format, described by the following JSON schema:
```json
{
"type" : "object",
"properties" : {
"captchaUri" : {
"title" : "reCAPTCHA verification URL",
"description" : "The URL to send the reCAPTCHA to for verification.
Only change this if Google update the URL used for reCAPTCHA verifications.
Default is https://recaptchaenterprise.googleapis.com/v1.",
"propertyOrder" : 800,
"type" : "string",
"exampleValue" : ""
},
"siteKey" : {
"title" : "reCAPTCHA Site Key",
"description" : "The ID of the reCAPTCHA key you created in the Google Cloud console.
The key can be for any platform type, \"Website\", \"Android app\", or \"iOS app\".
Sometimes referred to as a \"key ID\" in the Google Cloud console and documentation.",
"propertyOrder" : 200,
"type" : "string",
"exampleValue" : ""
},
"apiUri" : {
"title" : "JavaScript reCAPTCHA API URL",
"description" : "The URL of the JavaScript file containing the reCAPTCHA API.
Only change this if Google release a new version of the JavaScript reCAPTCHA API.
Default is https://www.google.com/recaptcha/enterprise.js.",
"propertyOrder" : 900,
"type" : "string",
"exampleValue" : ""
},
"scoreThreshold" : {
"title" : "Score threshold",
"description" : "Specifies the score threshold for determining if a user is likely to be a real person.
reCAPTCHA scores are between 0.0 and 1.0, with higher scores indicating higher confidence that the user is a real person.
If the returned score is equal to or greater than the threshold the journey continues along the true outcome path.",
"propertyOrder" : 400,
"type" : "string",
"exampleValue" : ""
},
"divClass" : {
"title" : "reCAPTCHA CSS class",
"description" : "A CSS class to apply to the HTML elements that reCAPTCHA adds to JavaScript apps.
Default is g-recaptcha.",
"propertyOrder" : 700,
"type" : "string",
"exampleValue" : ""
},
"storeErrors" : {
"title" : "Store reCAPTCHA error messages",
"description" : "Stores the error messages for future reference within the journey.
The node stores the error messages in the CaptchaEnterpriseNode.FAILURE variable.",
"propertyOrder" : 600,
"type" : "boolean",
"exampleValue" : ""
},
"projectId" : {
"title" : "Google Cloud project ID",
"description" : "The ID of the project that has Google reCAPTCHA enabled.
You can get the ID of your project in the Google Cloud console.
For example, my-project-65746-07969469388.",
"propertyOrder" : 100,
"type" : "string",
"exampleValue" : ""
},
"storeAssessmentResult" : {
"title" : "Store reCAPTCHA assessment JSON",
"description" : "Stores the assessment response JSON for future reference within the journey.
The node stores the JSON response in the CaptchaEnterpriseNode.ASSESSMENT_RESULT variable.",
"propertyOrder" : 500,
"type" : "boolean",
"exampleValue" : ""
},
"secretLabelIdentifier" : {
"title" : "reCAPTCHA API key secret identifier",
"description" : "An identifier used to create a secret label for mapping to your Google reCAPTCHA API key in a secret store.
Get or create your API key from the Google Cloud Console under APIs and Services > Credentials.
The label this property creates takes the form am.authentication.nodes.captchaEnterprise.{{identifier}}.secret where {{identifier}} is the string you specify.
The string can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}.",
"propertyOrder" : 300,
"type" : "string",
"exampleValue" : ""
}
},
"required" : [ "captchaUri", "siteKey", "apiUri", "scoreThreshold", "divClass", "storeErrors", "projectId", "storeAssessmentResult", "secretLabelIdentifier" ]
}
```