Management API Reference for policy-module

Attributes (4)

• code - Class name of the module to be instantiated.

  Type	STRING
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	no-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Class name of the module to be instantiated.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

• flag - The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.

  Type	STRING
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	no-services
  Allowed Values	sufficient optional requisite required
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.", "expressions-allowed" : true, "required" : true, "nillable" : false, "allowed" : [ "required", "requisite", "sufficient", "optional" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

• module - Name of JBoss Module where the login module is located.

  Type	STRING
  Is the attribute nillable?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	no-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of JBoss Module where the login module is located.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

• module-options - List of module options containing a name/value pair.

  Type	OBJECT
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	no-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "List of module options containing a name/value pair.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

Operations (2)

• add - Adds login module

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  code	STRING	true	false		Class name of the module to be instantiated.
  flag	STRING	true	true		The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.
  module	STRING	false	false		Name of JBoss Module where the login module is located.
  module-options	OBJECT	false	true		List of module options containing a name/value pair.

  Raw DMR model

  { "operation-name" : "add", "description" : "Adds login module", "request-properties" : { "code" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Class name of the module to be instantiated.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "flag" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.", "expressions-allowed" : true, "required" : true, "nillable" : false, "allowed" : [ "required", "requisite", "sufficient", "optional" ], "stability" : "default" }, "module" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of JBoss Module where the login module is located.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "module-options" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "List of module options containing a name/value pair.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• remove - Removes login module

  Raw DMR model

  { "operation-name" : "remove", "description" : "Removes login module", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "restart-required" : "resource-services", "runtime-only" : false }

Galleon Features

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

• subsystem.security.security-domain.authorization.classic.policy-module

          
  <feature spec="subsystem.security.security-domain.authorization.classic.policy-module">
    <param name="policy-module" value="{resource name}"/>
    <param name="security-domain" value="{resource name}"/>
    <param name="code" value="{value}"/>
    <param name="flag" value="{value}"/>
    <param name="module" value="{value}"/>
    <param name="module-options" value="{value}"/>
  <feature/>
          
        

  📋