Management API Reference for credential-store

Credential store to keep alias for sensitive information such as passwords for external services.

Provided Capabilities (1)

Name	Dynamic	Other provider points
org.wildfly.security.credential-store	true	/subsystem=elytron/secret-key-credential-store=*

Attributes (12)

create - Specifies whether credential store should create storage when it doesn't exist.

Type	BOOLEAN
Default Value	false
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" : "BOOLEAN" }, "description" : "Specifies whether credential store should create storage when it doesn't exist.", "attribute-group" : "implementation", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : false, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

credential-reference - Credential reference to be used to create protection parameter.

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" : "Credential reference to be used to create protection parameter.", "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" : "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 }

implementation-properties - Map of credentials store implementation specific properties.

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?	all-services
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "OBJECT" }, "description" : "Map of credentials store implementation specific properties.", "attribute-group" : "implementation", "expressions-allowed" : true, "required" : false, "nillable" : true, "stability" : "default", "value-type" : { "TYPE_MODEL_VALUE" : "STRING" }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

location - File name of credential store storage.

Deprecated Since 13.0.0

Use the 'path' attribute instead.

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" : "File name of credential store storage.", "attribute-group" : "implementation", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["path"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "deprecated" : { "since" : "13.0.0", "reason" : "Use the 'path' attribute instead." }, "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }

modifiable - Specifies whether credential store is modifiable.

Type	BOOLEAN
Default Value	true
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" : "BOOLEAN" }, "description" : "Specifies whether credential store is modifiable.", "attribute-group" : "implementation", "expressions-allowed" : false, "required" : false, "nillable" : true, "default" : true, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

other-providers - The name of the providers defined within the subsystem to obtain the Providers to search for the one that can create the required Jakarta Connectors objects within credential store. This is valid only for key-store based CredentialStore. If this is not specified then the global list of Providers is used instead.

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 name of the providers defined within the subsystem to obtain the Providers to search for the one that can create the required Jakarta Connectors objects within credential store. This is valid only for key-store based CredentialStore. If this is not specified then the global list of Providers is used instead.", "attribute-group" : "implementation", "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" }

path - File name of credential store storage.

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" : "File name of credential store storage.", "attribute-group" : "file", "expressions-allowed" : true, "required" : false, "nillable" : true, "alternatives" : ["location"], "min-length" : 1, "max-length" : 2147483647, "stability" : "default", "access-type" : "read-write", "storage" : "configuration", "restart-required" : "all-services", "capability-reference" : null }`

provider-name - The name of the provider to use to instantiate the CredentialStoreSpi. If the provider is not specified then the first provider found that can create an instance of the specified 'type' will be used.

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 instantiate the CredentialStoreSpi. If the provider is not specified then the first provider found that can create an instance of the specified 'type' will be used.", "attribute-group" : "implementation", "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 - The name of the providers defined within the subsystem to obtain the Providers to search for the one that can create the required CredentialStore type. If this is not specified then the global list of Providers is used instead.

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 name of the providers defined within the subsystem to obtain the Providers to search for the one that can create the required CredentialStore type. If this is not specified then the global list of Providers is used instead.", "attribute-group" : "implementation", "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" }

relative-to - A reference to a previously defined path that the file name is relative to.

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" : "A reference to a previously defined path that the file name is relative to.", "attribute-group" : "file", "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 }`

state - The state of the underlying service that represents this credential store at runtime.

Type	STRING
Where is the attribute stored?	runtime
Access Type	read-only
Allowed Values	DOWN STARTING START_FAILED UP STOPPING REMOVED
Stability Level	default
Raw DMR model	`{ "type" : { "TYPE_MODEL_VALUE" : "STRING" }, "description" : "The state of the underlying service that represents this credential store at runtime.", "expressions-allowed" : false, "required" : true, "nillable" : false, "min-length" : 1, "max-length" : 2147483647, "allowed" : [ "DOWN", "STARTING", "START_FAILED", "UP", "STOPPING", "REMOVED" ], "stability" : "default", "access-type" : "read-only", "storage" : "runtime", "restart-required" : null, "capability-reference" : null }`

type - The credential store type, e.g. KeyStoreCredentialStore.

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 credential store type, e.g. KeyStoreCredentialStore.", "attribute-group" : "implementation", "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 }`

Operations (10)

