Management API Reference for authentication=truststore

Provided Capabilities (1)

Attributes (4)

• keystore-password - The password for the truststore.

  Type	STRING
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	resource-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The password for the truststore.", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["keystore-password-credential-reference"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

• keystore-password-credential-reference - The reference to credential for the truststore password stored in CredentialStore under defined alias or clear text password.

  Type	OBJECT
  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" : "OBJECT" }, "description" : "The reference to credential for the truststore password stored in CredentialStore under defined alias or clear text password.", "expressions-allowed" : false, "required" : true, "nillable" : true, "alternatives" : ["keystore-password"], "stability" : "default", "access-constraints" : {"sensitive" : {"credential" : {"type" : "core"}}}, "value-type" : { "store" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the credential store holding the alias to credential.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.credential-store", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "alias" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The alias which denotes stored secret or credential in the store.", "expressions-allowed" : true, "required" : false, "nillable" : true, "requires" : ["store"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of credential this reference is denoting.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "clear-text" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Secret specified using clear text. Check credential store way of supplying credential/secrets to services.", "expressions-allowed" : true, "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 }

• keystore-path - The path of the truststore.

  Type	STRING
  Is the attribute nillable?	true
  Does the attribute allow expression?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	resource-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The path of the truststore.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

• keystore-relative-to - The name of another previously named path, or of one of the standard paths provided by the system. If 'keystore-relative-to' is provided, the value of the 'keystore-path' attribute is treated as relative to the path specified by this attribute.

  Type	STRING
  Is the attribute nillable?	true
  Where is the attribute stored?	configuration
  Access Type	read-write
  Is restarted required?	resource-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of another previously named path, or of one of the standard paths provided by the system. If 'keystore-relative-to' is provided, the value of the 'keystore-path' attribute is treated as relative to the path specified by this attribute.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "resource-services", "capability-reference" : null }

Operations (2)

• add - Adds the truststore configuration.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  keystore-password	STRING	false	true		The password for the truststore.
  keystore-password-credential-reference	OBJECT	true	false		The reference to credential for the truststore password stored in CredentialStore under defined alias or clear text password.
  keystore-path	STRING	false	true		The path of the truststore.
  keystore-relative-to	STRING	false	false		The name of another previously named path, or of one of the standard paths provided by the system. If 'keystore-relative-to' is provided, the value of the 'keystore-path' attribute is treated as relative to the path specified by this attribute.

  Raw DMR model

  { "operation-name" : "add", "description" : "Adds the truststore configuration.", "request-properties" : { "keystore-password" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The password for the truststore.", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["keystore-password-credential-reference"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "keystore-password-credential-reference" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The reference to credential for the truststore password stored in CredentialStore under defined alias or clear text password.", "expressions-allowed" : false, "required" : true, "nillable" : true, "alternatives" : ["keystore-password"], "stability" : "default", "value-type" : { "store" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the credential store holding the alias to credential.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.credential-store", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "alias" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The alias which denotes stored secret or credential in the store.", "expressions-allowed" : true, "required" : false, "nillable" : true, "requires" : ["store"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "type" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The type of credential this reference is denoting.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "clear-text" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Secret specified using clear text. Check credential store way of supplying credential/secrets to services.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } } }, "keystore-path" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The path of the truststore.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "keystore-relative-to" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of another previously named path, or of one of the standard paths provided by the system. If 'keystore-relative-to' is provided, the value of the 'keystore-path' attribute is treated as relative to the path specified by this attribute.", "expressions-allowed" : false, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : false }

• remove - Removes the truststore configuration.

  Raw DMR model

  { "operation-name" : "remove", "description" : "Removes the truststore configuration.", "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.

• core-service.management.access.audit.syslog-handler.protocol.tls.authentication.truststore

          
  <feature spec="core-service.management.access.audit.syslog-handler.protocol.tls.authentication.truststore">
    <param name="syslog-handler" value="{resource name}"/>
    <param name="keystore-password" value="{value}"/>
    <param name="keystore-password-credential-reference" value="{value}"/>
    <param name="keystore-path" value="{value}"/>
    <param name="keystore-relative-to" value="{value}"/>
  <feature/>
          
        

  📋