Management API Reference for logical-role-mapper

A RoleMapper definition for a RoleMapper that performs a logical operation using two referenced RoleMappers.

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

Attributes (3)

left - Reference to a role mapper to be used on the left side of the operation.

Type	STRING
Is the attribute nillable?	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" : "Reference to a role mapper to be used on the left side of the operation.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.role-mapper", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

logical-operation - The logical operation to be performed on the role mapper mappings.

Type	STRING
Does the attribute allow expression?	true
Where is the attribute stored?	configuration
Access Type	read-write
Is restarted required?	all-services
Allowed Values	minus or and xor
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The logical operation to be performed on the role mapper mappings.", "expressions-allowed" : true, "required" : true, "nillable" : false, "allowed" : [ "and", "minus", "or", "xor" ], "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

right - Reference to a role mapper to be used on the right side of the operation.

Type	STRING
Is the attribute nillable?	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" : "Reference to a role mapper to be used on the right side of the operation.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.role-mapper", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }`

Operations (2)

add - The add operation for the role mapper.

Request Parameter	Type	Required	Expressions Allowed	Description
left	STRING	false	false	Reference to a role mapper to be used on the left side of the operation.
logical-operation	STRING	true	true	The logical operation to be performed on the role mapper mappings.
right	STRING	false	false	Reference to a role mapper to be used on the right side of the operation.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "The add operation for the role mapper.",
    "request-properties" : {
        "left" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to a role mapper to be used on the left side of the operation.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.role-mapper",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "logical-operation" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The logical operation to be performed on the role mapper mappings.",
            "expressions-allowed" : true,
            "required" : true,
            "nillable" : false,
            "allowed" : [
                "and",
                "minus",
                "or",
                "xor"
            ],
            "stability" : "default"
        },
        "right" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Reference to a role mapper to be used on the right side of the operation.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.role-mapper",
            "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.logical-role-mapper

        
<feature spec="subsystem.elytron.logical-role-mapper">
  <param name="logical-role-mapper" value="{resource name}"/>
  <param name="left" value="{value}"/>
  <param name="logical-operation" value="{value}"/>
  <param name="right" value="{value}"/>
<feature/>