Management API Reference for security-domain

A security domain definition.

Provided Capabilities (1)

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

Attributes (15)

default-realm - The default realm contained by this security domain.

Type	STRING
Is the attribute nillable?	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" : "STRING" }, "description" : "The default realm contained by this security domain.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }`

evidence-decoder - A reference to an EvidenceDecoder to be used by this domain.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A reference to an EvidenceDecoder to be used by this domain.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.evidence-decoder", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services" }`

outflow-anonymous - When outflowing to a security domain if outflow is not possible should the anonymous identity be used? Outflowing anonymous has the effect of clearing any identity already established for that domain.

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?	resource-services
Stability Level	default
Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "BOOLEAN" }, "description" : "When outflowing to a security domain if outflow is not possible should the anonymous identity be used? Outflowing anonymous has the effect of clearing any identity already established for that domain.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "requires" : ["outflow-security-domains"], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

outflow-security-domains - The list of security domains that the security identity from this domain should automatically outflow to.

Type	LIST
Is the attribute nillable?	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" : "LIST" }, "description" : "The list of security domains that the security identity from this domain should automatically outflow to.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.security-domain", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services" }

permission-mapper - A reference to a PermissionMapper to be used by this domain.

Type	STRING
Is the attribute nillable?	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" : "STRING" }, "description" : "A reference to a PermissionMapper to be used by this domain.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.permission-mapper", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services" }`

post-realm-principal-transformer - A reference to a principal transformer to be applied after the realm has operated on the supplied identity name.

Type	STRING
Is the attribute nillable?	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" : "STRING" }, "description" : "A reference to a principal transformer to be applied after the realm has operated on the supplied identity name.", "expressions-allowed" : false, "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" : "resource-services" }`

pre-realm-principal-transformer - A reference to a principal transformer to be applied before the realm is selected.

Type	STRING
Is the attribute nillable?	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" : "STRING" }, "description" : "A reference to a principal transformer to be applied before the realm is selected.", "expressions-allowed" : false, "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" : "resource-services" }`

principal-decoder - A reference to a PrincipalDecoder to be used by this domain.

Type	STRING
Is the attribute nillable?	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" : "STRING" }, "description" : "A reference to a PrincipalDecoder to be used by this domain.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.principal-decoder", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services" }`

realm-mapper - Reference to the RealmMapper to be used by this domain.

Type	STRING
Is the attribute nillable?	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" : "STRING" }, "description" : "Reference to the RealmMapper to be used by this domain.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.realm-mapper", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services" }`

realms - The list of realms contained by this security domain.

Type	LIST
Is the attribute nillable?	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" : "LIST" }, "description" : "The list of realms contained by this security domain.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "realm" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A reference to an individual security realm.", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.security.security-realm", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "principal-transformer" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A principal transformer to be associated with the realm.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.principal-transformer", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "role-decoder" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A RoleDecoder reference to be associated with the realm.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.role-decoder", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "role-mapper" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A RoleMapper reference to be associated with the realm.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.role-mapper", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

role-decoder - Reference to the RoleDecoder to be used by this domain.

Type	STRING
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Reference to the RoleDecoder to be used by this domain.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.role-decoder", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services" }`

role-mapper - Reference to the RoleMapper to be used by this domain.

Type	STRING
Is the attribute nillable?	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" : "STRING" }, "description" : "Reference to the RoleMapper to be used by this domain.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.role-mapper", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services" }`

security-event-listener - Reference to a listener for security events.

Type	STRING
Is the attribute nillable?	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" : "STRING" }, "description" : "Reference to a listener for security events.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.security-event-listener", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services" }`

trusted-security-domains - The list of security domains that are trusted by this security domain.

Type	LIST
Is the attribute nillable?	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" : "LIST" }, "description" : "The list of security domains that are trusted by this security domain.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.security-domain", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services" }`

trusted-virtual-security-domains - The list of virtual security domains that are trusted by this security domain.

Type	LIST
Is the attribute nillable?	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" : "LIST" }, "description" : "The list of virtual security domains that are trusted by this security domain.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.virtual-security-domain", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services" }

Operations (3)

