Management API Reference for key-manager

Provided Capabilities (1)

Attributes (7)

• algorithm - The name of the algorithm to use to create the underlying KeyManagerFactory.

  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?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the algorithm to use to create the underlying KeyManagerFactory.", "expressions-allowed" : true, "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 }

• alias-filter - A filter to apply to the aliases returned from the KeyStore, can either be a comma separated list of aliases to return or one of the following formats ALL:-alias1:-alias2, NONE:+alias1:+alias2

  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?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A filter to apply to the aliases returned from the KeyStore, can either be a comma separated list of aliases to return or one of the following formats ALL:-alias1:-alias2, NONE:+alias1:+alias2", "expressions-allowed" : true, "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 }

• credential-reference - The credential reference to decrypt KeyStore item. (Not a password of the KeyStore.)

  Type	OBJECT
  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 credential reference to decrypt KeyStore item. (Not a password of the KeyStore.)", "expressions-allowed" : false, "required" : true, "nillable" : false, "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" : "The 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" : "all-services", "capability-reference" : null }

• generate-self-signed-certificate-host - If the file that backs the KeyStore does not exist and this attribute is set, then a self-signed certificate will be generated for the specified host name. This is not intended for production use.

  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?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "If the file that backs the KeyStore does not exist and this attribute is set, then a self-signed certificate will be generated for the specified host name. This is not intended for production use.", "expressions-allowed" : true, "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 }

• key-store - Reference to the KeyStore to use to initialise the underlying KeyManagerFactory.

  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" : "Reference to the KeyStore to use to initialise the underlying KeyManagerFactory.", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.security.key-store", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

• provider-name - The name of the provider to use to create the underlying KeyManagerFactory.

  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?	all-services
  Stability Level	default
  Raw DMR model	{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the provider to use to create the underlying KeyManagerFactory.", "expressions-allowed" : true, "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 }

• providers - Reference to obtain the Provider[] to use when creating the underlying KeyManagerFactory.

  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" : "Reference to obtain the Provider[] to use when creating the underlying KeyManagerFactory.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.providers", "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services" }

Operations (3)

• add - Add the new key manager definition.

  Request Parameter	Type	Required	Expressions Allowed	Default value	Description
  algorithm	STRING	false	true		The name of the algorithm to use to create the underlying KeyManagerFactory.
  alias-filter	STRING	false	true		A filter to apply to the aliases returned from the KeyStore, can either be a comma separated list of aliases to return or one of the following formats ALL:-alias1:-alias2, NONE:+alias1:+alias2
  credential-reference	OBJECT	true	false		The credential reference to decrypt KeyStore item. (Not a password of the KeyStore.)
  generate-self-signed-certificate-host	STRING	false	true		If the file that backs the KeyStore does not exist and this attribute is set, then a self-signed certificate will be generated for the specified host name. This is not intended for production use.
  key-store	STRING	true	false		Reference to the KeyStore to use to initialise the underlying KeyManagerFactory.
  provider-name	STRING	false	true		The name of the provider to use to create the underlying KeyManagerFactory.
  providers	STRING	false	false		Reference to obtain the Provider[] to use when creating the underlying KeyManagerFactory.

  Raw DMR model

  { "operation-name" : "add", "description" : "Add the new key manager definition.", "request-properties" : { "algorithm" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the algorithm to use to create the underlying KeyManagerFactory.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "alias-filter" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "A filter to apply to the aliases returned from the KeyStore, can either be a comma separated list of aliases to return or one of the following formats ALL:-alias1:-alias2, NONE:+alias1:+alias2", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "credential-reference" : { "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "The credential reference to decrypt KeyStore item. (Not a password of the KeyStore.)", "expressions-allowed" : false, "required" : true, "nillable" : false, "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" : "The 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" } } }, "generate-self-signed-certificate-host" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "If the file that backs the KeyStore does not exist and this attribute is set, then a self-signed certificate will be generated for the specified host name. This is not intended for production use.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "key-store" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Reference to the KeyStore to use to initialise the underlying KeyManagerFactory.", "expressions-allowed" : false, "required" : true, "nillable" : false, "capability-reference" : "org.wildfly.security.key-store", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "provider-name" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The name of the provider to use to create the underlying KeyManagerFactory.", "expressions-allowed" : true, "required" : false, "nillable" : true, "min-length" : 1, "max-length" : 2147483647, "stability" : "default" }, "providers" : { "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "Reference to obtain the Provider[] to use when creating the underlying KeyManagerFactory.", "expressions-allowed" : false, "required" : false, "nillable" : true, "capability-reference" : "org.wildfly.security.providers", "min-length" : 1, "max-length" : 2147483647, "stability" : "default" } }, "reply-properties" : {}, "stability" : "default", "read-only" : false, "restart-required" : "resource-services", "runtime-only" : false }

• init - Reinitialize key manager.

  Raw DMR model

  { "operation-name" : "init", "description" : "Reinitialize key manager.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "runtime-only" : true }

• remove - Remove the key manager definition.

  Raw DMR model

  { "operation-name" : "remove", "description" : "Remove the key manager definition.", "request-properties" : {}, "reply-properties" : {}, "stability" : "default", "read-only" : false, "restart-required" : "resource-services", "runtime-only" : false }