Management API Reference for distributed-realm

A realm definition for authentication and authorization of identities distributed between multiple realms.

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/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 (3)

emit-events - Whether a SecurityEvent signifying realm unavailability should be emitted, applicable only when the ignore-unavailable-realms attribute is set to true. The default value is true.

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 a SecurityEvent signifying realm unavailability should be emitted, applicable only when the ignore-unavailable-realms attribute is set to true. The default value is true.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : true, "requires" : ["ignore-unavailable-realms"], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

ignore-unavailable-realms - Whether subsequent realms should be checked after an unavailable realm is reached. If set to false or not set, when the unavailable realm is reached "org.wildfly.security.auth.server.RealmUnavailableException" is thrown and the search stops. The default value is false.

Type	BOOLEAN
Default Value	false
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 subsequent realms should be checked after an unavailable realm is reached. If set to false or not set, when the unavailable realm is reached \"org.wildfly.security.auth.server.RealmUnavailableException\" is thrown and the search stops. The default value is false.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

realms - References to one or more security realms for authentication and authorization.

Type	LIST
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" : "References to one or more security realms for authentication and authorization.", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.security.security-realm", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

Operations (2)

add - The add operation for the security realm.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
emit-events	BOOLEAN	false	true	true	Whether a SecurityEvent signifying realm unavailability should be emitted, applicable only when the ignore-unavailable-realms attribute is set to true. The default value is true.
ignore-unavailable-realms	BOOLEAN	false	true	false	Whether subsequent realms should be checked after an unavailable realm is reached. If set to false or not set, when the unavailable realm is reached "org.wildfly.security.auth.server.RealmUnavailableException" is thrown and the search stops. The default value is false.
realms	LIST	true	false		References to one or more security realms for authentication and authorization.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "The add operation for the security realm.",
    "request-properties" : {
        "emit-events" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether a SecurityEvent signifying realm unavailability should be emitted, applicable only when the ignore-unavailable-realms attribute is set to true. The default value is true.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "requires" : ["ignore-unavailable-realms"],
            "stability" : "default"
        },
        "ignore-unavailable-realms" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Whether subsequent realms should be checked after an unavailable realm is reached. If set to false or not set, when the unavailable realm is reached \"org.wildfly.security.auth.server.RealmUnavailableException\" is thrown and the search stops. The default value is false.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "realms" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "References to one or more security realms for authentication and authorization.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "capability-reference" : "org.wildfly.security.security-realm",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        }
    },
    "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.distributed-realm

        
<feature spec="subsystem.elytron.distributed-realm">
  <param name="distributed-realm" value="{resource name}"/>
  <param name="emit-events" value="{value}"/>
  <param name="ignore-unavailable-realms" value="{value}"/>
  <param name="realms" value="{value}"/>
<feature/>