Management API Reference for login-module-stack

List of "named" login modules that are used by jaspi authentication modules.

Stability Level: default

Children (1)

Attributes (1)

- List of authentication modules

Deprecated Since 1.2.0

This attribute is replaced with sub resource

Type	LIST
Is the attribute nillable?	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" : "LIST" }, "description" : "List of authentication modules", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "1.2.0", "reason" : "This attribute is replaced with sub resource" }, "value-type" : { "code" : { "description" : "Class name of the module to be instantiated.", "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "nillable" : false, "min-length" : 1 }, "flag" : { "description" : "The flag controls how the module participates in the overall procedure. Allowed values are requisite, required, sufficient or optional.", "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "nillable" : false, "allowed" : [ "required", "requisite", "sufficient", "optional" ] }, "module" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "nillable" : true, "description" : "Name of JBoss Module where the login module is located." }, "module-options" : { "description" : "List of module options containing a name/value pair.", "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "nillable" : true } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

Operations (2)

add - Adds a named login module stack configuration

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
login-modules	LIST	false	false		List of authentication modules

Raw DMR model


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

remove - Removes a named login module stack configuration

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes a named login module stack configuration",
    "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.authentication.jaspi.login-module-stack

        
<feature spec="subsystem.security.security-domain.authentication.jaspi.login-module-stack">
  <param name="login-module-stack" value="{resource name}"/>
  <param name="security-domain" value="{resource name}"/>
  <param name="login-modules" value="{value}"/>
<feature/>