---
title: Captcha
description: Resource path:
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-captcha
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-captcha.html
section_ids:
sec-amster-entity-captcha-realm-ops: Realm Operations
sec-amster-entity-captcha-realm-ops-create: create
sec-amster-entity-captcha-realm-ops-delete: delete
sec-amster-entity-captcha-realm-ops-gettype: getType
sec-amster-entity-captcha-realm-ops-getupgradedconfig: getUpgradedConfig
sec-amster-entity-captcha-realm-ops-query: query
sec-amster-entity-captcha-realm-ops-read: read
sec-amster-entity-captcha-realm-ops-update: update
sec-amster-entity-captcha-realm-ops-versioninfo: versionInfo
---
# Captcha
## Realm Operations
Resource path:
```
/realm-config/authentication/authenticationtrees/nodes/product-CaptchaNode/1.0
```
Resource version: `3.0`
### create
**Usage**
```
am> create Captcha --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" : {
"disableSubmission" : {
"title" : "Disable submission until verified",
"description" : "If this is selected, form submission is disabled until CAPTCHA verification succeeds.",
"propertyOrder" : 800,
"type" : "boolean",
"exampleValue" : ""
},
"scoreThreshold" : {
"title" : "Score Threshold",
"description" : "Specifies the score threshold for determining if a user is likely to be a real person. CAPTCHA scores received will be between 0.0 and 1.0. The higher the score, the more likely the user is a real person. This score is not provided by all CAPTCHA implementations, please check the documentation for your vendor.",
"propertyOrder" : 700,
"type" : "string",
"exampleValue" : ""
},
"divClass" : {
"title" : "Class of CAPTCHA HTML Element",
"description" : "The class of the HTML element required by the captcha API, defaults to the value for Google ReCAPTCHA.",
"propertyOrder" : 500,
"type" : "string",
"exampleValue" : ""
},
"secretKey" : {
"title" : "CAPTCHA Secret Key",
"description" : "CAPTCHA Secret Key. This property is deprecated. Use the CAPTCHA Secret Label Identifier instead. If you set a CAPTCHA Secret Label Identifier and AM finds a matching secret in a secret store, the CAPTCHA Secret Key is ignored.",
"propertyOrder" : 200,
"type" : "string",
"exampleValue" : ""
},
"secretLabelIdentifier" : {
"title" : "CAPTCHA Secret Label Identifier",
"description" : "Identifier used to create a secret label for mapping to a secret in a secret store.
AM uses this identifier to create a specific secret label for this node. The secret label takes the form am.authentication.nodes.captcha.{{identifier}}.secret where {{identifier}} is the value of CAPTCHA Secret Label Identifier. The identifier can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}. If you set a CAPTCHA Secret Label Identifier and AM finds a matching secret in a secret store, the CAPTCHA Secret Key is ignored.",
"propertyOrder" : 250,
"type" : "string",
"exampleValue" : ""
},
"siteKey" : {
"title" : "CAPTCHA Site Key",
"description" : "CAPTCHA Site Key",
"propertyOrder" : 100,
"type" : "string",
"exampleValue" : ""
},
"apiUri" : {
"title" : "CAPTCHA API URL",
"description" : "The URL of the JavaScript to load the CAPTCHA verification, defaults to the Google ReCAPTCHA API.",
"propertyOrder" : 400,
"type" : "string",
"exampleValue" : ""
},
"captchaUri" : {
"title" : "CAPTCHA Verification URL",
"description" : "URL to Verify CAPTCHA, defaults to the Google ReCAPTCHA verification URI.",
"propertyOrder" : 300,
"type" : "string",
"exampleValue" : ""
},
"reCaptchaV3" : {
"title" : "ReCaptcha V3 Node",
"description" : "If this is selected then a frictionless captcha will be assumed, leaving no interactive Captcha elements on the page.",
"propertyOrder" : 600,
"type" : "boolean",
"exampleValue" : ""
}
},
"required" : [ "disableSubmission", "scoreThreshold", "divClass", "siteKey", "apiUri", "captchaUri", "reCaptchaV3" ]
}
```
### delete
**Usage**
```
am> delete Captcha --realm Realm --id id
```
**Parameters**
* *\--id*
The unique identifier for the resource.
### getType
List information related to the node such as a name, description, tags and metadata.
**Usage**
```
am> action Captcha --realm Realm --actionName getType
```
### getUpgradedConfig
Get the upgraded configuration for the node type.
**Usage**
```
am> action Captcha --realm Realm --body body --actionName getUpgradedConfig --targetVersion targetVersion
```
**Parameters**
* *\--body*
The resource in JSON format, described by the following JSON schema:
```json
{
"type" : "object",
"title" : "The current configuration of the node type."
}
```
* *\--targetVersion*
\=== listOutcomes
List the available outcomes for the node type.
**Usage**
```
am> action Captcha --realm Realm --body body --actionName listOutcomes
```
**Parameters**
* *\--body*
The resource in JSON format, described by the following JSON schema:
```json
{
"description" : "Some configuration of the node. This does not need to be complete against the configuration schema.",
"type" : "object",
"title" : "Node configuration"
}
```
### query
Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter.
**Usage**
```
am> query Captcha --realm Realm --filter filter
```
**Parameters**
* *\--filter*
A CREST formatted query filter, where "true" will query all.
### read
**Usage**
```
am> read Captcha --realm Realm --id id
```
**Parameters**
* *\--id*
The unique identifier for the resource.
### update
**Usage**
```
am> update Captcha --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" : {
"disableSubmission" : {
"title" : "Disable submission until verified",
"description" : "If this is selected, form submission is disabled until CAPTCHA verification succeeds.",
"propertyOrder" : 800,
"type" : "boolean",
"exampleValue" : ""
},
"scoreThreshold" : {
"title" : "Score Threshold",
"description" : "Specifies the score threshold for determining if a user is likely to be a real person. CAPTCHA scores received will be between 0.0 and 1.0. The higher the score, the more likely the user is a real person. This score is not provided by all CAPTCHA implementations, please check the documentation for your vendor.",
"propertyOrder" : 700,
"type" : "string",
"exampleValue" : ""
},
"divClass" : {
"title" : "Class of CAPTCHA HTML Element",
"description" : "The class of the HTML element required by the captcha API, defaults to the value for Google ReCAPTCHA.",
"propertyOrder" : 500,
"type" : "string",
"exampleValue" : ""
},
"secretKey" : {
"title" : "CAPTCHA Secret Key",
"description" : "CAPTCHA Secret Key. This property is deprecated. Use the CAPTCHA Secret Label Identifier instead. If you set a CAPTCHA Secret Label Identifier and AM finds a matching secret in a secret store, the CAPTCHA Secret Key is ignored.",
"propertyOrder" : 200,
"type" : "string",
"exampleValue" : ""
},
"secretLabelIdentifier" : {
"title" : "CAPTCHA Secret Label Identifier",
"description" : "Identifier used to create a secret label for mapping to a secret in a secret store.
AM uses this identifier to create a specific secret label for this node. The secret label takes the form am.authentication.nodes.captcha.{{identifier}}.secret where {{identifier}} is the value of CAPTCHA Secret Label Identifier. The identifier can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}. If you set a CAPTCHA Secret Label Identifier and AM finds a matching secret in a secret store, the CAPTCHA Secret Key is ignored.",
"propertyOrder" : 250,
"type" : "string",
"exampleValue" : ""
},
"siteKey" : {
"title" : "CAPTCHA Site Key",
"description" : "CAPTCHA Site Key",
"propertyOrder" : 100,
"type" : "string",
"exampleValue" : ""
},
"apiUri" : {
"title" : "CAPTCHA API URL",
"description" : "The URL of the JavaScript to load the CAPTCHA verification, defaults to the Google ReCAPTCHA API.",
"propertyOrder" : 400,
"type" : "string",
"exampleValue" : ""
},
"captchaUri" : {
"title" : "CAPTCHA Verification URL",
"description" : "URL to Verify CAPTCHA, defaults to the Google ReCAPTCHA verification URI.",
"propertyOrder" : 300,
"type" : "string",
"exampleValue" : ""
},
"reCaptchaV3" : {
"title" : "ReCaptcha V3 Node",
"description" : "If this is selected then a frictionless captcha will be assumed, leaving no interactive Captcha elements on the page.",
"propertyOrder" : 600,
"type" : "boolean",
"exampleValue" : ""
}
},
"required" : [ "disableSubmission", "scoreThreshold", "divClass", "siteKey", "apiUri", "captchaUri", "reCaptchaV3" ]
}
```
### versionInfo
List the versions available for the node type.
**Usage**
```
am> action Captcha --realm Realm --actionName versionInfo
```