KBADefinition
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/KbaCreateNode
Resource version: 1.0
create
Usage
am> create KBADefinition --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" : { "allowUserDefinedQuestions" : { "title" : "Allow User-Defined Questions", "description" : "When enabled, users are able to create their own KBA questions.", "propertyOrder" : 200, "type" : "boolean", "exampleValue" : "" }, "message" : { "title" : "Purpose Message", "description" : "Localised message describing the purpose of the data requested from the user.", "propertyOrder" : 100, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" } }, "required" : [ "message", "allowUserDefinedQuestions" ] }
delete
Usage
am> delete KBADefinition --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
getAllTypes
Obtain the collection of all secondary configuration types related to the resource.
Usage
am> action KBADefinition --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action KBADefinition --realm Realm --actionName getCreatableTypes
listOutcomes
List the available outcomes for the node type.
Usage
am> action KBADefinition --realm Realm --body body --actionName listOutcomes
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "title" : "Some configuration of the node. This does not need to be complete against the configuration schema." }
nextdescendents
Obtain the collection of secondary configuration instances that have been added to the resource.
Usage
am> action KBADefinition --realm Realm --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query KBADefinition --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read KBADefinition --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update KBADefinition --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" : { "allowUserDefinedQuestions" : { "title" : "Allow User-Defined Questions", "description" : "When enabled, users are able to create their own KBA questions.", "propertyOrder" : 200, "type" : "boolean", "exampleValue" : "" }, "message" : { "title" : "Purpose Message", "description" : "Localised message describing the purpose of the data requested from the user.", "propertyOrder" : 100, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" } }, "required" : [ "message", "allowUserDefinedQuestions" ] }