KBAVerification
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/KbaVerifyNode
Resource version: 1.0
create
Usage
am> create KBAVerification --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" : { "kbaInfoAttribute" : { "title" : "KBA Attribute", "description" : "The attribute in the user object in IDM where KBA questions and answers are stored.", "propertyOrder" : 100, "type" : "string", "exampleValue" : "" }, "identityAttribute" : { "title" : "Identity Attribute", "description" : "The IDM attribute used to identify the object in a search, e.g. userName.", "propertyOrder" : 200, "type" : "string", "exampleValue" : "" } }, "required" : [ "identityAttribute", "kbaInfoAttribute" ] }
delete
Usage
am> delete KBAVerification --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 KBAVerification --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action KBAVerification --realm Realm --actionName getCreatableTypes
listOutcomes
List the available outcomes for the node type.
Usage
am> action KBAVerification --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 KBAVerification --realm Realm --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query KBAVerification --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read KBAVerification --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update KBAVerification --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" : { "kbaInfoAttribute" : { "title" : "KBA Attribute", "description" : "The attribute in the user object in IDM where KBA questions and answers are stored.", "propertyOrder" : 100, "type" : "string", "exampleValue" : "" }, "identityAttribute" : { "title" : "Identity Attribute", "description" : "The IDM attribute used to identify the object in a search, e.g. userName.", "propertyOrder" : 200, "type" : "string", "exampleValue" : "" } }, "required" : [ "identityAttribute", "kbaInfoAttribute" ] }