---
title: PageNode
description: Resource path:
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-pagenode
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-pagenode.html
section_ids:
  sec-amster-entity-pagenode-realm-ops: Realm Operations
  sec-amster-entity-pagenode-realm-ops-create: create
  sec-amster-entity-pagenode-realm-ops-delete: delete
  sec-amster-entity-pagenode-realm-ops-gettype: getType
  sec-amster-entity-pagenode-realm-ops-getupgradedconfig: getUpgradedConfig
  sec-amster-entity-pagenode-realm-ops-query: query
  sec-amster-entity-pagenode-realm-ops-read: read
  sec-amster-entity-pagenode-realm-ops-update: update
  sec-amster-entity-pagenode-realm-ops-versioninfo: versionInfo
---

# PageNode

## Realm Operations

Resource path:

```
/realm-config/authentication/authenticationtrees/nodes/PageNode/1.0
```

Resource version: `3.0`

### create

**Usage**

```
am> create PageNode --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:

  ```json
  {
    "$schema" : "http://json-schema.org/draft-04/schema#",
    "type" : "object",
    "properties" : {
      "pageHeader" : {
        "propertyOrder" : 100,
        "type" : "object",
        "title" : "Page Header",
        "description" : "Localisation overrides - as key fill shortcut for language (first will be used as default if not empty or \"Default header\" if empty), value is header for language defined by key",
        "exampleValue" : "",
        "patternProperties" : {
          ".*" : {
            "type" : "string"
          }
        }
      },
      "pageDescription" : {
        "propertyOrder" : 200,
        "type" : "object",
        "title" : "Page Description",
        "description" : "Localisation overrides - as key fill shortcut for language (first will be used as default if not empty or \"Default description\" if empty), value is description for language defined by key",
        "exampleValue" : "",
        "patternProperties" : {
          ".*" : {
            "type" : "string"
          }
        }
      },
      "stage" : {
        "propertyOrder" : 300,
        "type" : "string",
        "title" : "Stage",
        "description" : "An optional stage name to pass to the client to aid in rendering"
      },
      "nodes" : {
        "propertyOrder" : 400,
        "type" : "array",
        "title" : "Page Nodes",
        "description" : "The child nodes, in the order they are returned to the authentication client",
        "items" : {
          "type" : "object",
          "title" : "Child Node",
          "description" : "A node that is used in the page",
          "properties" : {
            "_id" : {
              "type" : "string",
              "title" : "Node ID",
              "description" : "ID of the child node"
            },
            "displayName" : {
              "type" : "string",
              "title" : "Display name",
              "description" : "The display name of the child node"
            },
            "nodeType" : {
              "type" : "string",
              "title" : "Node type",
              "description" : "The type of the child node"
            }
          }
        }
      }
    },
    "required" : [ "nodes" ]
  }
  ```

### delete

**Usage**

```
am> delete PageNode --realm Realm --id id
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

### getType

List information related to the node such as a name, description, tags and metadata.

**Usage**

```
am> action PageNode --realm Realm --actionName getType
```

### getUpgradedConfig

Get the upgraded configuration for the node type.

**Usage**

```
am> action PageNode --realm Realm --body body --actionName getUpgradedConfig --targetVersion targetVersion
```

**Parameters**

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "type" : "object",
    "title" : "The current configuration of the node type."
  }
  ```

* *\--targetVersion*

  \=== listOutcomes

List the available outcomes for the node type.

**Usage**

```
am> action PageNode --realm Realm --body body --actionName listOutcomes
```

**Parameters**

* *\--body*

  The resource in JSON format, described by the following JSON schema:

  ```json
  {
    "description" : "Some configuration of the node. This does not need to be complete against the configuration schema.",
    "type" : "object",
    "title" : "Node configuration"
  }
  ```

### query

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

**Usage**

```
am> query PageNode --realm Realm --filter filter
```

**Parameters**

* *\--filter*

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

### read

**Usage**

```
am> read PageNode --realm Realm --id id
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update PageNode --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:

  ```json
  {
    "$schema" : "http://json-schema.org/draft-04/schema#",
    "type" : "object",
    "properties" : {
      "pageHeader" : {
        "propertyOrder" : 100,
        "type" : "object",
        "title" : "Page Header",
        "description" : "Localisation overrides - as key fill shortcut for language (first will be used as default if not empty or \"Default header\" if empty), value is header for language defined by key",
        "exampleValue" : "",
        "patternProperties" : {
          ".*" : {
            "type" : "string"
          }
        }
      },
      "pageDescription" : {
        "propertyOrder" : 200,
        "type" : "object",
        "title" : "Page Description",
        "description" : "Localisation overrides - as key fill shortcut for language (first will be used as default if not empty or \"Default description\" if empty), value is description for language defined by key",
        "exampleValue" : "",
        "patternProperties" : {
          ".*" : {
            "type" : "string"
          }
        }
      },
      "stage" : {
        "propertyOrder" : 300,
        "type" : "string",
        "title" : "Stage",
        "description" : "An optional stage name to pass to the client to aid in rendering"
      },
      "nodes" : {
        "propertyOrder" : 400,
        "type" : "array",
        "title" : "Page Nodes",
        "description" : "The child nodes, in the order they are returned to the authentication client",
        "items" : {
          "type" : "object",
          "title" : "Child Node",
          "description" : "A node that is used in the page",
          "properties" : {
            "_id" : {
              "type" : "string",
              "title" : "Node ID",
              "description" : "ID of the child node"
            },
            "displayName" : {
              "type" : "string",
              "title" : "Display name",
              "description" : "The display name of the child node"
            },
            "nodeType" : {
              "type" : "string",
              "title" : "Node type",
              "description" : "The type of the child node"
            }
          }
        }
      }
    },
    "required" : [ "nodes" ]
  }
  ```

### versionInfo

List the versions available for the node type.

**Usage**

```
am> action PageNode --realm Realm --actionName versionInfo
```