---
title: SetPersistentCookie
description: Resource path:
component: pingam
version: 8
page_id: pingam:entity-reference:sec-amster-entity-setpersistentcookie
canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-setpersistentcookie.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-setpersistentcookie.html
section_ids:
sec-amster-entity-setpersistentcookie-realm-ops: Realm Operations
sec-amster-entity-setpersistentcookie-realm-ops-create: create
sec-amster-entity-setpersistentcookie-realm-ops-delete: delete
sec-amster-entity-setpersistentcookie-realm-ops-getalltypes: getAllTypes
sec-amster-entity-setpersistentcookie-realm-ops-getcreatabletypes: getCreatableTypes
sec-amster-entity-setpersistentcookie-realm-ops-listoutcomes: listOutcomes
sec-amster-entity-setpersistentcookie-realm-ops-nextdescendents: nextdescendents
sec-amster-entity-setpersistentcookie-realm-ops-query: query
sec-amster-entity-setpersistentcookie-realm-ops-read: read
sec-amster-entity-setpersistentcookie-realm-ops-update: update
---
# SetPersistentCookie
## Realm Operations
Resource path:
```
/realm-config/authentication/authenticationtrees/nodes/SetPersistentCookieNode
```
Resource version: `2.0`
### create
**Usage**
```
am> create SetPersistentCookie --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" : {
"maxLife" : {
"title" : "Max Life",
"description" : "The maximum length of time the persistent cookie is valid for, in hours.",
"propertyOrder" : 200,
"type" : "integer",
"exampleValue" : ""
},
"hmacSigningKey" : {
"title" : "HMAC Signing Key",
"description" : "Base64-encoded 256-bit key to use for HMAC signing of the cookie. This property is deprecated. Use the HMAC Signing Key Secret Label Identifier instead. The signing key is ignored if you set an HMAC Signing Key Secret Label Identifier.",
"propertyOrder" : 500,
"type" : "string",
"format" : "password",
"exampleValue" : ""
},
"persistentCookieName" : {
"title" : "Persistent Cookie Name",
"description" : "Sets the name of the persistent cookie.",
"propertyOrder" : 600,
"type" : "string",
"exampleValue" : ""
},
"useHttpOnlyCookie" : {
"title" : "Use HTTP Only Cookie",
"description" : "Sets the persistent cookie as \"HttpOnly\".",
"propertyOrder" : 400,
"type" : "boolean",
"exampleValue" : ""
},
"idleTimeout" : {
"title" : "Idle Timeout",
"description" : "The maximum idle time between requests before the cookie is invalidated, in hours.",
"propertyOrder" : 100,
"type" : "integer",
"exampleValue" : ""
},
"useSecureCookie" : {
"title" : "Use Secure Cookie",
"description" : "Sets the persistent cookie as \"Secure\".",
"propertyOrder" : 300,
"type" : "boolean",
"exampleValue" : ""
},
"hmacSigningKeySecretLabelIdentifier" : {
"title" : "HMAC Signing Key Secret Label Identifier",
"description" : "Identifier used to create a secret label for mapping to a secret in a secret store.
AM uses this identifier to create a specific secret label for this node. The secret label takes the form am.authentication.nodes.persistentcookie.{{identifier}}.signing where {{identifier}} is the value of HMAC Signing Key Secret Label Identifier. The identifier can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}. If you set an HMAC Signing Key Secret Label Identifier and AM finds a matching secret in a secret store, the HMAC Signing Key is ignored.",
"propertyOrder" : 550,
"type" : "string",
"exampleValue" : ""
}
},
"required" : [ "maxLife", "persistentCookieName", "useHttpOnlyCookie", "idleTimeout", "useSecureCookie" ]
}
```
### delete
**Usage**
```
am> delete SetPersistentCookie --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 SetPersistentCookie --realm Realm --actionName getAllTypes
```
### getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
**Usage**
```
am> action SetPersistentCookie --realm Realm --actionName getCreatableTypes
```
### listOutcomes
List the available outcomes for the node type.
**Usage**
```
am> action SetPersistentCookie --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 SetPersistentCookie --realm Realm --actionName nextdescendents
```
### query
Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter.
**Usage**
```
am> query SetPersistentCookie --realm Realm --filter filter
```
**Parameters**
* *\--filter*
A CREST formatted query filter, where "true" will query all.
### read
**Usage**
```
am> read SetPersistentCookie --realm Realm --id id
```
**Parameters**
* *\--id*
The unique identifier for the resource.
### update
**Usage**
```
am> update SetPersistentCookie --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" : {
"maxLife" : {
"title" : "Max Life",
"description" : "The maximum length of time the persistent cookie is valid for, in hours.",
"propertyOrder" : 200,
"type" : "integer",
"exampleValue" : ""
},
"hmacSigningKey" : {
"title" : "HMAC Signing Key",
"description" : "Base64-encoded 256-bit key to use for HMAC signing of the cookie. This property is deprecated. Use the HMAC Signing Key Secret Label Identifier instead. The signing key is ignored if you set an HMAC Signing Key Secret Label Identifier.",
"propertyOrder" : 500,
"type" : "string",
"format" : "password",
"exampleValue" : ""
},
"persistentCookieName" : {
"title" : "Persistent Cookie Name",
"description" : "Sets the name of the persistent cookie.",
"propertyOrder" : 600,
"type" : "string",
"exampleValue" : ""
},
"useHttpOnlyCookie" : {
"title" : "Use HTTP Only Cookie",
"description" : "Sets the persistent cookie as \"HttpOnly\".",
"propertyOrder" : 400,
"type" : "boolean",
"exampleValue" : ""
},
"idleTimeout" : {
"title" : "Idle Timeout",
"description" : "The maximum idle time between requests before the cookie is invalidated, in hours.",
"propertyOrder" : 100,
"type" : "integer",
"exampleValue" : ""
},
"useSecureCookie" : {
"title" : "Use Secure Cookie",
"description" : "Sets the persistent cookie as \"Secure\".",
"propertyOrder" : 300,
"type" : "boolean",
"exampleValue" : ""
},
"hmacSigningKeySecretLabelIdentifier" : {
"title" : "HMAC Signing Key Secret Label Identifier",
"description" : "Identifier used to create a secret label for mapping to a secret in a secret store.
AM uses this identifier to create a specific secret label for this node. The secret label takes the form am.authentication.nodes.persistentcookie.{{identifier}}.signing where {{identifier}} is the value of HMAC Signing Key Secret Label Identifier. The identifier can only contain characters {{a-z}} {{A-Z}} {{0-9}} {{.}} and cannot start or end with {{.}}. If you set an HMAC Signing Key Secret Label Identifier and AM finds a matching secret in a secret store, the HMAC Signing Key is ignored.",
"propertyOrder" : 550,
"type" : "string",
"exampleValue" : ""
}
},
"required" : [ "maxLife", "persistentCookieName", "useHttpOnlyCookie", "idleTimeout", "useSecureCookie" ]
}
```