Management API Reference for mapped-role-mapper

A RoleMapper definition for a RoleMapper that performs a mapping based on configured map.

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/regex-role-mapper=* /subsystem=elytron/aggregate-role-mapper=* /subsystem=elytron/logical-role-mapper=*

Attributes (3)

keep-mapped - When set to 'true' the mapped roles will retain all roles, that have defined mappings.

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' the mapped roles will retain all roles, that have defined mappings.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

keep-non-mapped - When set to 'true' the mapped roles will retain all roles, that have no defined mappings.

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' the mapped roles will retain all roles, that have no defined mappings.", "expressions-allowed" : true, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

role-map - A list of mappings to use for mapping roles.

Type	LIST
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" : "A list of mappings to use for mapping roles.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "from" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The role to match for mapping roles.", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "to" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "A string list of roles to map to.", "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 }

Operations (2)

add - The add operation for the role mapper.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
keep-mapped	BOOLEAN	false	true	false	When set to 'true' the mapped roles will retain all roles, that have defined mappings.
keep-non-mapped	BOOLEAN	false	true	false	When set to 'true' the mapped roles will retain all roles, that have no defined mappings.
role-map	LIST	true	false		A list of mappings to use for mapping roles.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "The add operation for the role mapper.",
    "request-properties" : {
        "keep-mapped" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "When set to 'true' the mapped roles will retain all roles, that have defined mappings.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "keep-non-mapped" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "When set to 'true' the mapped roles will retain all roles, that have no defined mappings.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "role-map" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "LIST"
            },
            "description" : "A list of mappings to use for mapping roles.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default",
            "value-type" : {
                "from" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "STRING"
                    },
                    "description" : "The role to match for mapping roles.",
                    "expressions-allowed" : true,
                    "required" : true,
                    "nillable" : false,
                    "min-length" : 1,
                    "max-length" : 2147483647,
                    "stability" : "default"
                },
                "to" : {
                    "type" : {
                        "TYPE_MODEL_VALUE" : "LIST"
                    },
                    "description" : "A string list of roles to map to.",
                    "expressions-allowed" : true,
                    "required" : true,
                    "nillable" : false,
                    "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 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.mapped-role-mapper

        
<feature spec="subsystem.elytron.mapped-role-mapper">
  <param name="mapped-role-mapper" value="{resource name}"/>
  <param name="keep-mapped" value="{value}"/>
  <param name="keep-non-mapped" value="{value}"/>
  <param name="role-map" value="{value}"/>
<feature/>