--- title: PersistentCookieModule description: Resource path: component: pingam version: 8.1 page_id: pingam:entity-reference:sec-amster-entity-persistentcookiemodule canonical_url: https://docs.pingidentity.com/pingam/8.1/entity-reference/sec-amster-entity-persistentcookiemodule.html section_ids: sec-amster-entity-persistentcookiemodule-realm-ops: Realm Operations sec-amster-entity-persistentcookiemodule-realm-ops-create: create sec-amster-entity-persistentcookiemodule-realm-ops-delete: delete sec-amster-entity-persistentcookiemodule-realm-ops-getalltypes: getAllTypes sec-amster-entity-persistentcookiemodule-realm-ops-getcreatabletypes: getCreatableTypes sec-amster-entity-persistentcookiemodule-realm-ops-nextdescendents: nextdescendents sec-amster-entity-persistentcookiemodule-realm-ops-query: query sec-amster-entity-persistentcookiemodule-realm-ops-read: read sec-amster-entity-persistentcookiemodule-realm-ops-update: update sec-amster-entity-persistentcookiemodule-global-ops: Global Operations sec-amster-entity-persistentcookiemodule-global-ops-getalltypes: getAllTypes sec-amster-entity-persistentcookiemodule-global-ops-getcreatabletypes: getCreatableTypes sec-amster-entity-persistentcookiemodule-global-ops-nextdescendents: nextdescendents sec-amster-entity-persistentcookiemodule-global-ops-read: read sec-amster-entity-persistentcookiemodule-global-ops-update: update --- # PersistentCookieModule ## Realm Operations Resource path: ``` /realm-config/authentication/modules/persistentcookie ``` Resource version: `0.0` ### create **Usage** ``` am> create PersistentCookieModule --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" : { "cookieName" : { "title" : "Persistent Cookie Name", "description" : "Sets the name of the persistent cookie", "propertyOrder" : null, "required" : true, "type" : "string", "exampleValue" : "" }, "idleTimeout" : { "title" : "Idle Timeout", "description" : "The maximum idle time between requests before the cookie is invalidated, in hours.", "propertyOrder" : 100, "required" : true, "type" : "integer", "exampleValue" : "" }, "maxLife" : { "title" : "Max Life", "description" : "The maximum length of time the persistent cookie is valid for, in hours.", "propertyOrder" : 200, "required" : true, "type" : "integer", "exampleValue" : "" }, "useSecureCookie" : { "title" : "Use secure cookie", "description" : "Sets the persistent cookie as \"Secure\"", "propertyOrder" : 400, "required" : true, "type" : "boolean", "exampleValue" : "" }, "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" : 300, "required" : true, "type" : "boolean", "exampleValue" : "" }, "useHttpOnlyCookie" : { "title" : "Use HTTP only cookie", "description" : "Sets the persistent cookie as \"HttpOnly\"", "propertyOrder" : 500, "required" : true, "type" : "boolean", "exampleValue" : "" } } } ``` ### delete **Usage** ``` am> delete PersistentCookieModule --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 PersistentCookieModule --realm Realm --actionName getAllTypes ``` ### getCreatableTypes Obtain the collection of secondary configuration types that have yet to be added to the resource. **Usage** ``` am> action PersistentCookieModule --realm Realm --actionName getCreatableTypes ``` ### nextdescendents Obtain the collection of secondary configuration instances that have been added to the resource. **Usage** ``` am> action PersistentCookieModule --realm Realm --actionName nextdescendents ``` ### query Get the full list of instances of this collection. This query only supports `_queryFilter=true` filter. **Usage** ``` am> query PersistentCookieModule --realm Realm --filter filter ``` **Parameters** * *\--filter* A CREST formatted query filter, where "true" will query all. ### read **Usage** ``` am> read PersistentCookieModule --realm Realm --id id ``` **Parameters** * *\--id* The unique identifier for the resource. ### update **Usage** ``` am> update PersistentCookieModule --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" : { "cookieName" : { "title" : "Persistent Cookie Name", "description" : "Sets the name of the persistent cookie", "propertyOrder" : null, "required" : true, "type" : "string", "exampleValue" : "" }, "idleTimeout" : { "title" : "Idle Timeout", "description" : "The maximum idle time between requests before the cookie is invalidated, in hours.", "propertyOrder" : 100, "required" : true, "type" : "integer", "exampleValue" : "" }, "maxLife" : { "title" : "Max Life", "description" : "The maximum length of time the persistent cookie is valid for, in hours.", "propertyOrder" : 200, "required" : true, "type" : "integer", "exampleValue" : "" }, "useSecureCookie" : { "title" : "Use secure cookie", "description" : "Sets the persistent cookie as \"Secure\"", "propertyOrder" : 400, "required" : true, "type" : "boolean", "exampleValue" : "" }, "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" : 300, "required" : true, "type" : "boolean", "exampleValue" : "" }, "useHttpOnlyCookie" : { "title" : "Use HTTP only cookie", "description" : "Sets the persistent cookie as \"HttpOnly\"", "propertyOrder" : 500, "required" : true, "type" : "boolean", "exampleValue" : "" } } } ``` ## Global Operations Resource path: ``` /global-config/authentication/modules/persistentcookie ``` Resource version: `1.0` ### getAllTypes Obtain the collection of all secondary configuration types related to the resource. **Usage** ``` am> action PersistentCookieModule --global --actionName getAllTypes ``` ### getCreatableTypes Obtain the collection of secondary configuration types that have yet to be added to the resource. **Usage** ``` am> action PersistentCookieModule --global --actionName getCreatableTypes ``` ### nextdescendents Obtain the collection of secondary configuration instances that have been added to the resource. **Usage** ``` am> action PersistentCookieModule --global --actionName nextdescendents ``` ### read **Usage** ``` am> read PersistentCookieModule --global ``` ### update **Usage** ``` am> update PersistentCookieModule --global --body body ``` **Parameters** * *\--body* The resource in JSON format, described by the following JSON schema: ```json { "type" : "object", "properties" : { "defaults" : { "properties" : { "cookieName" : { "title" : "Persistent Cookie Name", "description" : "Sets the name of the persistent cookie", "propertyOrder" : null, "required" : true, "type" : "string", "exampleValue" : "" }, "useSecureCookie" : { "title" : "Use secure cookie", "description" : "Sets the persistent cookie as \"Secure\"", "propertyOrder" : 400, "required" : true, "type" : "boolean", "exampleValue" : "" }, "useHttpOnlyCookie" : { "title" : "Use HTTP only cookie", "description" : "Sets the persistent cookie as \"HttpOnly\"", "propertyOrder" : 500, "required" : true, "type" : "boolean", "exampleValue" : "" }, "maxLife" : { "title" : "Max Life", "description" : "The maximum length of time the persistent cookie is valid for, in hours.", "propertyOrder" : 200, "required" : true, "type" : "integer", "exampleValue" : "" }, "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" : 300, "required" : true, "type" : "boolean", "exampleValue" : "" }, "idleTimeout" : { "title" : "Idle Timeout", "description" : "The maximum idle time between requests before the cookie is invalidated, in hours.", "propertyOrder" : 100, "required" : true, "type" : "integer", "exampleValue" : "" } }, "type" : "object", "title" : "Realm Defaults" } } } ```