Management API Reference for custom-principal-decoder

Definition of a custom principal decoder

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.security.principal-decoder	true	/subsystem=elytron/constant-principal-decoder=* /subsystem=elytron/x500-attribute-principal-decoder=* /subsystem=elytron/aggregate-principal-decoder=* /subsystem=elytron/concatenating-principal-decoder=*

Attributes (3)

class-name - Fully qualified class name of the principal decoder

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 principal decoder", "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 kay/value configuration for the principal decoder

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 kay/value configuration for the principal decoder", "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 principal decoder

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 principal decoder", "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 principal decoder

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

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add operation for the principal decoder",
    "request-properties" : {
        "configuration" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "The optional kay/value configuration for the principal decoder",
            "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 principal decoder",
            "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 principal decoder",
            "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 principal decoder

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove operation for the principal decoder",
    "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-principal-decoder

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