Amster

QueryParameterNode

Realm Operations

Resource path:

/realm-config/authentication/authenticationtrees/nodes/QueryParameterNode

Resource version: 1.0

create

Usage

am> create QueryParameterNode --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" : {
    "allowedQueryParameters" : {
      "title" : "Allowed query parameters",
      "description" : "A list of key-value pairs. KEY is the query parameter name and VALUE is the shared state property name.",
      "propertyOrder" : 100,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "queryParametersToBeDelimited" : {
      "title" : "Allowed query parameters to be delimited",
      "description" : "A list of the \"Allowed query parameters\" that can take multiple values, and whose values you want to store in the shared state in a comma-delimited list. If you don't delimit the values of a multi-valued query parameter, the node stores the values in the shared state as a single string value.",
      "propertyOrder" : 200,
      "items" : {
        "type" : "string"
      },
      "type" : "array",
      "exampleValue" : ""
    }
  },
  "required" : [ "allowedQueryParameters", "queryParametersToBeDelimited" ]
}

delete

Usage

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

getCreatableTypes

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

Usage

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

listOutcomes

List the available outcomes for the node type.

Usage

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

query

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

Usage

am> query QueryParameterNode --realm Realm --filter filter

Parameters

--filter

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

read

Usage

am> read QueryParameterNode --realm Realm --id id

Parameters

--id

The unique identifier for the resource.

update

Usage

am> update QueryParameterNode --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" : {
    "allowedQueryParameters" : {
      "title" : "Allowed query parameters",
      "description" : "A list of key-value pairs. KEY is the query parameter name and VALUE is the shared state property name.",
      "propertyOrder" : 100,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "queryParametersToBeDelimited" : {
      "title" : "Allowed query parameters to be delimited",
      "description" : "A list of the \"Allowed query parameters\" that can take multiple values, and whose values you want to store in the shared state in a comma-delimited list. If you don't delimit the values of a multi-valued query parameter, the node stores the values in the shared state as a single string value.",
      "propertyOrder" : 200,
      "items" : {
        "type" : "string"
      },
      "type" : "array",
      "exampleValue" : ""
    }
  },
  "required" : [ "allowedQueryParameters", "queryParametersToBeDelimited" ]
}
Copyright © 2010-2024 ForgeRock, all rights reserved.