Management API Reference for source-address-role-decoder

Definition of a RoleDecoder that maps roles based on the IP address of a remote client.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.security.role-decoder	true	/subsystem=elytron/custom-role-decoder=* /subsystem=elytron/simple-role-decoder=* /subsystem=elytron/aggregate-role-decoder=*

Attributes (3)

pattern - A regular expression that specifies the IP address to match.

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" : "A regular expression that specifies the IP address to match.", "expressions-allowed" : true, "required" : true, "nillable" : true, "alternatives" : ["source-address"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

roles - The list of roles to assign if the IP address of the remote client matches.

Type	LIST
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" : "LIST" }, "description" : "The list of roles to assign if the IP address of the remote client matches.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

source-address - The IP address to match.

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" : "The IP address to match.", "expressions-allowed" : true, "required" : true, "nillable" : true, "alternatives" : ["pattern"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

Operations (2)

add - Add operation for the RoleDecoder

Request Parameter	Type	Required	Expressions Allowed	Description
pattern	STRING	true	true	A regular expression that specifies the IP address to match.
roles	LIST	true	true	The list of roles to assign if the IP address of the remote client matches.
source-address	STRING	true	true	The IP address to match.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add operation for the RoleDecoder",
    "request-properties" : {
        "pattern" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "A regular expression that specifies the IP address to match.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : true,
            "alternatives" : ["source-address"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "roles" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "The list of roles to assign if the IP address of the remote client matches.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "source-address" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The IP address to match.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : true,
            "alternatives" : ["pattern"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "restart-required" : "resource-services",
    "runtime-only" : false
}

remove - Remove operation for the RoleDecoder

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove operation for the RoleDecoder",
    "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.source-address-role-decoder

        
<feature spec="subsystem.elytron.source-address-role-decoder">
  <param name="source-address-role-decoder" value="{resource name}"/>
  <param name="pattern" value="{value}"/>
  <param name="roles" value="{value}"/>
  <param name="source-address" value="{value}"/>
<feature/>