ConfigurationProvider
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/ConfigProviderNode/1.0
Resource version: 3.0
create
Usage
am> create ConfigurationProvider --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" : { "script" : { "title" : "Script", "description" : "The configuration provider script to run to generate the configuration for the node.", "propertyOrder" : 200, "type" : "string", "exampleValue" : "" }, "scriptInputs" : { "title" : "Script Inputs", "description" : "A list of inputs required by the configuration script.", "propertyOrder" : 300, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" }, "nodeVersion" : { "title" : "Node Version", "description" : "The version of the node to imitate.", "propertyOrder" : 150, "type" : "integer", "exampleValue" : "" }, "nodeType" : { "title" : "Node Type", "description" : "The type of node to imitate. The list is restricted to node types with outcomes that are fixed or variable based on predefined values.", "propertyOrder" : 100, "type" : "string", "exampleValue" : "" } }, "required" : [ "script", "scriptInputs", "nodeVersion", "nodeType" ] }
delete
Usage
am> delete ConfigurationProvider --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 ConfigurationProvider --realm Realm --actionName getType
getUpgradedConfig
Get the upgraded configuration for the node type.
Usage
am> action ConfigurationProvider --realm Realm --body body --actionName getUpgradedConfig --targetVersion targetVersion
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "title" : "The current configuration of the node type." } - --targetVersion
-
=== listOutcomes
List the available outcomes for the node type.
Usage
am> action ConfigurationProvider --realm Realm --body body --actionName listOutcomes
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "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 ConfigurationProvider --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read ConfigurationProvider --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update ConfigurationProvider --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" : { "script" : { "title" : "Script", "description" : "The configuration provider script to run to generate the configuration for the node.", "propertyOrder" : 200, "type" : "string", "exampleValue" : "" }, "scriptInputs" : { "title" : "Script Inputs", "description" : "A list of inputs required by the configuration script.", "propertyOrder" : 300, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" }, "nodeVersion" : { "title" : "Node Version", "description" : "The version of the node to imitate.", "propertyOrder" : 150, "type" : "integer", "exampleValue" : "" }, "nodeType" : { "title" : "Node Type", "description" : "The type of node to imitate. The list is restricted to node types with outcomes that are fixed or variable based on predefined values.", "propertyOrder" : 100, "type" : "string", "exampleValue" : "" } }, "required" : [ "script", "scriptInputs", "nodeVersion", "nodeType" ] }