add - Add another credential store to the configuration.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
credential-reference	OBJECT	true	false		Credential reference to be used to create protection parameter.
path	STRING	false	true		File name of credential store storage.
relative-to	STRING	false	false		A reference to a previously defined path that the file name is relative to.
create	BOOLEAN	false	false	false	Specifies whether credential store should create storage when it doesn't exist.
implementation-properties	OBJECT	false	true		Map of credentials store implementation specific properties.
location	STRING	false	true		File name of credential store storage.
modifiable	BOOLEAN	false	false	true	Specifies whether credential store is modifiable.
other-providers	STRING	false	false		The name of the providers defined within the subsystem to obtain the Providers to search for the one that can create the required Jakarta Connectors objects within credential store. This is valid only for key-store based CredentialStore. If this is not specified then the global list of Providers is used instead.
provider-name	STRING	false	true		The name of the provider to use to instantiate the CredentialStoreSpi. If the provider is not specified then the first provider found that can create an instance of the specified 'type' will be used.
providers	STRING	false	false		The name of the providers defined within the subsystem to obtain the Providers to search for the one that can create the required CredentialStore type. If this is not specified then the global list of Providers is used instead.
type	STRING	false	true		The credential store type, e.g. KeyStoreCredentialStore.

Raw DMR model


{
    "operation-name" : "add",
    "description" : "Add another credential store to the configuration.",
    "request-properties" : {
        "credential-reference" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "Credential reference to be used to create protection parameter.",
            "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" : "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"
                }
            }
        },
        "path" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "File name of credential store storage.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["location"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "relative-to" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "A reference to a previously defined path that the file name is relative to.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "create" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Specifies whether credential store should create storage when it doesn't exist.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : false,
            "stability" : "default"
        },
        "implementation-properties" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "OBJECT"
            },
            "description" : "Map of credentials store implementation specific properties.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "stability" : "default",
            "value-type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            }
        },
        "location" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "File name of credential store storage.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "alternatives" : ["path"],
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default",
            "deprecated" : {
                "since" : "13.0.0",
                "reason" : "Use the 'path' attribute instead."
            }
        },
        "modifiable" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "BOOLEAN"
            },
            "description" : "Specifies whether credential store is modifiable.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : true,
            "stability" : "default"
        },
        "other-providers" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the providers defined within the subsystem to obtain the Providers to search for the one that can create the required Jakarta Connectors objects within credential store. This is valid only for key-store based CredentialStore. If this is not specified then the global list of Providers is used instead.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.providers",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "provider-name" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the provider to use to instantiate the CredentialStoreSpi. If the provider is not specified then the first provider found that can create an instance of the specified 'type' will be used.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "providers" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The name of the providers defined within the subsystem to obtain the Providers to search for the one that can create the required CredentialStore type. If this is not specified then the global list of Providers is used instead.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "capability-reference" : "org.wildfly.security.providers",
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "type" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The credential store type, e.g. KeyStoreCredentialStore.",
            "expressions-allowed" : true,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

add-alias - Add an alias to the credential store.

Request Parameter	Type	Required	Expressions Allowed	Description
alias	STRING	true	false	The alias of the credential store item to add.
entry-type	STRING	false	false	Type of a credential (entry) stored in the credential store.
secret-value	STRING	false	false	Secret value such as a password.

Raw DMR model


