SelfServiceTrees

Realm Operations

Self Service Tree resource contains a mapping between self service and authentication trees.

Resource path: /selfservice/trees

Resource version: 1.0

read

Read the configured tree mapping.

Usage:

am> read SelfServiceTrees --realm Realm

Global Operations

Resource path: /global-config/services/selfServiceTrees

Resource version: 1.0

getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

Usage:

am> action SelfServiceTrees --global --actionName getAllTypes

getCreatableTypes

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

Usage:

am> action SelfServiceTrees --global --actionName getCreatableTypes

nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

Usage:

am> action SelfServiceTrees --global --actionName nextdescendents

read

Usage:

am> read SelfServiceTrees --global

update

Usage:

am> update SelfServiceTrees --global --body body

Parameters:

--body

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

{
  "type" : "object",
  "properties" : {
    "defaults" : {
      "properties" : {
        "enabled" : {
          "title" : "Enabled",
          "description" : "",
          "propertyOrder" : 90,
          "required" : true,
          "type" : "boolean",
          "exampleValue" : ""
        },
        "treeMapping" : {
          "title" : "Tree Mapping",
          "description" : "Maps the self service function name (the key) to an Authentication Tree (the value).",
          "propertyOrder" : 100,
          "required" : true,
          "patternProperties" : {
            ".*" : {
              "type" : "string"
            }
          },
          "type" : "object",
          "exampleValue" : ""
        }
      },
      "type" : "object",
      "title" : "Realm Defaults"
    }
  }
}