Amster

PushWaitNode

Realm Operations

Resource path:

/realm-config/authentication/authenticationtrees/nodes/PushWaitNode

Resource version: 1.0

create

Usage

am> create PushWaitNode --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" : {
    "waitingMessage" : {
      "title" : "Waiting Message",
      "description" : "Localization overrides for the waiting message. May use {{time}} to get the number of seconds remaining. This is a map of locale to message.",
      "propertyOrder" : 200,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "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" : 400,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "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" : ""
    },
    "challengeMessage" : {
      "title" : "Push Challenge Message",
      "description" : "Localization overrides for the push challenge message. May use {{challenge}} to get the challenge answer. This is a map of locale to message.",
      "propertyOrder" : 300,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    }
  },
  "required" : [ "waitingMessage", "challengeMessage", "secondsToWait", "exitMessage" ]
}

delete

Usage

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

getCreatableTypes

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

Usage

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

listOutcomes

List the available outcomes for the node type.

Usage

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

query

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

Usage

am> query PushWaitNode --realm Realm --filter filter

Parameters

--filter

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

read

Usage

am> read PushWaitNode --realm Realm --id id

Parameters

--id

The unique identifier for the resource.

update

Usage

am> update PushWaitNode --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" : {
    "waitingMessage" : {
      "title" : "Waiting Message",
      "description" : "Localization overrides for the waiting message. May use {{time}} to get the number of seconds remaining. This is a map of locale to message.",
      "propertyOrder" : 200,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "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" : 400,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "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" : ""
    },
    "challengeMessage" : {
      "title" : "Push Challenge Message",
      "description" : "Localization overrides for the push challenge message. May use {{challenge}} to get the challenge answer. This is a map of locale to message.",
      "propertyOrder" : 300,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    }
  },
  "required" : [ "waitingMessage", "challengeMessage", "secondsToWait", "exitMessage" ]
}
Copyright © 2010-2024 ForgeRock, all rights reserved.