PingAM

List latest node definitions

Use the listLatestNodeDefinitions action on the realm-config/authentication/authenticationtrees/nodes endpoint to get the most up-to-date definitions for all available nodes. This information is useful when creating or updating trees because it provides the current node details.

This endpoint returns a list of node definitions for the latest version of each node, including the following information:

  • Node version

  • Node schema

  • Configuration template

  • Node outcomes

The following example shows a partial response for the UsernameCollectorNode:

$ curl \
--request POST \
--header "iPlanetDirectoryPro: AQIC5wM…​TU3OQ*" \
--header "Content-Type: application/json" \
--header "Accept-API-Version: protocol=2.1,resource=3.0" \
"https://am.example.com:8443/am/json/realms/root/realms/alpha/realm-config/authentication/authenticationtrees/nodes?_action=listLatestNodeDefinitions"
{
    "result": {
      ...
        "UsernameCollectorNode": {
            "_id": "UsernameCollectorNode",
            "name": "Username Collector",
            "collection": true,
            "tags": [
                "basic authn",
                "basic authentication"
            ],
            "metadata": {
                "tags": [
                    "basic authn",
                    "basic authentication"
                ]
            },
            "help": "Prompts the user to enter their username.",
            "version": "2.0",
            "schema": {
                "type": "object",
                "properties": {
                    "prepopulate": {
                        "title": "Prepopulate Username",
                        "description": "If true, the input field is prepopulated with the 'username' value if present in the node state.",
                        "propertyOrder": 100,
                        "type": "boolean",
                        "exampleValue": "",
                        "default": false
                    }
                },
                "required": [
                    "prepopulate"
                ]
            },
            "template": {
                "prepopulate": false
            },
            "outcomes": [
                {
                    "id": "outcome",
                    "displayName": "Outcome"
                }
            ]
            }
        },
      ...
}