Management API Reference for regex-role-mapper

A RoleMapper definition for a RoleMapper that performs a mapping based on regex and replaces matching roles with replacement pattern.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.security.role-mapper	true	/subsystem=elytron/add-prefix-role-mapper=* /subsystem=elytron/custom-role-mapper=* /subsystem=elytron/add-suffix-role-mapper=* /subsystem=elytron/constant-role-mapper=* /subsystem=elytron/mapped-role-mapper=* /subsystem=elytron/aggregate-role-mapper=* /subsystem=elytron/logical-role-mapper=*

Attributes (4)

keep-non-mapped - When set to 'true' then the roles that did not match the pattern will be kept and not removed.

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" : "When set to 'true' then the roles that did not match the pattern will be kept and not removed.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

pattern - Regex string that will be used for matching. Regex can capture groups. Role matches the pattern if given pattern can be found in any substring of given role.

Type	STRING
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" : "Regex string that will be used for matching. Regex can capture groups. Role matches the pattern if given pattern can be found in any substring of given role.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

replace-all - When set to 'false', only first occurrence of the pattern will be replaced in role. When set to 'true' then all of the occurrences will be replaced by replacement.

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" : "When set to 'false', only first occurrence of the pattern will be replaced in role. When set to 'true' then all of the occurrences will be replaced by replacement.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

replacement - Replacement that will be used when mapping roles that contain the pattern. Can make use of captured groups from pattern.

Type	STRING
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" : "Replacement that will be used when mapping roles that contain the pattern. Can make use of captured groups from pattern.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

Operations (2)

add - The add operation for the role mapper.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
keep-non-mapped	BOOLEAN	false	true	false	When set to 'true' then the roles that did not match the pattern will be kept and not removed.
pattern	STRING	true	true		Regex string that will be used for matching. Regex can capture groups. Role matches the pattern if given pattern can be found in any substring of given role.
replace-all	BOOLEAN	false	true	false	When set to 'false', only first occurrence of the pattern will be replaced in role. When set to 'true' then all of the occurrences will be replaced by replacement.
replacement	STRING	true	true		Replacement that will be used when mapping roles that contain the pattern. Can make use of captured groups from pattern.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "The add operation for the role mapper.",
    "request-properties" : {
        "keep-non-mapped" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "When set to 'true' then the roles that did not match the pattern will be kept and not removed.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "pattern" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Regex string that will be used for matching. Regex can capture groups. Role matches the pattern if given pattern can be found in any substring of given role.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "replace-all" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "When set to 'false', only first occurrence of the pattern will be replaced in role. When set to 'true' then all of the occurrences will be replaced by replacement.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "replacement" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Replacement that will be used when mapping roles that contain the pattern. Can make use of captured groups from pattern.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "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 role mapper.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "The remove operation for the role mapper.",
    "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.regex-role-mapper

        
<feature spec="subsystem.elytron.regex-role-mapper">
  <param name="regex-role-mapper" value="{resource name}"/>
  <param name="keep-non-mapped" value="{value}"/>
  <param name="pattern" value="{value}"/>
  <param name="replace-all" value="{value}"/>
  <param name="replacement" value="{value}"/>
<feature/>