add - The add operation for a security domain definition.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
default-realm	STRING	false	false		The default realm contained by this security domain.
evidence-decoder	STRING	false	false		A reference to an EvidenceDecoder to be used by this domain.
outflow-anonymous	BOOLEAN	false	true	false	When outflowing to a security domain if outflow is not possible should the anonymous identity be used? Outflowing anonymous has the effect of clearing any identity already established for that domain.
outflow-security-domains	LIST	false	false		The list of security domains that the security identity from this domain should automatically outflow to.
permission-mapper	STRING	false	false		A reference to a PermissionMapper to be used by this domain.
post-realm-principal-transformer	STRING	false	false		A reference to a principal transformer to be applied after the realm has operated on the supplied identity name.
pre-realm-principal-transformer	STRING	false	false		A reference to a principal transformer to be applied before the realm is selected.
principal-decoder	STRING	false	false		A reference to a PrincipalDecoder to be used by this domain.
realm-mapper	STRING	false	false		Reference to the RealmMapper to be used by this domain.
realms	LIST	false	false		The list of realms contained by this security domain.
role-decoder	STRING	false	false		Reference to the RoleDecoder to be used by this domain.
role-mapper	STRING	false	false		Reference to the RoleMapper to be used by this domain.
security-event-listener	STRING	false	false		Reference to a listener for security events.
trusted-security-domains	LIST	false	false		The list of security domains that are trusted by this security domain.
trusted-virtual-security-domains	LIST	false	false		The list of virtual security domains that are trusted by this security domain.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "The add operation for a security domain definition.",
    "request-properties" : {
        "default-realm" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The default realm contained by this security domain.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "evidence-decoder" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "A reference to an EvidenceDecoder to be used by this domain.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.evidence-decoder",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "outflow-anonymous" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "When outflowing to a security domain if outflow is not possible should the anonymous identity be used?  Outflowing anonymous has the effect of clearing any identity already established for that domain.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "requires" : ["outflow-security-domains"],
            "stability" : "default"
        },
        "outflow-security-domains" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The list of security domains that the security identity from this domain should automatically outflow to.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.security-domain",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "permission-mapper" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "A reference to a PermissionMapper to be used by this domain.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.permission-mapper",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "post-realm-principal-transformer" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "A reference to a principal transformer to be applied after the realm has operated on the supplied identity name.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.principal-transformer",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "pre-realm-principal-transformer" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "A reference to a principal transformer to be applied before the realm is selected.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.principal-transformer",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "principal-decoder" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "A reference to a PrincipalDecoder to be used by this domain.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.principal-decoder",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "realm-mapper" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to the RealmMapper to be used by this domain.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.realm-mapper",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "realms" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The list of realms contained by this security domain.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "realm" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "A reference to an individual security realm.",
                    "expressions-allowed" : false,
                    "required" : true,
                    "nillable" : false,
                    "capability-reference" : "org.wildfly.security.security-realm",
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "principal-transformer" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "A principal transformer to be associated with the realm.",
                    "expressions-allowed" : false,
                    "required" : false,
                    "nillable" : true,
                    "capability-reference" : "org.wildfly.security.principal-transformer",
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "role-decoder" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "A RoleDecoder reference to be associated with the realm.",
                    "expressions-allowed" : false,
                    "required" : false,
                    "nillable" : true,
                    "capability-reference" : "org.wildfly.security.role-decoder",
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "role-mapper" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "A RoleMapper reference to be associated with the realm.",
                    "expressions-allowed" : false,
                    "required" : false,
                    "nillable" : true,
                    "capability-reference" : "org.wildfly.security.role-mapper",
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                }
            }
        },
        "role-decoder" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to the RoleDecoder to be used by this domain.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.role-decoder",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "role-mapper" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to the RoleMapper to be used by this domain.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.role-mapper",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "security-event-listener" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to a listener for security events.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.security-event-listener",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "trusted-security-domains" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The list of security domains that are trusted by this security domain.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.security-domain",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "trusted-virtual-security-domains" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The list of virtual security domains that are trusted by this security domain.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.virtual-security-domain",
            "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
}

read-identity - Reads an identity from a security domain if it exists.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
name	STRING	true	false		The name of the identity to read.

Raw DMR model


{
    "operation-name" : "read-identity",
    "description" : "Reads an identity from a security domain if it exists.",
    "request-properties" : {"name" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The name of the identity to read.",
        "expressions-allowed" : false,
        "required" : true,
        "nillable" : false,
        "min-length" : 1,
        "max-length" : 2147483647,
        "stability" : "default"
    }},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

remove - The remove operation for a security domain definition.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "The remove operation for a security domain definition.",
    "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.security-domain

        
<feature spec="subsystem.elytron.security-domain">
  <param name="security-domain" value="{resource name}"/>
  <param name="default-realm" value="{value}"/>
  <param name="evidence-decoder" value="{value}"/>
  <param name="outflow-anonymous" value="{value}"/>
  <param name="outflow-security-domains" value="{value}"/>
  <param name="permission-mapper" value="{value}"/>
  <param name="post-realm-principal-transformer" value="{value}"/>
  <param name="pre-realm-principal-transformer" value="{value}"/>
  <param name="principal-decoder" value="{value}"/>
  <param name="realm-mapper" value="{value}"/>
  <param name="realms" value="{value}"/>
  <param name="role-decoder" value="{value}"/>
  <param name="role-mapper" value="{value}"/>
  <param name="security-event-listener" value="{value}"/>
  <param name="trusted-security-domains" value="{value}"/>
  <param name="trusted-virtual-security-domains" value="{value}"/>
<feature/>