RetryLimitDecision
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/RetryLimitDecisionNode
Resource version: 2.0
create
Usage
am> create RetryLimitDecision --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" : { "incrementUserAttributeOnFailure" : { "title" : "Save Retry Limit to User", "description" : "If true the number of failures will be persisted beyond the scope of the execution of this tree by saving them to an attribute on the user. If no user can be identified as part of the tree context then the execution of the tree will end with an error. If this is false then failures will be only be stored in the context of the current tree execution and will be lost if the tree execution is restarted.", "propertyOrder" : 200, "type" : "boolean", "exampleValue" : "" }, "retryLimit" : { "title" : "Retry Limit", "description" : "The number of times to allow a retry.", "propertyOrder" : 100, "type" : "integer", "exampleValue" : "" } }, "required" : [ "incrementUserAttributeOnFailure", "retryLimit" ] }
delete
Usage
am> delete RetryLimitDecision --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 RetryLimitDecision --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action RetryLimitDecision --realm Realm --actionName getCreatableTypes
listOutcomes
List the available outcomes for the node type.
Usage
am> action RetryLimitDecision --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 RetryLimitDecision --realm Realm --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query RetryLimitDecision --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read RetryLimitDecision --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update RetryLimitDecision --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" : { "incrementUserAttributeOnFailure" : { "title" : "Save Retry Limit to User", "description" : "If true the number of failures will be persisted beyond the scope of the execution of this tree by saving them to an attribute on the user. If no user can be identified as part of the tree context then the execution of the tree will end with an error. If this is false then failures will be only be stored in the context of the current tree execution and will be lost if the tree execution is restarted.", "propertyOrder" : 200, "type" : "boolean", "exampleValue" : "" }, "retryLimit" : { "title" : "Retry Limit", "description" : "The number of times to allow a retry.", "propertyOrder" : 100, "type" : "integer", "exampleValue" : "" } }, "required" : [ "incrementUserAttributeOnFailure", "retryLimit" ] }