Management API Reference for setting=single-sign-on

Provided Capabilities (1)

Attributes (5)

• cookie-name - Name of the cookie

  Type	STRING
  Default Value	JSESSIONIDSSO
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of the cookie", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "JSESSIONIDSSO", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• domain - The cookie domain that will be used.

  Type	STRING
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The cookie domain that will be used.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• http-only - Set Cookie httpOnly attribute.

  Type	BOOLEAN
  Default Value	false
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Set Cookie httpOnly attribute.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• path - Cookie path.

  Type	STRING
  Default Value	/
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Cookie path.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "/", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• secure - Set Cookie secure attribute.

  Type	BOOLEAN
  Default Value	false
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Set Cookie secure attribute.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

Operations (2)

• add - Adds an SSO authentication mechanism.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  cookie-name	STRING	false	true	JSESSIONIDSSO	Name of the cookie
  domain	STRING	false	true		The cookie domain that will be used.
  http-only	BOOLEAN	false	true	false	Set Cookie httpOnly attribute.
  path	STRING	false	true	/	Cookie path.
  secure	BOOLEAN	false	true	false	Set Cookie secure attribute.

  Raw DMR model

  { "operation-name" : "add", "description" : "Adds an SSO authentication mechanism.", "request-properties" : { "cookie-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of the cookie", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "JSESSIONIDSSO", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "domain" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The cookie domain that will be used.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "http-only" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Set Cookie httpOnly attribute.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default" }, "path" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Cookie path.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : "/", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "secure" : { "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Set Cookie secure attribute.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• remove - Removes the SSO authentication mechanism.

  Raw DMR model

  { "operation-name" : "remove", "description" : "Removes the SSO authentication mechanism.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

• subsystem.undertow.server.host.setting.single-sign-on

          
  <feature spec="subsystem.undertow.server.host.setting.single-sign-on">
    <param name="host" value="{resource name}"/>
    <param name="server" value="{resource name}"/>
    <param name="cookie-name" value="{value}"/>
    <param name="domain" value="{value}"/>
    <param name="http-only" value="{value}"/>
    <param name="path" value="{value}"/>
    <param name="secure" value="{value}"/>
  <feature/>
          
        

  📋