---
title: RetryLimitDecision
description: Resource path:
component: pingam
version: 8.1
page_id: pingam:entity-reference:sec-amster-entity-retrylimitdecision
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-retrylimitdecision.html
section_ids:
  sec-amster-entity-retrylimitdecision-realm-ops: Realm Operations
  sec-amster-entity-retrylimitdecision-realm-ops-create: create
  sec-amster-entity-retrylimitdecision-realm-ops-delete: delete
  sec-amster-entity-retrylimitdecision-realm-ops-gettype: getType
  sec-amster-entity-retrylimitdecision-realm-ops-getupgradedconfig: getUpgradedConfig
  sec-amster-entity-retrylimitdecision-realm-ops-query: query
  sec-amster-entity-retrylimitdecision-realm-ops-read: read
  sec-amster-entity-retrylimitdecision-realm-ops-update: update
  sec-amster-entity-retrylimitdecision-realm-ops-versioninfo: versionInfo
---

# RetryLimitDecision

## Realm Operations

Resource path:

```
/realm-config/authentication/authenticationtrees/nodes/RetryLimitDecisionNode/1.0
```

Resource version: `3.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:

  ```json
  {
    "type" : "object",
    "properties" : {
      "retryLimit" : {
        "title" : "Retry Limit",
        "description" : "The number of times to allow a retry.",
        "propertyOrder" : 100,
        "type" : "integer",
        "exampleValue" : ""
      },
      "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" : ""
      }
    },
    "required" : [ "retryLimit", "incrementUserAttributeOnFailure" ]
  }
  ```

### delete

**Usage**

```
am> delete RetryLimitDecision --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 RetryLimitDecision --realm Realm --actionName getType
```

### getUpgradedConfig

Get the upgraded configuration for the node type.

**Usage**

```
am> action RetryLimitDecision --realm Realm --body body --actionName getUpgradedConfig --targetVersion targetVersion
```

**Parameters**

* *\--body*

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

  ```json
  {
    "type" : "object",
    "title" : "The current configuration of the node type."
  }
  ```

* *\--targetVersion*

  \=== 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:

  ```json
  {
    "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 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:

  ```json
  {
    "type" : "object",
    "properties" : {
      "retryLimit" : {
        "title" : "Retry Limit",
        "description" : "The number of times to allow a retry.",
        "propertyOrder" : 100,
        "type" : "integer",
        "exampleValue" : ""
      },
      "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" : ""
      }
    },
    "required" : [ "retryLimit", "incrementUserAttributeOnFailure" ]
  }
  ```

### versionInfo

List the versions available for the node type.

**Usage**

```
am> action RetryLimitDecision --realm Realm --actionName versionInfo
```
