ZeroPageLoginCollector

Realm Operations

Resource path:

/realm-config/authentication/authenticationtrees/nodes/ZeroPageLoginNode

Resource version: 1.0

create

Usage

am> create ZeroPageLoginCollector --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" : {
    "passwordHeader" : {
      "title" : "Password Header Name",
      "description" : "",
      "propertyOrder" : 200,
      "type" : "string",
      "exampleValue" : ""
    },
    "referrerWhiteList" : {
      "title" : "Referer Whitelist",
      "description" : "",
      "propertyOrder" : 400,
      "items" : {
        "type" : "string"
      },
      "type" : "array",
      "exampleValue" : ""
    },
    "allowWithoutReferer" : {
      "title" : "Allow Without Referer",
      "description" : "",
      "propertyOrder" : 300,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "usernameHeader" : {
      "title" : "Username Header Name",
      "description" : "",
      "propertyOrder" : 100,
      "type" : "string",
      "exampleValue" : ""
    }
  },
  "required" : [ "allowWithoutReferer", "passwordHeader", "usernameHeader", "referrerWhiteList" ]
}

delete

Usage

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

getCreatableTypes

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

Usage

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

listOutcomes

List the available outcomes for the node type.

Usage

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

query

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

Usage

am> query ZeroPageLoginCollector --realm Realm --filter filter

Parameters

--filter

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

read

Usage

am> read ZeroPageLoginCollector --realm Realm --id id

Parameters

--id

The unique identifier for the resource.

update

Usage

am> update ZeroPageLoginCollector --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" : {
    "passwordHeader" : {
      "title" : "Password Header Name",
      "description" : "",
      "propertyOrder" : 200,
      "type" : "string",
      "exampleValue" : ""
    },
    "referrerWhiteList" : {
      "title" : "Referer Whitelist",
      "description" : "",
      "propertyOrder" : 400,
      "items" : {
        "type" : "string"
      },
      "type" : "array",
      "exampleValue" : ""
    },
    "allowWithoutReferer" : {
      "title" : "Allow Without Referer",
      "description" : "",
      "propertyOrder" : 300,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "usernameHeader" : {
      "title" : "Username Header Name",
      "description" : "",
      "propertyOrder" : 100,
      "type" : "string",
      "exampleValue" : ""
    }
  },
  "required" : [ "allowWithoutReferer", "passwordHeader", "usernameHeader", "referrerWhiteList" ]
}