Management API Reference for sasl-authentication-factory

Provided Capabilities (1)

Attributes (4)

• available-mechanisms - The SASL mechanisms available from this configuration after all filtering has been applied.

  Type	LIST
  Where is the attribute stored?	runtime
  Access Type	read-only
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "The SASL mechanisms available from this configuration after all filtering has been applied.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }

• mechanism-configurations - Mechanism specific configuration

  Type	LIST
  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" : "LIST" }, "description" : "Mechanism specific configuration", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "mechanism-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "This configuration will only apply where a mechanism with the name specified is used. If this attribute is omitted then this will match any mechanism name.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "host-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The host name this configuration applies to.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "protocol" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The protocol this configuration applies to.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "pre-realm-principal-transformer" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A principal transformer to apply before the realm is selected", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.principal-transformer", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "post-realm-principal-transformer" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A principal transformer to apply after the realm is selected", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.principal-transformer", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "final-principal-transformer" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A final principal transformer to apply for this mechanism realm", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.principal-transformer", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "realm-mapper" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The realm mapper to be used by the mechanism", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.realm-mapper", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "mechanism-realm-configurations" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "Definition of the realm names as understood by the mechanism", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "realm-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the realm to be presented by the mechanism", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "pre-realm-principal-transformer" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A principal transformer to apply before the realm is selected", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.principal-transformer", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "post-realm-principal-transformer" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A principal transformer to apply after the realm is selected", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.principal-transformer", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "final-principal-transformer" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A final principal transformer to apply for this mechanism realm", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.principal-transformer", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "realm-mapper" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The realm mapper to be used by the mechanism", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.realm-mapper", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } } }, "credential-security-factory" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The security factory to use to obtain a credential as required by the mechanism", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.security-factory.credential", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• sasl-server-factory - The SaslServerFactory to associate with this resource

  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" : "The SaslServerFactory to associate with this resource", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.security.sasl-server-factory", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

• security-domain - The SecurityDomain to associate with this resource

  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" : "The SecurityDomain to associate with this resource", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.security.security-domain", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

Operations (2)

• add - Add a new sasl-authentication-factory resource.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  mechanism-configurations	LIST	false	false		Mechanism specific configuration
  sasl-server-factory	STRING	true	false		The SaslServerFactory to associate with this resource
  security-domain	STRING	true	false		The SecurityDomain to associate with this resource

  Raw DMR model

  { "operation-name" : "add", "description" : "Add a new sasl-authentication-factory resource.", "request-properties" : { "mechanism-configurations" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "Mechanism specific configuration", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "mechanism-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "This configuration will only apply where a mechanism with the name specified is used. If this attribute is omitted then this will match any mechanism name.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "host-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The host name this configuration applies to.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "protocol" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The protocol this configuration applies to.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "pre-realm-principal-transformer" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A principal transformer to apply before the realm is selected", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.principal-transformer", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "post-realm-principal-transformer" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A principal transformer to apply after the realm is selected", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.principal-transformer", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "final-principal-transformer" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A final principal transformer to apply for this mechanism realm", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.principal-transformer", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "realm-mapper" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The realm mapper to be used by the mechanism", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.realm-mapper", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "mechanism-realm-configurations" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "Definition of the realm names as understood by the mechanism", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 0, "max-length" : 2147483647, "stability" : "default", "value-type" : { "realm-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the realm to be presented by the mechanism", "expressions-allowed" : true, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "pre-realm-principal-transformer" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A principal transformer to apply before the realm is selected", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.principal-transformer", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "post-realm-principal-transformer" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A principal transformer to apply after the realm is selected", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.principal-transformer", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "final-principal-transformer" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A final principal transformer to apply for this mechanism realm", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.principal-transformer", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "realm-mapper" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The realm mapper to be used by the mechanism", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.realm-mapper", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } } }, "credential-security-factory" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The security factory to use to obtain a credential as required by the mechanism", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.security-factory.credential", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } } }, "sasl-server-factory" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The SaslServerFactory to associate with this resource", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.security.sasl-server-factory", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "security-domain" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The SecurityDomain to associate with this resource", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.security.security-domain", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "restart-required" : "resource-services", "runtime-only" : false }

• remove - Remove the sasl-authentication-factory resource.

  Raw DMR model

  { "operation-name" : "remove", "description" : "Remove the sasl-authentication-factory resource.", "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.sasl-authentication-factory

          
  <feature spec="subsystem.elytron.sasl-authentication-factory">
    <param name="sasl-authentication-factory" value="{resource name}"/>
    <param name="mechanism-configurations" value="{value}"/>
    <param name="sasl-server-factory" value="{value}"/>
    <param name="security-domain" value="{value}"/>
  <feature/>
          
        

  📋