SetCustomCookie
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/SetCustomCookieNode/1.0
Resource version: 3.0
create
Usage
am> create SetCustomCookie --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" : { "domain" : { "title" : "Custom Cookie Domain", "description" : "Sets the domain of the custom cookie.", "propertyOrder" : 400, "type" : "string", "exampleValue" : "" }, "useSecureCookie" : { "title" : "Use Secure Cookie", "description" : "Sets the custom cookie as \"Secure\". This will be ignored and set to true if SameSite is set to \"NONE\".", "propertyOrder" : 600, "type" : "boolean", "exampleValue" : "" }, "useHttpOnlyCookie" : { "title" : "Use HTTP Only Cookie", "description" : "Sets the custom cookie as \"HttpOnly\".", "propertyOrder" : 700, "type" : "boolean", "exampleValue" : "" }, "sameSite" : { "title" : "Custom Cookie SameSite attribute", "description" : "Sets the same site attribute of the custom cookie. This value controls when a browser sends the cookie in cross-site requests. Possible values include: <br>* `STRICT`: The cookie is only sent when navigating within the same site. It's not sent on any cross-site requests, even for top-level navigations.<br>* `LAX`: The cookie is sent on same-site requests and top-level navigations. It's not sent on subresource requests (like images or scripts loaded from a third-party site).<br>* `NONE`: There are no restrictions on the cookie domain.", "propertyOrder" : 800, "type" : "string", "exampleValue" : "" }, "value" : { "title" : "Custom Cookie Value", "description" : "Sets the value of the custom cookie.", "propertyOrder" : 200, "type" : "string", "exampleValue" : "" }, "name" : { "title" : "Custom Cookie Name", "description" : "Sets the name of the custom cookie.", "propertyOrder" : 100, "type" : "string", "exampleValue" : "" }, "maxAge" : { "title" : "Max Age", "description" : "The maximum length of time the custom cookie is valid for, in seconds. Both the Max Age and Expires attribute of the cookie are set behind the scenes for compatibility purposes.", "propertyOrder" : 300, "type" : "integer", "exampleValue" : "" }, "path" : { "title" : "Custom Cookie Path", "description" : "Sets the path of the custom cookie.", "propertyOrder" : 500, "type" : "string", "exampleValue" : "" } }, "required" : [ "useSecureCookie", "useHttpOnlyCookie", "sameSite", "value", "name" ] }
delete
Usage
am> delete SetCustomCookie --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 SetCustomCookie --realm Realm --actionName getType
getUpgradedConfig
Get the upgraded configuration for the node type.
Usage
am> action SetCustomCookie --realm Realm --body body --actionName getUpgradedConfig --targetVersion targetVersion
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "type" : "object", "title" : "The current configuration of the node type." } - --targetVersion
-
=== listOutcomes
List the available outcomes for the node type.
Usage
am> action SetCustomCookie --realm Realm --body body --actionName listOutcomes
Parameters
- --body
-
The resource in JSON format, described by the following JSON schema:
{ "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 SetCustomCookie --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read SetCustomCookie --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update SetCustomCookie --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" : { "domain" : { "title" : "Custom Cookie Domain", "description" : "Sets the domain of the custom cookie.", "propertyOrder" : 400, "type" : "string", "exampleValue" : "" }, "useSecureCookie" : { "title" : "Use Secure Cookie", "description" : "Sets the custom cookie as \"Secure\". This will be ignored and set to true if SameSite is set to \"NONE\".", "propertyOrder" : 600, "type" : "boolean", "exampleValue" : "" }, "useHttpOnlyCookie" : { "title" : "Use HTTP Only Cookie", "description" : "Sets the custom cookie as \"HttpOnly\".", "propertyOrder" : 700, "type" : "boolean", "exampleValue" : "" }, "sameSite" : { "title" : "Custom Cookie SameSite attribute", "description" : "Sets the same site attribute of the custom cookie. This value controls when a browser sends the cookie in cross-site requests. Possible values include: <br>* `STRICT`: The cookie is only sent when navigating within the same site. It's not sent on any cross-site requests, even for top-level navigations.<br>* `LAX`: The cookie is sent on same-site requests and top-level navigations. It's not sent on subresource requests (like images or scripts loaded from a third-party site).<br>* `NONE`: There are no restrictions on the cookie domain.", "propertyOrder" : 800, "type" : "string", "exampleValue" : "" }, "value" : { "title" : "Custom Cookie Value", "description" : "Sets the value of the custom cookie.", "propertyOrder" : 200, "type" : "string", "exampleValue" : "" }, "name" : { "title" : "Custom Cookie Name", "description" : "Sets the name of the custom cookie.", "propertyOrder" : 100, "type" : "string", "exampleValue" : "" }, "maxAge" : { "title" : "Max Age", "description" : "The maximum length of time the custom cookie is valid for, in seconds. Both the Max Age and Expires attribute of the cookie are set behind the scenes for compatibility purposes.", "propertyOrder" : 300, "type" : "integer", "exampleValue" : "" }, "path" : { "title" : "Custom Cookie Path", "description" : "Sets the path of the custom cookie.", "propertyOrder" : 500, "type" : "string", "exampleValue" : "" } }, "required" : [ "useSecureCookie", "useHttpOnlyCookie", "sameSite", "value", "name" ] }