Management API Reference for jaas-realm

A JAAS security realm definition. It uses a Login Context to verify the user's credentials.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.security.security-realm	true	/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=security/elytron-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 (5)

callback-handler - Callback handler to use with the Login Context. Security property "auth.login.defaultCallbackHandler" can be used instead. The default callback handler of the realm will be used if none of these are defined.

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" : "Callback handler to use with the Login Context. Security property \"auth.login.defaultCallbackHandler\" can be used instead. The default callback handler of the realm will be used if none of these are defined.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

entry - JAAS configuration file entry name.

Type	STRING
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" : "STRING" }, "description" : "JAAS configuration file entry name.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

module - The module to use to obtain the classloader to load the custom LoginModules and custom CallbackHandler. The classloader that loads the resource will be used if none defined.

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 module to use to obtain the classloader to load the custom LoginModules and custom CallbackHandler. The classloader that loads the resource will be used if none defined.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

path - Path to the JAAS Login Context configuration file. You can also specify the location of the configuration with java system property "java.security.auth.login.config" or with java security property "login.config.url".

Type	STRING
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" : "STRING" }, "description" : "Path to the JAAS Login Context configuration file. You can also specify the location of the configuration with java system property \"java.security.auth.login.config\" or with java security property \"login.config.url\".", "attribute-group" : "file", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

relative-to - The base path of the JAAS configuration file.

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 base path of the JAAS configuration file.", "attribute-group" : "file", "expressions-allowed" : false, "required" : false, "nillable" : true, "requires" : ["path"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

Operations (2)

add - The add operation for the security realm.

Request Parameter	Type	Required	Expressions Allowed	Description
callback-handler	STRING	false	false	Callback handler to use with the Login Context. Security property "auth.login.defaultCallbackHandler" can be used instead. The default callback handler of the realm will be used if none of these are defined.
entry	STRING	true	true	JAAS configuration file entry name.
module	STRING	false	false	The module to use to obtain the classloader to load the custom LoginModules and custom CallbackHandler. The classloader that loads the resource will be used if none defined.
path	STRING	false	true	Path to the JAAS Login Context configuration file. You can also specify the location of the configuration with java system property "java.security.auth.login.config" or with java security property "login.config.url".
relative-to	STRING	false	false	The base path of the JAAS configuration file.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "The add operation for the security realm.",
    "request-properties" : {
        "callback-handler" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Callback handler to use with the Login Context. Security property \"auth.login.defaultCallbackHandler\" can be used instead. The default callback handler of the realm will be used if none of these are defined.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "entry" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "JAAS configuration file entry name.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "module" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The module to use to obtain the classloader to load the custom LoginModules and custom CallbackHandler. The classloader that loads the resource will be used if none defined.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "path" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Path to the JAAS Login Context configuration file. You can also specify the location of the configuration with java system property \"java.security.auth.login.config\" or with java security property \"login.config.url\".",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "relative-to" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The base path of the JAAS configuration file.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "requires" : ["path"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

remove - The remove operation for the security realm.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "The remove operation for the security realm.",
    "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.elytron.jaas-realm

        
<feature spec="subsystem.elytron.jaas-realm">
  <param name="jaas-realm" value="{resource name}"/>
  <param name="callback-handler" value="{value}"/>
  <param name="entry" value="{value}"/>
  <param name="module" value="{value}"/>
  <param name="path" value="{value}"/>
  <param name="relative-to" value="{value}"/>
<feature/>