Management API Reference for expression=encryption

Provided Capabilities (1)

Attributes (3)

• default-resolver - The default expression resolver to use if not specified within the expression. If not set there is no default.

  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" : "The default expression resolver to use if not specified within the expression. If not set there is no default.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• prefix - The prefix in use for encrypted expressions.

  Type	STRING
  Default Value	ENC
  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" : "The prefix in use for encrypted expressions.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : "ENC", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

• resolvers - List of expressions resolver definitions.

  Type	LIST
  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" : "LIST" }, "description" : "List of expressions resolver definitions.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "value-type" : { "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the expression resolver definition.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "credential-store" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Reference to the credential store to be used by this resolver.", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.security.credential-store", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "secret-key" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The alias of the SecretKey within the credential store to use for encryption.", "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 }

Operations (3)

• add - Add operation for the expression resolver.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  default-resolver	STRING	false	false		The default expression resolver to use if not specified within the expression. If not set there is no default.
  prefix	STRING	false	false	ENC	The prefix in use for encrypted expressions.
  resolvers	LIST	true	false		List of expressions resolver definitions.

  Raw DMR model

  { "operation-name" : "add", "description" : "Add operation for the expression resolver.", "request-properties" : { "default-resolver" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The default expression resolver to use if not specified within the expression. If not set there is no default.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "prefix" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The prefix in use for encrypted expressions.", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : "ENC", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "resolvers" : { "type" : { "TYPE_MODEL_VALUE" : "LIST" }, "description" : "List of expressions resolver definitions.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "value-type" : { "name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the expression resolver definition.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "credential-store" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Reference to the credential store to be used by this resolver.", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.security.credential-store", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "secret-key" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The alias of the SecretKey within the credential store to use for encryption.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } } } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "restart-required" : "all-services", "runtime-only" : false }

• create-expression - Operation to encrypt the supplied clear text using the specified resolver and return a usable expression.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  resolver	STRING	false	false		The resolver configuration to use to encrypt the clear text. If omitted the default-resolver will be used instead.
  clear-text	STRING	true	false		The clear text value to encrypt.

  Raw DMR model

  { "operation-name" : "create-expression", "description" : "Operation to encrypt the supplied clear text using the specified resolver and return a usable expression.", "request-properties" : { "resolver" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The resolver configuration to use to encrypt the clear text. If omitted the default-resolver will be used instead.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "clear-text" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The clear text value to encrypt.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : true }

• remove - Remove operation for the expression resolver.

  Raw DMR model

  { "operation-name" : "remove", "description" : "Remove operation for the expression resolver.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "restart-required" : "all-services", "runtime-only" : false }

Galleon Features

Galleon features are to be used when creating Galleon feature-packs.

• subsystem.elytron.expression.encryption

          
  <feature spec="subsystem.elytron.expression.encryption">
    <param name="default-resolver" value="{value}"/>
    <param name="prefix" value="{value}"/>
    <param name="resolvers" value="{value}"/>
  <feature/>
          
        

  📋