SelfServiceTreeConfig

Realm Operations

Resource path: /realm-config/services/selfServiceTrees

Resource version: 1.0

create

Usage:

am> create SelfServiceTreeConfig --realm Realm --body body

Parameters:

--body

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

{
  "type" : "object",
  "properties" : {
    "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" : ""
    },
    "enabled" : {
      "title" : "Enabled",
      "description" : "",
      "propertyOrder" : 90,
      "required" : true,
      "type" : "boolean",
      "exampleValue" : ""
    }
  }
}

delete

Usage:

am> delete SelfServiceTreeConfig --realm Realm

getAllTypes

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

Usage:

am> action SelfServiceTreeConfig --realm Realm --actionName getAllTypes

getCreatableTypes

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

Usage:

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

nextdescendents

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

Usage:

am> action SelfServiceTreeConfig --realm Realm --actionName nextdescendents

read

Usage:

am> read SelfServiceTreeConfig --realm Realm

update

Usage:

am> update SelfServiceTreeConfig --realm Realm --body body

Parameters:

--body

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

{
  "type" : "object",
  "properties" : {
    "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" : ""
    },
    "enabled" : {
      "title" : "Enabled",
      "description" : "",
      "propertyOrder" : 90,
      "required" : true,
      "type" : "boolean",
      "exampleValue" : ""
    }
  }
}