Amster

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:

{
  "type" : "object",
  "properties" : {
    "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. <br>Get or create your API key from the <strong>Google Cloud Console</strong> under <strong>APIs and Services > Credentials</strong>. <br>The label this property creates takes the form <code>am.authentication.nodes.captchaEnterprise.{{identifier}}.secret</code> where {{identifier}} is the string you specify. <br>The string can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}.",
      "propertyOrder" : 300,
      "type" : "string",
      "exampleValue" : ""
    },
    "captchaUri" : {
      "title" : "reCAPTCHA verification URL",
      "description" : "The URL to send the reCAPTCHA to for verification. <br>Only change this if Google update the URL used for reCAPTCHA verifications. <br>Default is <code>https://recaptchaenterprise.googleapis.com/v1</code>.",
      "propertyOrder" : 800,
      "type" : "string",
      "exampleValue" : ""
    },
    "scoreThreshold" : {
      "title" : "Score threshold",
      "description" : "Specifies the score threshold for determining if a user is likely to be a real person. <br>reCAPTCHA scores are between <code>0.0</code> and <code>1.0</code>, with higher scores indicating higher confidence that the user is a real person. <br>If the returned score is equal to or greater than the threshold the journey continues along the <code>true</code> outcome path.",
      "propertyOrder" : 400,
      "type" : "string",
      "exampleValue" : ""
    },
    "storeAssessmentResult" : {
      "title" : "Store reCAPTCHA assessment JSON",
      "description" : "Stores the assessment response JSON for future reference within the journey. <br>The node stores the JSON response in the <code>CaptchaEnterpriseNode.ASSESSMENT_RESULT</code> variable.",
      "propertyOrder" : 500,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "siteKey" : {
      "title" : "reCAPTCHA Site Key",
      "description" : "The ID of the reCAPTCHA key you created in the Google Cloud console. <br>The key can be for any platform type, \"Website\", \"Android app\", or \"iOS app\". <br>Sometimes referred to as a \"key ID\" in the Google Cloud console and documentation.",
      "propertyOrder" : 200,
      "type" : "string",
      "exampleValue" : ""
    },
    "storeErrors" : {
      "title" : "Store reCAPTCHA error messages",
      "description" : "Stores the error messages for future reference within the journey. <br>The node stores the error messages in the <code>CaptchaEnterpriseNode.FAILURE</code> variable.",
      "propertyOrder" : 600,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "apiUri" : {
      "title" : "JavaScript reCAPTCHA API URL",
      "description" : "The URL of the JavaScript file containing the reCAPTCHA API. <br>Only change this if Google release a new version of the JavaScript reCAPTCHA API. <br>Default is <code>https://www.google.com/recaptcha/enterprise.js</code>.",
      "propertyOrder" : 900,
      "type" : "string",
      "exampleValue" : ""
    },
    "divClass" : {
      "title" : "reCAPTCHA CSS class",
      "description" : "A CSS class to apply to the HTML elements that reCAPTCHA adds to JavaScript apps. <br>Default is <code>g-recaptcha</code>.",
      "propertyOrder" : 700,
      "type" : "string",
      "exampleValue" : ""
    },
    "projectId" : {
      "title" : "Google Cloud project ID",
      "description" : "The ID of the project that has Google reCAPTCHA enabled. <br>You can get the ID of your project in the Google Cloud console. <br>For example, <code>my-project-65746-07969469388</code>.",
      "propertyOrder" : 100,
      "type" : "string",
      "exampleValue" : ""
    }
  },
  "required" : [ "secretLabelIdentifier", "captchaUri", "scoreThreshold", "storeAssessmentResult", "siteKey", "storeErrors", "apiUri", "divClass", "projectId" ]
}

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:

{
  "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:

{
  "type" : "object",
  "properties" : {
    "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. <br>Get or create your API key from the <strong>Google Cloud Console</strong> under <strong>APIs and Services > Credentials</strong>. <br>The label this property creates takes the form <code>am.authentication.nodes.captchaEnterprise.{{identifier}}.secret</code> where {{identifier}} is the string you specify. <br>The string can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}.",
      "propertyOrder" : 300,
      "type" : "string",
      "exampleValue" : ""
    },
    "captchaUri" : {
      "title" : "reCAPTCHA verification URL",
      "description" : "The URL to send the reCAPTCHA to for verification. <br>Only change this if Google update the URL used for reCAPTCHA verifications. <br>Default is <code>https://recaptchaenterprise.googleapis.com/v1</code>.",
      "propertyOrder" : 800,
      "type" : "string",
      "exampleValue" : ""
    },
    "scoreThreshold" : {
      "title" : "Score threshold",
      "description" : "Specifies the score threshold for determining if a user is likely to be a real person. <br>reCAPTCHA scores are between <code>0.0</code> and <code>1.0</code>, with higher scores indicating higher confidence that the user is a real person. <br>If the returned score is equal to or greater than the threshold the journey continues along the <code>true</code> outcome path.",
      "propertyOrder" : 400,
      "type" : "string",
      "exampleValue" : ""
    },
    "storeAssessmentResult" : {
      "title" : "Store reCAPTCHA assessment JSON",
      "description" : "Stores the assessment response JSON for future reference within the journey. <br>The node stores the JSON response in the <code>CaptchaEnterpriseNode.ASSESSMENT_RESULT</code> variable.",
      "propertyOrder" : 500,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "siteKey" : {
      "title" : "reCAPTCHA Site Key",
      "description" : "The ID of the reCAPTCHA key you created in the Google Cloud console. <br>The key can be for any platform type, \"Website\", \"Android app\", or \"iOS app\". <br>Sometimes referred to as a \"key ID\" in the Google Cloud console and documentation.",
      "propertyOrder" : 200,
      "type" : "string",
      "exampleValue" : ""
    },
    "storeErrors" : {
      "title" : "Store reCAPTCHA error messages",
      "description" : "Stores the error messages for future reference within the journey. <br>The node stores the error messages in the <code>CaptchaEnterpriseNode.FAILURE</code> variable.",
      "propertyOrder" : 600,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "apiUri" : {
      "title" : "JavaScript reCAPTCHA API URL",
      "description" : "The URL of the JavaScript file containing the reCAPTCHA API. <br>Only change this if Google release a new version of the JavaScript reCAPTCHA API. <br>Default is <code>https://www.google.com/recaptcha/enterprise.js</code>.",
      "propertyOrder" : 900,
      "type" : "string",
      "exampleValue" : ""
    },
    "divClass" : {
      "title" : "reCAPTCHA CSS class",
      "description" : "A CSS class to apply to the HTML elements that reCAPTCHA adds to JavaScript apps. <br>Default is <code>g-recaptcha</code>.",
      "propertyOrder" : 700,
      "type" : "string",
      "exampleValue" : ""
    },
    "projectId" : {
      "title" : "Google Cloud project ID",
      "description" : "The ID of the project that has Google reCAPTCHA enabled. <br>You can get the ID of your project in the Google Cloud console. <br>For example, <code>my-project-65746-07969469388</code>.",
      "propertyOrder" : 100,
      "type" : "string",
      "exampleValue" : ""
    }
  },
  "required" : [ "secretLabelIdentifier", "captchaUri", "scoreThreshold", "storeAssessmentResult", "siteKey", "storeErrors", "apiUri", "divClass", "projectId" ]
}