Management API Reference for subsystem=elytron

The Elytron Subsystem

Children (93)

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.security.elytron	false	none

Attributes (7)

default-authentication-context - The default authentication context to be associated with all deployments.

Type	STRING
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" : "STRING" }, "description" : "The default authentication context to be associated with all deployments.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.authentication-context", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

default-ssl-context - Reference to the SSLContext which should be globally registered as the default.

Type	STRING
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" : "STRING" }, "description" : "Reference to the SSLContext which should be globally registered as the default.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.ssl-context", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

disallowed-providers - A list of providers that are not allowed, and will be removed from the providers list.

Type	LIST
Is the attribute nillable?	true
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	jvm
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "A list of providers that are not allowed, and will be removed from the providers list.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "jvm", "capability-reference" : null }`

final-providers - Reference to the Providers that should be registered after all existing Providers.

Type	STRING
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" : "STRING" }, "description" : "Reference to the Providers that should be registered after all existing Providers.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.providers", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

initial-providers - Reference to the Providers that should be registered ahead of all existing Providers.

Type	STRING
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" : "STRING" }, "description" : "Reference to the Providers that should be registered ahead of all existing Providers.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.providers", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

Type	BOOLEAN
Default Value	true
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" : "Should the Elytron JASPI factory be globally registered?", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

security-properties - Security properties to be set.

Type	OBJECT
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" : "OBJECT" }, "description" : "Security properties to be set.", "expressions-allowed" : false, "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 - Operation adds the Elytron subsystem

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
default-authentication-context	STRING	false	false		The default authentication context to be associated with all deployments.
default-ssl-context	STRING	false	false		Reference to the SSLContext which should be globally registered as the default.
disallowed-providers	LIST	false	true		A list of providers that are not allowed, and will be removed from the providers list.
final-providers	STRING	false	false		Reference to the Providers that should be registered after all existing Providers.
initial-providers	STRING	false	false		Reference to the Providers that should be registered ahead of all existing Providers.
register-jaspi-factory	BOOLEAN	false	true	true	Should the Elytron JASPI factory be globally registered?
security-properties	OBJECT	false	false		Security properties to be set.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Operation adds the Elytron subsystem",
    "request-properties" : {
        "default-authentication-context" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The default authentication context to be associated with all deployments.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.authentication-context",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "default-ssl-context" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to the SSLContext which should be globally registered as the default.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.ssl-context",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "disallowed-providers" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "A list of providers that are not allowed, and will be removed from the providers list.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "final-providers" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to the Providers that should be registered after all existing Providers.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.providers",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "initial-providers" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to the Providers that should be registered ahead of all existing Providers.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.providers",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "register-jaspi-factory" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Should the Elytron JASPI factory be globally registered?",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "security-properties" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "Security properties to be set.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Operation removes the Elytron subsystem

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Operation removes the Elytron subsystem",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "all-services",
    "runtime-only" : false
}

Galleon Features

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

subsystem.elytron

        
<feature spec="subsystem.elytron">
  <param name="default-authentication-context" value="{value}"/>
  <param name="default-ssl-context" value="{value}"/>
  <param name="disallowed-providers" value="{value}"/>
  <param name="final-providers" value="{value}"/>
  <param name="initial-providers" value="{value}"/>
  <param name="register-jaspi-factory" value="{value}"/>
  <param name="security-properties" value="{value}"/>
<feature/>