Management API Reference for custom-role-mapper

Definition of a custom RoleMapper

Provided Capabilities (1)

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

Attributes (3)

class-name - Fully qualified class name of the RoleMapper

Type	STRING
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" : "Fully qualified class name of the RoleMapper", "attribute-group" : "class-loading", "expressions-allowed" : false, "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 }`

configuration - The optional key/value configuration for the RoleMapper

Type	OBJECT
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" : "OBJECT" }, "description" : "The optional key/value configuration for the RoleMapper", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

module - Name of the module to use to load the RoleMapper

Type	STRING
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" : "Name of the module to use to load the RoleMapper", "attribute-group" : "class-loading", "expressions-allowed" : false, "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 - Add operation for the RoleMapper

Request Parameter	Type	Required	Expressions Allowed	Description
configuration	OBJECT	false	true	The optional key/value configuration for the RoleMapper
class-name	STRING	true	false	Fully qualified class name of the RoleMapper
module	STRING	true	false	Name of the module to use to load the RoleMapper

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add operation for the RoleMapper",
    "request-properties" : {
        "configuration" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "The optional key/value configuration for the RoleMapper",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "class-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Fully qualified class name of the RoleMapper",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "module" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Name of the module to use to load the RoleMapper",
            "expressions-allowed" : false,
            "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 - Remove operation for the RoleMapper

Raw DMR model


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

        
<feature spec="subsystem.elytron.custom-role-mapper">
  <param name="custom-role-mapper" value="{resource name}"/>
  <param name="class-name" value="{value}"/>
  <param name="configuration" value="{value}"/>
  <param name="module" value="{value}"/>
<feature/>