PollingWaitNode

Realm Operations

Resource path:

/realm-config/authentication/authenticationtrees/nodes/PollingWaitNode

Resource version: 1.0

create

Usage

am> create PollingWaitNode --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" : {
    "secondsToWait" : {
      "title" : "Seconds To Wait",
      "description" : "How many seconds to wait before proceeding to the next node in the tree.",
      "propertyOrder" : 100,
      "type" : "integer",
      "exampleValue" : ""
    },
    "spamDetectionEnabled" : {
      "title" : "Enable Spam Detection",
      "description" : "Choose whether spam detection is enforced for this node. Creates a new outcome.",
      "propertyOrder" : 200,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "spamDetectionTolerance" : {
      "title" : "Spam Tolerance",
      "description" : "How many times a user may resubmit to this node before the authentication is failed.",
      "propertyOrder" : 300,
      "type" : "integer",
      "exampleValue" : ""
    },
    "exitMessage" : {
      "title" : "Exit Message",
      "description" : "Localisation overrides for the exit message. The whole string will be displayed as a link. This is a map of locale to message.",
      "propertyOrder" : 600,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "waitingMessage" : {
      "title" : "Waiting Message",
      "description" : "Localisation overrides for the waiting message. May use {{time}} to get the number of seconds remaining. This is a map of locale to message.",
      "propertyOrder" : 400,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "exitable" : {
      "title" : "Exitable",
      "description" : "Choose whether to display a link which allows the user to leave the node early. Creates a new outcome.",
      "propertyOrder" : 500,
      "type" : "boolean",
      "exampleValue" : ""
    }
  },
  "required" : [ "waitingMessage", "exitMessage", "spamDetectionTolerance", "spamDetectionEnabled", "secondsToWait", "exitable" ]
}

delete

Usage

am> delete PollingWaitNode --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 PollingWaitNode --realm Realm --actionName getAllTypes

getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

Usage

am> action PollingWaitNode --realm Realm --actionName getCreatableTypes

listOutcomes

List the available outcomes for the node type.

Usage

am> action PollingWaitNode --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 PollingWaitNode --realm Realm --actionName nextdescendents

query

Get the full list of instances of this collection. This query only supports _queryFilter=true filter.

Usage

am> query PollingWaitNode --realm Realm --filter filter

Parameters

--filter

A CREST formatted query filter, where "true" will query all.

read

Usage

am> read PollingWaitNode --realm Realm --id id

Parameters

--id

The unique identifier for the resource.

update

Usage

am> update PollingWaitNode --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" : {
    "secondsToWait" : {
      "title" : "Seconds To Wait",
      "description" : "How many seconds to wait before proceeding to the next node in the tree.",
      "propertyOrder" : 100,
      "type" : "integer",
      "exampleValue" : ""
    },
    "spamDetectionEnabled" : {
      "title" : "Enable Spam Detection",
      "description" : "Choose whether spam detection is enforced for this node. Creates a new outcome.",
      "propertyOrder" : 200,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "spamDetectionTolerance" : {
      "title" : "Spam Tolerance",
      "description" : "How many times a user may resubmit to this node before the authentication is failed.",
      "propertyOrder" : 300,
      "type" : "integer",
      "exampleValue" : ""
    },
    "exitMessage" : {
      "title" : "Exit Message",
      "description" : "Localisation overrides for the exit message. The whole string will be displayed as a link. This is a map of locale to message.",
      "propertyOrder" : 600,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "waitingMessage" : {
      "title" : "Waiting Message",
      "description" : "Localisation overrides for the waiting message. May use {{time}} to get the number of seconds remaining. This is a map of locale to message.",
      "propertyOrder" : 400,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "exitable" : {
      "title" : "Exitable",
      "description" : "Choose whether to display a link which allows the user to leave the node early. Creates a new outcome.",
      "propertyOrder" : 500,
      "type" : "boolean",
      "exampleValue" : ""
    }
  },
  "required" : [ "waitingMessage", "exitMessage", "spamDetectionTolerance", "spamDetectionEnabled", "secondsToWait", "exitable" ]
}