Captcha
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/product-CaptchaNode
Resource version: 2.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:
{ "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" : "" }, "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" : "" }, "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" : "" }, "captchaUri" : { "title" : "CAPTCHA Verification URL", "description" : "URL to Verify CAPTCHA, defaults to the Google ReCAPTCHA verification URI.", "propertyOrder" : 300, "type" : "string", "exampleValue" : "" }, "siteKey" : { "title" : "CAPTCHA Site Key", "description" : "CAPTCHA Site Key", "propertyOrder" : 100, "type" : "string", "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" : "" }, "secretLabelIdentifier" : { "title" : "CAPTCHA Secret Label Identifier", "description" : "Identifier used to create a secret label for mapping to a secret in a secret store. <br>AM uses this identifier to create a specific secret label for this node. The secret label takes the form <code>am.authentication.nodes.captcha.{{identifier}}.secret</code> 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" : "" }, "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" : "" }, "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" : "" } }, "required" : [ "disableSubmission", "apiUri", "captchaUri", "siteKey", "scoreThreshold", "reCaptchaV3", "divClass" ] }
delete
Usage
am> delete Captcha --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 Captcha --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action Captcha --realm Realm --actionName getCreatableTypes
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:
{ "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 Captcha --realm Realm --actionName nextdescendents
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:
{ "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" : "" }, "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" : "" }, "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" : "" }, "captchaUri" : { "title" : "CAPTCHA Verification URL", "description" : "URL to Verify CAPTCHA, defaults to the Google ReCAPTCHA verification URI.", "propertyOrder" : 300, "type" : "string", "exampleValue" : "" }, "siteKey" : { "title" : "CAPTCHA Site Key", "description" : "CAPTCHA Site Key", "propertyOrder" : 100, "type" : "string", "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" : "" }, "secretLabelIdentifier" : { "title" : "CAPTCHA Secret Label Identifier", "description" : "Identifier used to create a secret label for mapping to a secret in a secret store. <br>AM uses this identifier to create a specific secret label for this node. The secret label takes the form <code>am.authentication.nodes.captcha.{{identifier}}.secret</code> 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" : "" }, "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" : "" }, "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" : "" } }, "required" : [ "disableSubmission", "apiUri", "captchaUri", "siteKey", "scoreThreshold", "reCaptchaV3", "divClass" ] }