Management API Reference for mapping-module

Attributes (4)

• code - Class name of the module to be instantiated.

  Type	STRING
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	no-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Class name of the module to be instantiated.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

• module - Name of JBoss Module where the mapping module code is located.

  Type	STRING
  Is the attribute nillable?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	no-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of JBoss Module where the mapping module code is located.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

• module-options - List of module options containing a name/value pair.

  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?	no-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "List of module options containing a name/value pair.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

• type - Type of mapping this module performs. Allowed values are principal, role, attribute or credential..

  Type	STRING
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	no-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Type of mapping this module performs. Allowed values are principal, role, attribute or credential..", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "no-services", "capability-reference" : null }

Operations (2)

• add - Adds a mapping configuration.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  code	STRING	true	false		Class name of the module to be instantiated.
  module	STRING	false	false		Name of JBoss Module where the mapping module code is located.
  module-options	OBJECT	false	true		List of module options containing a name/value pair.
  type	STRING	true	true		Type of mapping this module performs. Allowed values are principal, role, attribute or credential..

  Raw DMR model

  { "operation-name" : "add", "description" : "Adds a mapping configuration.", "request-properties" : { "code" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Class name of the module to be instantiated.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "module" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Name of JBoss Module where the mapping module code is located.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "module-options" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "List of module options containing a name/value pair.", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" } }, "type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Type of mapping this module performs. Allowed values are principal, role, attribute or credential..", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• remove - Removes a mapping configuration.

  Raw DMR model

  { "operation-name" : "remove", "description" : "Removes a mapping configuration.", "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.security.security-domain.mapping.classic.mapping-module

          
  <feature spec="subsystem.security.security-domain.mapping.classic.mapping-module">
    <param name="mapping-module" value="{resource name}"/>
    <param name="security-domain" value="{resource name}"/>
    <param name="code" value="{value}"/>
    <param name="module" value="{value}"/>
    <param name="module-options" value="{value}"/>
    <param name="type" value="{value}"/>
  <feature/>
          
        

  📋