Management API Reference for elytron-realm

The configuration of an Elytron-compatible realm that delegates authentication decisions to a legacy security domain.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.security.security-realm	true	/subsystem=elytron/jaas-realm=* /subsystem=elytron/jdbc-realm=* /subsystem=elytron/filesystem-realm=* /subsystem=elytron/token-realm=* /subsystem=elytron/ldap-realm=* /subsystem=elytron/distributed-realm=* /subsystem=elytron/key-store-realm=* /subsystem=elytron/failover-realm=* /subsystem=elytron/custom-modifiable-realm=* /subsystem=elytron/identity-realm=* /subsystem=elytron/aggregate-realm=* /subsystem=elytron/properties-realm=* /subsystem=elytron/caching-realm=* /subsystem=elytron/custom-realm=*

Attributes (2)

apply-role-mappers - Indicates to the realm if it should apply the role mappers defined in the legacy domain to the roles obtained from authenticated Subjects or not.

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?	resource-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "Indicates to the realm if it should apply the role mappers defined in the legacy domain to the roles obtained from authenticated Subjects or not.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

legacy-jaas-config - The name of the legacy security domain to which authentication will be delegated.

Type	STRING
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	resource-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the legacy security domain to which authentication will be delegated.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-constraints" : {"sensitive" : {"security-domain-ref" : {"type" : "core"}}}, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

Operations (2)

add - Adds an Elytron realm configuration.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
apply-role-mappers	BOOLEAN	false	true	true	Indicates to the realm if it should apply the role mappers defined in the legacy domain to the roles obtained from authenticated Subjects or not.
legacy-jaas-config	STRING	true	false		The name of the legacy security domain to which authentication will be delegated.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Adds an Elytron realm configuration.",
    "request-properties" : {
        "apply-role-mappers" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Indicates to the realm if it should apply the role mappers defined in the legacy domain to the roles obtained from authenticated Subjects or not.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "legacy-jaas-config" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the legacy security domain to which authentication will be delegated.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

remove - Removes an Elytron realm configuration.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Removes an Elytron realm 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.elytron-realm

        
<feature spec="subsystem.security.elytron-realm">
  <param name="elytron-realm" value="{resource name}"/>
  <param name="apply-role-mappers" value="{value}"/>
  <param name="legacy-jaas-config" value="{value}"/>
<feature/>