---
title: PersistentCookieDecision
description: Resource path:
component: pingam
version: 7.4
page_id: pingam:entity-reference:sec-amster-entity-persistentcookiedecision
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-persistentcookiedecision.html
llms_txt: https://docs.pingidentity.com/pingam/llms.txt
docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md
superseded_by: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-persistentcookiedecision.html
section_ids:
  sec-amster-entity-persistentcookiedecision-realm-ops: Realm Operations
  sec-amster-entity-persistentcookiedecision-realm-ops-create: create
  sec-amster-entity-persistentcookiedecision-realm-ops-delete: delete
  sec-amster-entity-persistentcookiedecision-realm-ops-getalltypes: getAllTypes
  sec-amster-entity-persistentcookiedecision-realm-ops-getcreatabletypes: getCreatableTypes
  sec-amster-entity-persistentcookiedecision-realm-ops-listoutcomes: listOutcomes
  sec-amster-entity-persistentcookiedecision-realm-ops-nextdescendents: nextdescendents
  sec-amster-entity-persistentcookiedecision-realm-ops-query: query
  sec-amster-entity-persistentcookiedecision-realm-ops-read: read
  sec-amster-entity-persistentcookiedecision-realm-ops-update: update
---

# PersistentCookieDecision

## Realm Operations

Resource path:

```
/realm-config/authentication/authenticationtrees/nodes/PersistentCookieDecisionNode
```

Resource version: `1.0`

### create

**Usage**

```
am> create PersistentCookieDecision --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" : {
      "enforceClientIp" : {
        "title" : "Enforce Client IP",
        "description" : "Enforces that the persistent cookie can only be used from the same client IP to which the cookie was issued.",
        "propertyOrder" : 200,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "hmacSigningKey" : {
        "title" : "HMAC Signing Key",
        "description" : "Base64-encoded 256-bit key to use for HMAC signing of the cookie.",
        "propertyOrder" : 500,
        "type" : "string",
        "format" : "password",
        "exampleValue" : ""
      },
      "idleTimeout" : {
        "title" : "Idle Timeout",
        "description" : "The maximum idle time between requests before the cookie is invalidated, in hours.",
        "propertyOrder" : 100,
        "type" : "integer",
        "exampleValue" : ""
      },
      "useHttpOnlyCookie" : {
        "title" : "Use HTTP Only Cookie",
        "description" : "Sets the persistent cookie as \"HttpOnly\".",
        "propertyOrder" : 400,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "persistentCookieName" : {
        "title" : "Persistent Cookie Name",
        "description" : "The name of the persistent cookie.",
        "propertyOrder" : 600,
        "type" : "string",
        "exampleValue" : ""
      },
      "useSecureCookie" : {
        "title" : "Use Secure Cookie",
        "description" : "Sets the persistent cookie as \"Secure\".",
        "propertyOrder" : 300,
        "type" : "boolean",
        "exampleValue" : ""
      }
    },
    "required" : [ "enforceClientIp", "hmacSigningKey", "idleTimeout", "useHttpOnlyCookie", "persistentCookieName", "useSecureCookie" ]
  }
  ```

### delete

**Usage**

```
am> delete PersistentCookieDecision --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 PersistentCookieDecision --realm Realm --actionName getAllTypes
```

### getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

**Usage**

```
am> action PersistentCookieDecision --realm Realm --actionName getCreatableTypes
```

### listOutcomes

List the available outcomes for the node type.

**Usage**

```
am> action PersistentCookieDecision --realm Realm --body body --actionName listOutcomes
```

**Parameters**

* *\--body*

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

  ```json
  {
    "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 PersistentCookieDecision --realm Realm --actionName nextdescendents
```

### query

Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter.

**Usage**

```
am> query PersistentCookieDecision --realm Realm --filter filter
```

**Parameters**

* *\--filter*

  A CREST formatted query filter, where "true" will query all.

### read

**Usage**

```
am> read PersistentCookieDecision --realm Realm --id id
```

**Parameters**

* *\--id*

  The unique identifier for the resource.

### update

**Usage**

```
am> update PersistentCookieDecision --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" : {
      "enforceClientIp" : {
        "title" : "Enforce Client IP",
        "description" : "Enforces that the persistent cookie can only be used from the same client IP to which the cookie was issued.",
        "propertyOrder" : 200,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "hmacSigningKey" : {
        "title" : "HMAC Signing Key",
        "description" : "Base64-encoded 256-bit key to use for HMAC signing of the cookie.",
        "propertyOrder" : 500,
        "type" : "string",
        "format" : "password",
        "exampleValue" : ""
      },
      "idleTimeout" : {
        "title" : "Idle Timeout",
        "description" : "The maximum idle time between requests before the cookie is invalidated, in hours.",
        "propertyOrder" : 100,
        "type" : "integer",
        "exampleValue" : ""
      },
      "useHttpOnlyCookie" : {
        "title" : "Use HTTP Only Cookie",
        "description" : "Sets the persistent cookie as \"HttpOnly\".",
        "propertyOrder" : 400,
        "type" : "boolean",
        "exampleValue" : ""
      },
      "persistentCookieName" : {
        "title" : "Persistent Cookie Name",
        "description" : "The name of the persistent cookie.",
        "propertyOrder" : 600,
        "type" : "string",
        "exampleValue" : ""
      },
      "useSecureCookie" : {
        "title" : "Use Secure Cookie",
        "description" : "Sets the persistent cookie as \"Secure\".",
        "propertyOrder" : 300,
        "type" : "boolean",
        "exampleValue" : ""
      }
    },
    "required" : [ "enforceClientIp", "hmacSigningKey", "idleTimeout", "useHttpOnlyCookie", "persistentCookieName", "useSecureCookie" ]
  }
  ```