Captcha

Realm Operations

Resource path: /realm-config/authentication/authenticationtrees/nodes/product-ReCaptchaNode

Resource version: 1.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" : {
    "reCaptchaUri" : {
      "title" : "CAPTCHA Verification URL",
      "description" : "URL to Verify CAPTCHA, defaults to the Google ReCAPTCHA verification URI.",
      "propertyOrder" : 300,
      "type" : "string",
      "exampleValue" : ""
    },
    "divClass" : {
      "title" : "Class of CAPTCHA HTML <div>",
      "description" : "The class of the HTML <div> element required by the captcha API, defaults to Google the ReCAPTCHA <div>.",
      "propertyOrder" : 500,
      "type" : "string",
      "exampleValue" : ""
    },
    "secretKey" : {
      "title" : "CAPTCHA Secret Key",
      "description" : "CAPTCHA Secret Key",
      "propertyOrder" : 200,
      "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" : ""
    }
  },
  "required" : [ "apiUri", "reCaptchaUri", "siteKey", "divClass", "secretKey" ]
}

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" : {
    "reCaptchaUri" : {
      "title" : "CAPTCHA Verification URL",
      "description" : "URL to Verify CAPTCHA, defaults to the Google ReCAPTCHA verification URI.",
      "propertyOrder" : 300,
      "type" : "string",
      "exampleValue" : ""
    },
    "divClass" : {
      "title" : "Class of CAPTCHA HTML <div>",
      "description" : "The class of the HTML <div> element required by the captcha API, defaults to Google the ReCAPTCHA <div>.",
      "propertyOrder" : 500,
      "type" : "string",
      "exampleValue" : ""
    },
    "secretKey" : {
      "title" : "CAPTCHA Secret Key",
      "description" : "CAPTCHA Secret Key",
      "propertyOrder" : 200,
      "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" : ""
    }
  },
  "required" : [ "apiUri", "reCaptchaUri", "siteKey", "divClass", "secretKey" ]
}