Management API Reference for virtual-security-domain

A virtual security domain definition.

Provided Capabilities (1)

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

Attributes (3)

auth-method - The authentication mechanism that will be used with the virtual security domain. Allowed values: 'OIDC', 'MP-JWT'. The default value is 'OIDC'.

Type	STRING
Default Value	OIDC
Is the attribute nillable?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	no-services
Allowed Values	OIDC MP-JWT
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The authentication mechanism that will be used with the virtual security domain. Allowed values: 'OIDC', 'MP-JWT'. The default value is 'OIDC'.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : "OIDC", "allowed" : [ "OIDC", "MP-JWT" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }`

outflow-anonymous - When outflowing to a security domain, if outflow is not possible, should the anonymous identity be used? Outflow to a security domain might not be possible if the domain does not trust this domain or if the identity being outflowed to a domain does not exist in that domain. 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? Outflow to a security domain might not be possible if the domain does not trust this domain or if the identity being outflowed to a domain does not exist in that domain. 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 virtual 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 virtual 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" }

Operations (2)

add - The add operation for a virtual security domain definition.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
auth-method	STRING	false	false	OIDC	The authentication mechanism that will be used with the virtual security domain. Allowed values: 'OIDC', 'MP-JWT'. The default value is 'OIDC'.
outflow-anonymous	BOOLEAN	false	true	false	When outflowing to a security domain, if outflow is not possible, should the anonymous identity be used? Outflow to a security domain might not be possible if the domain does not trust this domain or if the identity being outflowed to a domain does not exist in that domain. 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 virtual domain should automatically outflow to.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "The add operation for a virtual security domain definition.",
    "request-properties" : {
        "auth-method" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The authentication mechanism that will be used with the virtual security domain. Allowed values: 'OIDC', 'MP-JWT'. The default value is 'OIDC'.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : "OIDC",
            "allowed" : [
                "OIDC",
                "MP-JWT"
            ],
            "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? Outflow to a security domain might not be possible if the domain does not trust this domain or if the identity being outflowed to a domain does not exist in that domain. 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 virtual 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"
            }
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

remove - The remove operation for a virtual security domain definition.

Raw DMR model


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

        
<feature spec="subsystem.elytron.virtual-security-domain">
  <param name="virtual-security-domain" value="{resource name}"/>
  <param name="auth-method" value="{value}"/>
  <param name="outflow-anonymous" value="{value}"/>
  <param name="outflow-security-domains" value="{value}"/>
<feature/>