Management API Reference for application-security-domain

A Mapping from a security domain references in a deployed application.

Children (1)

setting
- single-sign-on

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.undertow.application-security-domain	true	none

Attributes (7)

enable-jacc - Enable authorization using Jakarta Authorization

Type	BOOLEAN
Default Value	false
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" : "BOOLEAN" }, "description" : "Enable authorization using Jakarta Authorization", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

enable-jaspi - Enable JASPI authentication for the associated deployments.

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" : "Enable JASPI authentication for the associated deployments.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

http-authentication-factory - The HTTP Authentication Factory to be used by deployments that reference the mapped security domain.

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 HTTP Authentication Factory to be used by deployments that reference the mapped security domain.", "expressions-allowed" : false, "required" : true, "nillable" : true, "alternatives" : ["security-domain"], "capability-reference" : "org.wildfly.security.http-authentication-factory", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"authentication-factory-ref" : {"type" : "core"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

integrated-jaspi - Whether integrated JASPI should be used. If 'false', an ad hoc identity will be created instead.

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" : "Whether integrated JASPI should be used. If 'false', an ad hoc identity will be created instead.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

override-deployment-config - Should the authentication configuration in the deployment be overridden by the factory.

Type	BOOLEAN
Default Value	false
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" : "BOOLEAN" }, "description" : "Should the authentication configuration in the deployment be overridden by the factory.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "requires" : ["http-authentication-factory"], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

referencing-deployments - The deployments currently referencing this mapping.

Type	LIST
Where is the attribute stored?	runtime
Access Type	read-only
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The deployments currently referencing this mapping.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

security-domain - The SecurityDomain to be used by deployments that reference the mapped security domain.

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 SecurityDomain to be used by deployments that reference the mapped security domain.", "expressions-allowed" : false, "required" : true, "nillable" : true, "alternatives" : ["http-authentication-factory"], "capability-reference" : "org.wildfly.security.security-domain", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"elytron-security-domain-ref" : {"type" : "core"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

Operations (2)

add - Add a new application referenced security domain mapping.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
enable-jacc	BOOLEAN	false	false	false	Enable authorization using Jakarta Authorization
enable-jaspi	BOOLEAN	false	true	true	Enable JASPI authentication for the associated deployments.
http-authentication-factory	STRING	true	false		The HTTP Authentication Factory to be used by deployments that reference the mapped security domain.
integrated-jaspi	BOOLEAN	false	true	true	Whether integrated JASPI should be used. If 'false', an ad hoc identity will be created instead.
override-deployment-config	BOOLEAN	false	false	false	Should the authentication configuration in the deployment be overridden by the factory.
security-domain	STRING	true	false		The SecurityDomain to be used by deployments that reference the mapped security domain.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add a new application referenced security domain mapping.",
    "request-properties" : {
        "enable-jacc" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Enable authorization using Jakarta Authorization",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "enable-jaspi" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Enable JASPI authentication for the associated deployments.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "http-authentication-factory" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The HTTP Authentication Factory to be used by deployments that reference the mapped security domain.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : true,
            "alternatives" : ["security-domain"],
            "capability-reference" : "org.wildfly.security.http-authentication-factory",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "integrated-jaspi" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether integrated JASPI should be used. If 'false', an ad hoc identity will be created instead.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "override-deployment-config" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Should the authentication configuration in the deployment be overridden by the factory.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "requires" : ["http-authentication-factory"],
            "stability" : "default"
        },
        "security-domain" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The SecurityDomain to be used by deployments that reference the mapped security domain.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : true,
            "alternatives" : ["http-authentication-factory"],
            "capability-reference" : "org.wildfly.security.security-domain",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove - Remove the application referenced security domain mapping.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove the application referenced security domain mapping.",
    "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.undertow.application-security-domain

        
<feature spec="subsystem.undertow.application-security-domain">
  <param name="application-security-domain" value="{resource name}"/>
  <param name="enable-jacc" value="{value}"/>
  <param name="enable-jaspi" value="{value}"/>
  <param name="http-authentication-factory" value="{value}"/>
  <param name="integrated-jaspi" value="{value}"/>
  <param name="override-deployment-config" value="{value}"/>
  <param name="security-domain" value="{value}"/>
<feature/>