{
    "operation-name" : "add-alias",
    "description" : "Add an alias to the credential store.",
    "request-properties" : {
        "alias" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The alias of the credential store item to add.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "entry-type" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Type of a credential (entry) stored in the credential store.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "allowed" : ["org.wildfly.security.credential.PasswordCredential"],
            "stability" : "default"
        },
        "secret-value" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Secret value such as a password.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

export-secret-key - Export an existing SecretKey.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
alias	STRING	true	false		The alias of the SecretKey to export.

Raw DMR model


{
    "operation-name" : "export-secret-key",
    "description" : "Export an existing SecretKey.",
    "request-properties" : {"alias" : {
        "type" : {
            "TYPE_MODEL_VALUE" : "STRING"
        },
        "description" : "The alias of the SecretKey to export.",
        "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
}

generate-secret-key - Generate a new SecretKey and store it in the credential store.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
alias	STRING	true	false		The alias to use when storing the new SecretKey.
key-size	INT	false	false	256	The size of key to generate (bits).

Raw DMR model


{
    "operation-name" : "generate-secret-key",
    "description" : "Generate a new SecretKey and store it in the credential store.",
    "request-properties" : {
        "alias" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The alias to use when storing the new SecretKey.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "key-size" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "INT"
            },
            "description" : "The size of key to generate (bits).",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : 256,
            "allowed" : [
                128,
                192,
                256
            ],
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

import-secret-key - Import a previously exported SecretKey and add it to the credential store.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
alias	STRING	true	false		The alias to use when storing the imported SecretKey.
key	STRING	true	false		The previously exported key to import.

Raw DMR model


{
    "operation-name" : "import-secret-key",
    "description" : "Import a previously exported SecretKey and add it to the credential store.",
    "request-properties" : {
        "alias" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The alias to use when storing the imported SecretKey.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "key" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The previously exported key to import.",
            "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
}

read-aliases - Read aliases (entries) from a credential store.

Raw DMR model


{
    "operation-name" : "read-aliases",
    "description" : "Read aliases (entries) from a credential store.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : true,
    "runtime-only" : true
}

reload - Reload credential store (reinitialize and load new data if present).

Raw DMR model


{
    "operation-name" : "reload",
    "description" : "Reload credential store (reinitialize and load new data if present).",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

remove - Remove credential store from the configuration.

Raw DMR model


{
    "operation-name" : "remove",
    "description" : "Remove credential store from the configuration.",
    "request-properties" : {},
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : false
}

remove-alias - Remove a credential (entry) stored in the credential store.

Request Parameter	Type	Required	Expressions Allowed	Default value	Description
alias	STRING	true	false		The alias of the credential store item to remove.
entry-type	STRING	false	false	PasswordCredential	The type of the credential to remove.

Raw DMR model


{
    "operation-name" : "remove-alias",
    "description" : "Remove a credential (entry) stored in the credential store.",
    "request-properties" : {
        "alias" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The alias of the credential store item to remove.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "entry-type" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The type of the credential to remove.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "default" : "PasswordCredential",
            "min-length" : 1,
            "max-length" : 2147483647,
            "allowed" : [
                "org.wildfly.security.credential.PasswordCredential",
                "PasswordCredential",
                "org.wildfly.security.credential.SecretKeyCredential",
                "SecretKeyCredential"
            ],
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

set-secret - Set the secret value of a credential (entry) stored in the credential store.

Request Parameter	Type	Required	Expressions Allowed	Description
alias	STRING	true	false	The alias of the credential store item to set.
entry-type	STRING	false	false	Type of a credential (entry) stored in the credential store.
secret-value	STRING	false	false	Secret value such as a password.

Raw DMR model


{
    "operation-name" : "set-secret",
    "description" : "Set the secret value of a credential (entry) stored in the credential store.",
    "request-properties" : {
        "alias" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "The alias of the credential store item to set.",
            "expressions-allowed" : false,
            "required" : true,
            "nillable" : false,
            "min-length" : 1,
            "max-length" : 2147483647,
            "stability" : "default"
        },
        "entry-type" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Type of a credential (entry) stored in the credential store.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 1,
            "max-length" : 2147483647,
            "allowed" : ["org.wildfly.security.credential.PasswordCredential"],
            "stability" : "default"
        },
        "secret-value" : {
            "type" : {
                "TYPE_MODEL_VALUE" : "STRING"
            },
            "description" : "Secret value such as a password.",
            "expressions-allowed" : false,
            "required" : false,
            "nillable" : true,
            "min-length" : 0,
            "max-length" : 2147483647,
            "stability" : "default"
        }
    },
    "reply-properties" : {},
    "stability" : "default",
    "read-only" : false,
    "runtime-only" : true
}

Galleon Features

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

subsystem.elytron.credential-store

        
<feature spec="subsystem.elytron.credential-store">
  <param name="credential-store" value="{resource name}"/>
  <param name="create" value="{value}"/>
  <param name="credential-reference" value="{value}"/>
  <param name="implementation-properties" value="{value}"/>
  <param name="location" value="{value}"/>
  <param name="modifiable" value="{value}"/>
  <param name="other-providers" value="{value}"/>
  <param name="path" value="{value}"/>
  <param name="provider-name" value="{value}"/>
  <param name="providers" value="{value}"/>
  <param name="relative-to" value="{value}"/>
  <param name="type" value="{value}"/>
<feature/>