Management API Reference for aggregate-realm

A realm definition that is an aggregation of two realms, one for the authentication steps and one for loading the identity for the authorization steps.

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=security/elytron-realm=* /subsystem=elytron/custom-modifiable-realm=* /subsystem=elytron/identity-realm=* /subsystem=elytron/properties-realm=* /subsystem=elytron/caching-realm=* /subsystem=elytron/custom-realm=*

Attributes (4)

authentication-realm - Reference to the security realm to use for authentication steps (obtaining or validating credentials).

Type	STRING
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 security realm to use for authentication steps (obtaining or validating credentials).", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.security.security-realm", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

authorization-realm - Reference to the security realm to use for loading the identity for authorization steps (loading of the identity).

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 security realm to use for loading the identity for authorization steps (loading of the identity).", "expressions-allowed" : false, "required" : true, "nillable" : true, "alternatives" : ["authorization-realms"], "capability-reference" : "org.wildfly.security.security-realm", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

authorization-realms - Reference to one or more security realms to use for loading the identity for authorization steps and aggregating the attributes (loading of the identity).

Type	LIST
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" : "LIST" }, "description" : "Reference to one or more security realms to use for loading the identity for authorization steps and aggregating the attributes (loading of the identity).", "expressions-allowed" : false, "required" : true, "nillable" : true, "alternatives" : ["authorization-realm"], "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" }

principal-transformer - Reference to a principal transformer to apply between loading the identity for authentication and loading the identity for authorization

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" : "Reference to a principal transformer to apply between loading the identity for authentication and loading the identity for authorization", "expressions-allowed" : true, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.principal-transformer", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "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	Description
authentication-realm	STRING	true	false	Reference to the security realm to use for authentication steps (obtaining or validating credentials).
authorization-realm	STRING	true	false	Reference to the security realm to use for loading the identity for authorization steps (loading of the identity).
authorization-realms	LIST	true	false	Reference to one or more security realms to use for loading the identity for authorization steps and aggregating the attributes (loading of the identity).
principal-transformer	STRING	false	true	Reference to a principal transformer to apply between loading the identity for authentication and loading the identity for authorization

Raw DMR model


{
    "operation-name" : "add",
    "description" : "The add operation for the security realm.",
    "request-properties" : {
        "authentication-realm" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to the security realm to use for authentication steps (obtaining or validating credentials).",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "capability-reference" : "org.wildfly.security.security-realm",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "authorization-realm" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to the security realm to use for loading the identity for authorization steps (loading of the identity).",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : true,
            "alternatives" : ["authorization-realms"],
            "capability-reference" : "org.wildfly.security.security-realm",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "authorization-realms" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "Reference to one or more security realms to use for loading the identity for authorization steps and aggregating the attributes (loading of the identity).",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : true,
            "alternatives" : ["authorization-realm"],
            "capability-reference" : "org.wildfly.security.security-realm",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "principal-transformer" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to a principal transformer to apply between loading the identity for authentication and loading the identity for authorization",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.principal-transformer",
            "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.aggregate-realm

        
<feature spec="subsystem.elytron.aggregate-realm">
  <param name="aggregate-realm" value="{resource name}"/>
  <param name="authentication-realm" value="{value}"/>
  <param name="authorization-realm" value="{value}"/>
  <param name="authorization-realms" value="{value}"/>
  <param name="principal-transformer" value="{value}"/>
<feature/>